Rails源代码分析（22）：ActionController::Caching(6) Sweeping

Sweeping 清理cache:

1.        class ListsController < ApplicationController
2.          caches_action :index, :show, :public, :feed
3.          cache_sweeper :list_sweeper, :only => [ :edit, :destroy, :share ]
4.        end

可以单独定义：

1. class ListSweeper < ActionController::Caching::Sweeper
2.          observe List, Item
3.          def after_lists_controller_update
4.            #clear cache
5.          end
6.     
7.          def after_save(record)
8.            list = record.is_a?(List) ? record : record.list
9.            expire_page(:controller => "lists", :action => %w( show public feed ), :id => list.id)
10.            expire_action(:controller => "lists", :action => "all")
11.            list.shares.each { |share| expire_page(:controller => "lists", :action => "show", :id => share.url_key) }
12.          end
13.        end

也可以定义在Module里：

1.        class ListsController < ApplicationController
2.          caches_action :index, :show, :public, :feed
3.          cache_sweeper OpenBar::Sweeper, :only => [ :edit, :destroy, :share ]
4.        end

实现：

1.     module Sweeping
2.       def self.included(base) #:nodoc:
3.         base.extend(ClassMethods)
4.       end
6.       module ClassMethods #:nodoc:
7.         def cache_sweeper(*sweepers)
8.           configuration = sweepers.extract_options!
10.           sweepers.each do |sweeper|
11.             ActiveRecord::Base.observers << sweeper if defined?(ActiveRecord) and defined?(ActiveRecord::Base) # 增加一个监听器
12.             sweeper_instance = (sweeper.is_a?(Symbol) ? Object.const_get(sweeper.to_s.classify) : sweeper).instance # 根据sweeper名字定义一个实例
14.             if sweeper_instance.is_a?(Sweeper) # 增加为filter
15.               around_filter(sweeper_instance, :only => configuration[:only])
16.             else
17.               after_filter(sweeper_instance, :only => configuration[:only])
18.             end
19.           end
20.         end
21.       end
22.     end

关键看Sweeper的实现:

1.     if defined?(ActiveRecord) and defined?(ActiveRecord::Observer)
2.       class Sweeper < ActiveRecord::Observer #:nodoc:
3.         attr_accessor :controller
5.         def before(controller)
6.           self.controller = controller
7.           callback(:before) if controller.perform_caching
8.         end
10.         def after(controller)
11.           callback(:after) if controller.perform_caching
12.           # Clean up, so that the controller can be collected after this request
13.           self.controller = nil
14.         end
16.         protected
17.           # gets the action cache path for the given options.
18.           def action_path_for(options)
19.             ActionController::Caching::Actions::ActionCachePath.path_for(controller, options)
20.           end
22.           # Retrieve instance variables set in the controller.
23.           def assigns(key)
24.             controller.instance_variable_get("@#{key}")
25.           end
27.         private
28.           def callback(timing)
29.             # 生成 controller 回调方法的名字,以及当前正在调用的 action 的名字
30.             controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
31.             action_callback_method_name     = "#{controller_callback_method_name}_#{controller.action_name}"
33.             # 如果有这些方法那么调用
34.             send!(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
35.             send!(action_callback_method_name)     if respond_to?(action_callback_method_name, true)
36.           end
38.           def method_missing(method, *arguments)
39.             return if @controller.nil?
40.             @controller.send!(method, *arguments)
41.           end
42.       end
43.     end