Rails源代码分析（14）：ActionController::MimeResponds

• 什么是MimeResponds
  

MimeResponds主要是为了支持Web Service请求：

比如 /people/list.html 返回一个html格式的响应

比如 /people/list.xml 返回xml格式的响应

Rails determines the desired response format from the HTTP Accept header submitted by the client.

1.          def index
2.            @people = Person.find(:all)
3.       
4.            respond_to do |format|
5.              format.html
6.              format.xml { render :xml => @people.to_xml }
7.            end
8.          end

也可以自己增加MINE Type

   Mime::Type.register "image/jpg", :jpg

这个方法我们后面再分析分析

• 实现
  

里面只有一个public方法 respond_to：

1.       def respond_to(*types, &block)
2.         raise ArgumentError, "respond_to takes either types or a block, never both" unless types.any? ^ block // 参数错误只允许传types或者block
3.          
4.         // 如果传入types那么构建block
5.         block ||= lambda { |responder| types.each { |type| responder.send(type) } }
6.         responder = Responder.new(self)
7.         //调用responder的type指名的方法 实际上先调用method_missing
8.         block.call(responder)
9.         responder.respond
10.       end

为了了解清楚实际的代码，先看看register方法：

mine_types.rb里面

1. Mime::Type.register "*/*", :all
2. Mime::Type.register "text/plain", :text, [], %w(txt)
3. Mime::Type.register "text/html", :html, %w( application/xhtml+xml ), %w( xhtml )
4. Mime::Type.register "text/javascript", :js, %w( application/javascript application/x-javascript )
5. Mime::Type.register "text/css", :css
6. Mime::Type.register "text/calendar", :ics
7. Mime::Type.register "text/csv", :csv
8. Mime::Type.register "application/xml", :xml, %w( text/xml application/x-xml )
9. Mime::Type.register "application/rss+xml", :rss
10. Mime::Type.register "application/atom+xml", :atom
11. Mime::Type.register "application/x-yaml", :yaml, %w( text/yaml )
13. Mime::Type.register "multipart/form-data", :multipart_form
14. Mime::Type.register "application/x-www-form-urlencoded", :url_encoded_form
16. # http://www.ietf.org/rfc/rfc4627.txt
17. Mime::Type.register "application/json", :json, %w( text/x-json )

mine_type.rb里面

Mime::Type.register 方法的实现：

1.       def register(string, symbol, mime_type_synonyms = [], extension_synonyms = [], skip_lookup = false)
2.         Mime.instance_eval { const_set symbol.to_s.upcase, Type.new(string, symbol, mime_type_synonyms) } 
3.         #动态的把symbol(:html :text :js等转化为常量)
4.         # HTML = Type.new("text/html", :html, %w( application/xhtml+xml ))
6.         SET << Mime.const_get(symbol.to_s.upcase)
7.         # 把这个常量放入SET中
9.         ([string] + mime_type_synonyms).each { |string| LOOKUP[string] = SET.last } unless skip_lookup 
10.         #所有mine_types都设置到lookup中
11.         ([symbol.to_s] + extension_synonyms).each { |ext| EXTENSION_LOOKUP[ext] = SET.last }
12.         # 所有扩展都设置到扩展中
13.       end

1.       def lookup(string)
2.         LOOKUP[string]
3.       end
5.       def lookup_by_extension(extension)
6.         EXTENSION_LOOKUP[extension]
7.       end

Mine::Type实体的对象方法:

1.     def initialize(string, symbol = nil, synonyms = [])
2.       @symbol, @synonyms = symbol, synonyms
3.       @string = string
4.     end
5.     
6.     def to_s
7.       @string
8.     end
9.     
10.     def to_str
11.       to_s
12.     end
13.     
14.     def to_sym
15.       @symbol || @string.to_sym
16.     end
18.     def ===(list)
19.       if list.is_a?(Array)
20.         (@synonyms + [ self ]).any? { |synonym| list.include?(synonym) }
21.       else
22.         super
23.       end
24.     end
25.     
26.     def ==(mime_type)
27.       return false if mime_type.blank?
28.       (@synonyms + [ self ]).any? do |synonym| 
29.         synonym.to_s == mime_type.to_s || synonym.to_sym == mime_type.to_sym 
30.       end
31.     end
33.     # Returns true if Action Pack should check requests using this Mime Type for possible request forgery.  See
34.     # ActionController::RequestForgerProtection.
35.     def verify_request?
36.       !@@unverifiable_types.include?(to_sym)
37.     end
39.     def html?
40.       @@html_types.include?(to_sym) || @string =~ /html/
41.     end
43.     private
44.       def method_missing(method, *args)
45.         if method.to_s =~ /(/w+)/?$/
46.           $1.downcase.to_sym == to_sym
47.         else
48.           super
49.         end
50.       end

实现

1.     class Responder #:nodoc:
2.       def initialize(controller)
3.         @controller = controller
4.         @request    = controller.request
5.         @response   = controller.response
7.         @mime_type_priority = Array(Mime::Type.lookup_by_extension(@request.parameters[:format]) || @request.accepts) // 根据@request的参数:format就是扩展来查询，如果没有就是在accepts方法里获取
9.         @order     = []
10.         @responses = {}
11.       end
13.       def custom(mime_type, &block)
14.         #如果是Mine::Type那么直接返回
15.         #如果不是，那么lookup table中去查找
16.         mime_type = mime_type.is_a?(Mime::Type) ? mime_type : Mime::Type.lookup(mime_type.to_s)
18.         @order << mime_type
20.         # 设置一个Proc等待调用
21.        @responses[mime_type] ||= Proc.new do
22.           @response.template.template_format = mime_type.to_sym #返回symbol作为格式
23.           @response.content_type = mime_type.to_s #返回to_s就是类似"text/html"这段
24.           block_given? ? block.call : @controller.send(:render, :action => @controller.action_name)
25.           #如果没有设置block直接调用render方法 
26.           # 例如 format.html
27.           #如果设置那么执行block
28.           # 例如:format.xml { render :xml => @people.to_xml }
29.         end
30.       end
32.       def any(*args, &block)
33.         if args.any?
34.           args.each { |type| send(type, &block) }
35.         else
36.           custom(@mime_type_priority.first, &block) //取优先级第一个的mine_type
37.         end
38.       end
40.       def method_missing(symbol, &block)
41.         mime_constant = symbol.to_s.upcase
43.         if Mime::SET.include?(Mime.const_get(mime_constant)) 
44.           #如果在SET中包含了这个常量就调用custom才处理这个常量
45.           custom(Mime.const_get(mime_constant), &block)
46.         else
47.           super
48.         end
49.       end
51.       def respond
52.         for priority in @mime_type_priority
53.           if priority == Mime::ALL
54.             @responses[@order.first].call
55.             return
56.           else
57.             if @responses[priority]
58.               @responses[priority].call
59.               return # mime type match found, be happy and return
60.             end
61.           end
62.         end
64.         if @order.include?(Mime::ALL)
65.           @responses[Mime::ALL].call
66.         else
67.           @controller.send :head, :not_acceptable
68.         end
69.       end
70.     end

其中Request的accepts方法如下:

1.     def accepts
2.       @accepts ||=
3.         if @env['HTTP_ACCEPT'].to_s.strip.empty?
4.           [ content_type, Mime::ALL ].compact # make sure content_type being nil is not included
5.         else
6.           Mime::Type.parse(@env['HTTP_ACCEPT'])
7.         end
8.     end