深入理解alias, alias_method和alias_method_chain

对于alias, alias_method, alias_method_chain的深入理解是有益的，因为rails3的源码里很多地方使用了alias_method_chain的魔法。 有人评论说alias_method_chain使用的过多不好，具体怎么不好，是后话了，这篇文章集中在理解这3个方法上面。


如果想转载本文，请注明出处，谢谢！请尊重别人的劳动成果，为构建丰富web原创内容做贡献！


1. alias
   Ruby里的关键字，用于定义方法或者全局变量的别名。 例子：

[ruby] view plaincopy

1.    class A  
2.      def m1  
3.        puts "m1"  
4.      end  
5.      alias m2 m1  
6.     end  
7. => nil  
8. a = A.new  
9. => #<A:0xb7ef5234>  
10.  a.m1  
11. m1  
12. => nil  
13. a.m2  
14. m1  
15. => nil  

在使用的时候，注意原有的方法名在最后位置，用空格分开。


2. alias_method
作用和alias差不多，是Module的一个私有实例方法，只能用于给方法起别名，并且参数只能是字符串或者符号（alias后面跟的直接是方法名，不是字符串也不是符号）。例子：

[ruby] view plaincopy

1. class B  
2.   def b  
3.     p "b"  
4.   end  
5.   alias_method :c, :b  
6. end  
7. => B  
8. b = B.new  
9. => #<B:0xb7ee75bc>  
10. b.c  
11. "b"  
12. => nil  
13. b.b  
14. "b"  
15. => nil  

注意，alias_method的参数必须是字符串或者是符号，并且用逗号分隔。


3. alias_method_chain
是ActiveSupport的一个公有实例方法。同样接受两个参数，可以是符号，也可以是字符串，但要注意一下第1个参数才是原始方法（alias_method的第2个参数是原始方法）。例子：

[ruby] view plaincopy

1. class A  
2.   def m1  
3.     puts 'm1'  
4.   end  
5.   def m1_with_m2  
6.     puts "do something befor m1"  
7.     m1_without_m2  
8.     puts "do something after m2"  
9.   end  
10.   alias_method_chain :m1, :m2  
11. end  
12. => A  
13. a = A.new  
14. => #<A:0xb7bd9820>  
15. a.m1  
16. do something befor m1  
17. m1  
18. do something after m2  
19. => nil  

上面的代码用alias或者alias_method也能完成：

[ruby] view plaincopy

1. class A    
2.   def m1    
3.     puts 'm1'    
4.   end  
5.   alias m1_without_m2 m1    
6.   def m1_with_m2    
7.     puts 'do something else'    
8.     m1_without_m2    
9.   end    
10.   alias m1 m1_with_m2    
11. end  

那么其原理也一目了然了：
a = A.new
a.m1
当调用m1的时候， m1_with_m2会执行，  在puts "do something befor m1"之后，执行m1_without_m2，这个时候是执行了真正的m1方法。 这样就形成了一个类似于AOP的行为。
也可以说，对外把m1方法隐藏起来了，对类外部，实际上把m1_with_m2改头换面已经成为了另一个方法，只是我们不知道而已，因为它还叫m1.


再来看看alias_method_chain的源码：

[ruby] view plaincopy

1. def alias_method_chain(target, feature)    
2.   # Strip out punctuation on predicates or bang methods since    
3.   # e.g. target?_without_feature is not a valid method name.    
4.   aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1    
5.   yield(aliased_target, punctuation) if block_given?         
6.   with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"    
7.   alias_method without_method, target    
8.   alias_method target, with_method          
9.   case    
10.     when public_method_defined?(without_method)    
11.       public target    
12.     when protected_method_defined?(without_method)    
13.       protected target    
14.     when private_method_defined?(without_method)    
15.       private target    
16.   end    
17. end   

一个道理。


更实际的例子：
在一些rails比较老的系统里，搜索功能的日期选择可能会用到date_select，这个方法会生成类似于这样的页面元素：
search_form[start_from(1i)]年
search_form[start_from(2i)]月
search_form[start_from(3i)]日
把这样的参数传回去，就无法查询到对应的日期。这个时候我们需要在后台得到查询条件之后来处理日期，比如：
get_conditions 这个方法假如是得到页面查询条件的，它返回一个数组，这个时候我们可以定义：

[ruby] view plaincopy

1. def get_conditions_with_handle_date  
2.   puts "你可以在get_conditions方法执行前干点别的，如果你愿意"  
3.   get_conditions_without_handle_date  
4.   puts "get_conditions执行完了，我们可以在其后干点别的,比如说处理日期"  
5.   conditions.reject!{|condition|condition[0] =~ /[1−3]i/}   # 把条件数组里的1i,2i,3i之类的去掉。  
6.   conditions << ["? <= #{@model.table_name}.created_at", @search.start_from] if @search.start_from  #给搜索对象里添加正确的查询日期条件  
7.   conditions << ["#{@model.table_name}.created_at < ?", @search.end_to + 1.day] if @search.end_to   #给搜索对象里添加正确的查询日期条件  
8. end  
9.   #然后实施魔法  
10.   alias_method_chain :get_conditions, :handle_date  

这样我们就搞定了。
本文出自 “{ :Alex Space => &..” 博客，请务必保留此出处http://blackanger.blog.51cto.com/140924/355102