Rails源代码分析（23）：ActionController::Verification

1 使用

这个Module提供了一个类级别方法，验证某个方法就是指定的先决条件。

可以看作是一个特别的before_filter

1.        class GlobalController < ActionController::Base
2.     #     # Prevent the #update_settings action from being invoked unless
3.     #     # the 'admin_privileges' request parameter exists. The
4.     #     # settings action will be redirected to in current controller
5.     #     # if verification fails.
6.          verify :params => "admin_privileges", :only => :update_post,
7.                 :redirect_to => { :action => "settings" }
8.     #
9.     #     # Disallow a post from being updated if there was no information
10.     #     # submitted with the post, and if there is no active post in the
11.     #     # session, and if there is no "note" key in the flash. The route
12.     #     # named category_url will be redirected to if verification fails.
13.     #
14.          verify :params => "post", :session => "post", "flash" => "note",
15.                 :only => :update_post,
16.                 :add_flash => { "alert" => "Failed to create your message" },
17.                 :redirect_to => :category_url 

参数介绍：

1.       # Verify the given actions so that if certain prerequisites are not met,
2.       # the user is redirected to a different action. The +options+ parameter
3.       # is a hash consisting of the following key/value pairs:
4.       #
5.       # <tt>:params</tt>:: 
6.       #   a single key or an array of keys that must be in the <tt>params</tt> 
7.       #   hash in order for the action(s) to be safely called.
8.       # <tt>:session</tt>:: 
9.       #   a single key or an array of keys that must be in the <tt>session</tt> 
10.       #   in order for the action(s) to be safely called.
11.       # <tt>:flash</tt>:: 
12.       #   a single key or an array of keys that must be in the flash in order 
13.       #   for the action(s) to be safely called.
14.       # <tt>:method</tt>:: 
15.       #   a single key or an array of keys--any one of which must match the 
16.       #   current request method in order for the action(s) to be safely called. 
17.       #   (The key should be a symbol: <tt>:get</tt> or <tt>:post</tt>, for 
18.       #   example.)
19.       # <tt>:xhr</tt>:: 
20.       #   true/false option to ensure that the request is coming from an Ajax 
21.       #   call or not. 
22.       # <tt>:add_flash</tt>:: 
23.       #   a hash of name/value pairs that should be merged into the session's 
24.       #   flash if the prerequisites cannot be satisfied.
25.       # <tt>:add_headers</tt>:: 
26.       #   a hash of name/value pairs that should be merged into the response's 
27.       #   headers hash if the prerequisites cannot be satisfied.
28.       # <tt>:redirect_to</tt>:: 
29.       #   the redirection parameters to be used when redirecting if the 
30.       #   prerequisites cannot be satisfied. You can redirect either to named 
31.       #   route or to the action in some controller.
32.       # <tt>:render</tt>:: 
33.       #   the render parameters to be used when the prerequisites cannot be satisfied.
34.       # <tt>:only</tt>:: 
35.       #   only apply this verification to the actions specified in the associated 
36.       #   array (may also be a single value).
37.       # <tt>:except</tt>:: 
38.       #   do not apply this verification to the actions specified in the associated 
39.       #   array (may also be a single value).

2 实现

1.     module ClassMethods
2.       def verify(options={})
3.         # 增加了一个before_filter,这个方法其实就是before_filter的包装
4.         before_filter :only => options[:only], :except => options[:except] do |c|
5.           c.send! :verify_action, options
6.         end
7.       end
8.     end

1.   private
3.     def verify_action(options) #:nodoc:
4.       if prereqs_invalid?(options) # 验证如果不通过
5.         flash.update(options[:add_flash])              if options[:add_flash] # 填写flash
6.         response.headers.update(options[:add_headers]) if options[:add_headers] # 增加header
7.         apply_remaining_actions(options)               unless performed?
8.       end
9.     end
10.     
11.     def prereqs_invalid?(options) # 验证入口先决条件是否满足
12.       # 下列3个只要有一个不满足,就不满足
13.       verify_presence_of_keys_in_hash_flash_or_params(options) || 
14.       verify_method(options) || 
15.       verify_request_xhr_status(options)
16.     end
17.  
18.     def verify_presence_of_keys_in_hash_flash_or_params(options) # :nodoc:
19.       # 这里一个语法很特别 [*options[:params] ] 这里的*操作是将数组解成参数格式
20.       [*options[:params] ].find { |v| params[v].nil?  } ||
21.       [*options[:session]].find { |v| session[v].nil? } ||
22.       [*options[:flash]  ].find { |v| flash[v].nil?   }
23.     end
24.     
25.     def verify_method(options) # :nodoc:
26.       # 验证方法是不是一致的
27.       [*options[:method]].all? { |v| request.method != v.to_sym } if options[:method]
28.     end
29.     
30.     def verify_request_xhr_status(options) # :nodoc:
31.       # 验证是不是远程ajax调用
32.       request.xhr? != options[:xhr] unless options[:xhr].nil?
33.     end
34.     
35.     def apply_redirect_to(redirect_to_option) # :nodoc:
36.       # 如果是Symbol是方法名
37.       redirect_to_option.is_a?(Symbol) ? self.send!(redirect_to_option) : redirect_to_option
38.     end
39.     
40.     def apply_remaining_actions(options) # :nodoc:
41.       # 根据参数执行操作剩余操作
42.       case
43.         when options[:render]      ; render(options[:render])
44.         when options[:redirect_to] ; redirect_to(apply_redirect_to(options[:redirect_to]))
45.         else head(:bad_request)
46.       end
47.     end

这个验证比较简单,就有一个以前不太了解的*的用法.

1.乘法
2.数组 * INT

 

1. [1,2,3] *2 => [1,2,3],[1,2,3]

   
3.字符串* INT

 

1. "hello world!"*2 => "hello world!hello world!"  

   
4.相当于取数组的data[]值

1. *a = 1,2,3
2. a => [1,2,3]  

 

1. a= [1 , 2]  
2. testFun(*a) => testFun(1 , 2) 而不是 testFun([1,2])