Rails源代码分析（19）：ActionController::Caching(3) PageCache

1 介绍和应用

Page级别的cache，是用于cache整个action output保存为一个html，不需要经过action pack，

这是最快的缓存，不需要经过生成页面的过程，但是，这个只适用于所有用户察看的都是一样的页面，

这种缓存对CMS系统非常有效。

1.        class WeblogController < ActionController::Base
2.          caches_page :show, :new
3.        end

将会产生　weblog/show/5.html　或者　weblog/new.html　的缓存文件

可以采用以下方法使之过期：

1.        class WeblogController < ActionController::Base
2.          def update
3.            List.update(params[:list][:id], params[:list])
4.            expire_page :action => "show", :id => params[:list][:id]
5.            redirect_to :action => "show", :id => params[:list][:id]
6.          end
7.        end

另外可以采用Sweepers来清理

设置缓存目录：

Base.page_cache_directory = "/document/root"

默认设置是public目录（RAILS_ROOT + "/public"）

设置缓存的扩展名

Base.page_cache_extension

2　源代码分析

1.       def self.included(base) #:nodoc:
2.         base.extend(ClassMethods)
3.         base.class_eval do
4. 　　　　 #　缓存目录默认为public
5.           @@page_cache_directory = defined?(Rails.public_path) ? Rails.public_path : ""
6.           cattr_accessor :page_cache_directory
8.           # 页面扩展默认为html
9. 　　　　 @@page_cache_extension = '.html'
10.           cattr_accessor :page_cache_extension
11.         end
12.       end

模块的实现，类方法：

1.       module ClassMethods
2.         # Expires the page that was cached with the +path+ as a key. Example:
3.         #   expire_page "/lists/show"
4.         def expire_page(path)
5.           return unless perform_caching
7.           # 删除文件
8. 　　　　　benchmark "Expired page: #{page_cache_file(path)}" do
9.             File.delete(page_cache_path(path)) if File.exist?(page_cache_path(path))
10.           end
11.         end
13.         # Manually cache the +content+ in the key determined by +path+. Example:
14.         #   cache_page "I'm the cached content", "/lists/show"
15.         def cache_page(content, path)　#　nnd,取了这么一个名字跟caches_page很容易混起来，真受不了
16.           return unless perform_caching
18.           benchmark "Cached page: #{page_cache_file(path)}" do
19.           #创建目录写文件
20.             FileUtils.makedirs(File.dirname(page_cache_path(path)))
21.             File.open(page_cache_path(path), "wb+") { |f| f.write(content) }
22.           end
23.         end
25.         # Caches the +actions+ using the page-caching approach that'll store the cache in a path within the page_cache_directory that
26.         # matches the triggering url.
27.         #
28.         # Usage:
29.         #
30.         #   # cache the index action
31.         #   caches_page :index
32.         #
33.         #   # cache the index action except for JSON requests
34.         #   caches_page :index, :if => Proc.new { |c| !c.request.format.json? }
35.         def caches_page(*actions)
36.           return unless perform_caching
37.           options = actions.extract_options!
38. 　　　　　# 利用after filter来实现
39. 　　　　 # 这个after filter是前面提到的filter使用中的直接传proc的方式，而c就是controller
40.           after_filter({:only => actions}.merge(options)) { |c| c.cache_page }
41.         end
43.         private
44.           def page_cache_file(path)
45.             name = (path.empty? || path == "/") ? "/index" : URI.unescape(path.chomp('/')) #获取文件名
46.             name << page_cache_extension unless (name.split('/').last || name).include? '.' #获取名字
47.             return name
48.           end
50.           def page_cache_path(path) #获取cache的文件地址
51.             page_cache_directory + page_cache_file(path)
52.           end
53.       end

controller的实例方法：

1.       # Expires the page that was cached with the +options+ as a key. Example:
2.       #   expire_page :controller => "lists", :action => "show"
3.       def expire_page(options = {})
4.         return unless perform_caching
6.         if options.is_a?(Hash)
7. 　　　　　#　如果是一组方法，依次过期
8.           if options[:action].is_a?(Array)
9.             options[:action].dup.each do |action|
10.               self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :action => action)))
11.             end
12.           else
13. 　　　　　 #　如果是一个方法，过期
14.             self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true)))
15.           end
16.         else
17. 　　　　 #　如果options不是hash
18.           self.class.expire_page(options)
19.         end
20.       end
22.       # Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used
23.       # If no options are provided, the requested url is used. Example:
24.       #   cache_page "I'm the cached content", :controller => "lists", :action => "show"
25.       def cache_page(content = nil, options = nil)
26.         return unless perform_caching && caching_allowed
28.         #　根据options计算路径，默认为request.path
29. 　　　　path = case options
30.           when Hash
31.             url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :format => params[:format]))
32.           when String
33.             options
34.           else
35.             request.path
36.         end
38.         self.class.cache_page(content || response.body, path)
39.       end
41.       private
42.         def caching_allowed
43. 　　　　　# 如果是get方法，如果是OK状态
44.           request.get? && response.headers['Status'].to_i == 200
45.         end

这里就有疑问：

rails怎么确定cache在什么时候去读取呢？

rails接受到请求后会先去public下查找相应的资源，

如果有那么会直接返回，

如果没有才会进入action_pack。