一行代码搞定ActiveRecord的二级缓存

背景介绍：

JavaEye在今年1月份发布新版本以来，一直在使用cache_fu插件为整个网站提供缓存功能，在使用cache_fu时有遇到一些api调用不方便的问题：
1. 它没有对find(id)方法进行重写：

class User < ActiveRecord::Base
  acts_as_cached
end

#find没有使用cache机制
User.find(params[:id])
#必需使用get_cache方法，才能让cache生效
User.get_cache(params[:id])

2. 它没有提供belongs_to, has_one等关系上的缓存机制

class Topic < ActiveRecord::Base
  belongs_to :user
end

#不会使用cache机制
topic.user

3. 它没有针对ActiveRecord的update/destroy做callback，进行expire cache的工作

当然这些问题都可以通过自己写一点代码来改善，比如问题2：
cache_fu的关联补丁(belongs_to, has_one)


Rails.cache来了：

在Rails2.1以后，Rails提供了一个内置的缓存机制（Rails.cache），看了相关的文章介绍以后，我觉得完全可以利用它来取代cache_fu，自制一个简单的ActiveRecord二级缓存。

首先整理一下我们的需求，和Hibernate提供的二级缓存机制很类似：
1. 对于被标记为使用cache的Model，我们调用find(id)方法，将会先从cache中查找。
2. 对于belongs_to/has_one等关系的一方，如果该model被标记为使用cache，调用关系方法的时候也将会先从cache中查找。
3. update/destroy被缓存的模型能够自动清除缓存。

通过阅读ActiveRecord的源码，发现其实我们只需要在Base.find_one方法上做一些小动作就可以了：

def find_one_with_cache(id, options)
  Rails.cache.fetch(cache_key(id)) {find_one_without_cache(id, options)}
end

alias_method_chain :find_one, :cache

一行代码就搞定了1和2的需求，需求3也很简单，写2个after_update/after_destroy的事件就可以了，也是一行代码搞定
最终的代码见附件，我承认做了一回标题党，其实搞定这个自制插件最终用了大概50行左右的代码，但是每个核心方法还是只有1~2行  ，我想这得益于Ruby的语言特性和Rails的设计


如何使用：

只需要将文件解压到plugins目录下面，然后在environment.rb或者production.rb配置具体的cache机制即可：

config.cache_store = :mem_cache_store

然后在你需要做缓存的对象上加上一句acts_as_cached（这里为了从cache_fu方便迁移，我使用了同名）。

class User < ActiveRecord::Base
  acts_as_cached
end

然后观察log，就会出现类似这样的输出，说明缓存起作用了：
Cache miss: User/1 ({})
Cache hit: User/1 ({})
Cache hit: User/1 ({})


小技巧：

1. 定义缓存失效时间： acts_as_cached :expires_in => 6.hours
2. 在单元测试代码中禁用缓存，你可以在environment/test.rb里面设置一个无法访问的memcache地址，比如：
config.cache_store = :mem_cache_store, "disable.test.cache.localhost"
3. 类似hibernate的query cache：

class Forum < ActiveRecord::Base
  acts_as_cached
  def self.all_for_option
    get_cache("all_for_options") {find(:all, :order => 'category, position')}
  end  
end

不过这个简单插件没有提供hibernate那样完善的对query cache自动清理的功能，你可以试试看添加这个特性
4. memcached的undefined class/module错误，从cache_fu抄袭了一个autoload_missing_constants方法来解决这个问题：
http://www.philsergi.com/2007/06/rails-memcached-undefinded-classmodule.html


最后show一下JavaEye的memcache stats

cool

非常棒的经验分享！

Cool到掉渣~~~

很适合javaeye中90%的功能

請問一下，怎么才能看到MEMCACHE狀態？
就像你的附件那樣

帅呆了！！

楼住的那个图片上有个链接：http://pecl.php.net/package/memcache

--------
没用过php的人飘过....

相当实用,为何不放到rubyforge上面呢,可以更多人安装插件啊.

这个自制插件太简陋了，只适合于那种对于二级缓存要求简单的场景，不好意思放上去，呵呵

举个不合用的场景来说，比如这样的查询，就会出错：

#会将id为1，只有id和name属性的model缓存起来
User.find(1, :select => "id,name")
#将会读取之前被缓存的model
u = User.find(1)
#出错！因为从缓存中抓取的对象没有password这个属性
puts u.password

要简单地解决这个问题可以加2行代码，检查一下find_one后面的options是否为空

    def find_one_with_cache(id, options)
      #we only cache find(:id) method, any extra options results to skipping cache
      if options.blank? || options.values.compact.blank?
        autoload_missing_constants do
          Rails.cache.fetch(cache_key(id), SecondLevelCache.config[cache_name]) {find_one_without_cache(id, options)}
        end
      else
        find_one_without_cache(id, options)
      end
    end

这样第一个User.find(1, :select => "id,name")就会不使用缓存。
当然，如果你想更有效地利用cache，最好的解决方法应该是让第一个查询能够将完整的User对象放入cache，返回的时候只用select指定的栏位，另外还要考虑到include/conditions这类在find(id)中不常用的参数，要做一个通用的二级缓存要考虑到的问题还是蛮多的。