Page caching is an approach to caching where the entire action output of is stored as a HTML file that the web server can serve without going through Action Pack. This is the fastest way to cache your content as opposed to going dynamically through the process of generating the content. Unfortunately, this incredible speed-up is only available to stateless pages where all visitors are treated the same. Content management systems — including weblogs and wikis — have many pages that are a great fit for this approach, but account-based systems where people log in and manipulate their own data are often less likely candidates.
Specifying which actions to cache is done through the caches_page class method:
class WeblogController < ActionController::Base caches_page :show, :new end
This will generate cache files such as weblog/show/5.html and weblog/new.html, which match the URLs used to trigger the dynamic generation. This is how the web server is able pick up a cache file when it exists and otherwise let the request pass on to Action Pack to generate it.
Expiration of the cache is handled by deleting the cached file, which results in a lazy regeneration approach where the cache is not restored before another hit is made against it. The API for doing so mimics the options from url_for and friends:
class WeblogController < ActionController::Base def update List.update(params[:list][:id], params[:list]) expire_page :action => "show", :id => params[:list][:id] redirect_to :action => "show", :id => params[:list][:id] end end
Additionally, you can expire caches using Sweepers that act on changes in the model to determine when a cache is supposed to be expired.
Manually cache the content in the key determined by options. If no content is provided, the contents of response.body is used If no options are provided, the requested url is used. Example:
cache_page "I'm the cached content", :controller => "lists", :action => "show"
[ show source ]
# File actionpack/lib/action_controller/caching/pages.rb, line 131 131: def cache_page(content = nil, options = nil) 132: return unless perform_caching && caching_allowed 133: 134: path = case options 135: when Hash 136: url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :format => params[:format])) 137: when String 138: options 139: else 140: request.path 141: end 142: 143: self.class.cache_page(content || response.body, path) 144: end
Expires the page that was cached with the options as a key. Example:
expire_page :controller => "lists", :action => "show"
[ show source ]
# File actionpack/lib/action_controller/caching/pages.rb, line 112 112: def expire_page(options = {}) 113: return unless perform_caching 114: 115: if options.is_a?(Hash) 116: if options[:action].is_a?(Array) 117: options[:action].dup.each do |action| 118: self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :action => action))) 119: end 120: else 121: self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true))) 122: end 123: else 124: self.class.expire_page(options) 125: end 126: end