Lacquer 项目技术文档

1. 安装指南

环境要求

• Ruby 1.9 及以上版本
• Rails 框架

安装步骤

1. 安装 lacquer gem：

   gem install lacquer
   

2. 生成配置文件：

   rails generate lacquer:install
   

3. 配置初始化文件 config/initializers/lacquer.rb，根据项目需求进行配置。

4. 在 app/controllers/application_controller.rb 中引入 Lacquer::CacheUtils：

   class ApplicationController < ActionController::Base
     include Lacquer::CacheUtils
   end
   

5. 配置 config/varnishd.yml，根据不同环境设置 Varnish 的监听地址、存储路径等。

6. 配置 config/initializers/caches.rb，注册需要缓存的 URL 规则。

7. 配置 config/varnish.vcl.erb，定义 Varnish 的缓存策略。

2. 项目的使用说明

设置自定义 TTL

在控制器中使用 before_filter 设置自定义的缓存时间：

before_filter { |controller| controller.set_cache_ttl(15.minutes) }

清除缓存

在控制器中使用 after_filter 清除缓存：

class Posts < ApplicationController
  after_filter :clear_cache, :only => [ :create, :update, :destroy ]

private

  def clear_cache
    clear_cache_for(
      root_path,
      posts_path,
      post_path(@post))
  end
end

控制 Varnish

使用以下 Rake 任务控制 Varnish：

rake lacquer:varnishd:start
rake lacquer:varnishd:stop
rake lacquer:varnishd:restart
rake lacquer:varnishd:reload
rake lacquer:varnishd:status
rake lacquer:varnishd:global_purge

3. 项目 API 使用文档

配置 API

在 config/initializers/lacquer.rb 中配置全局缓存设置：

Lacquer.configure do |config|
  config.enable_cache = true
  config.default_ttl = 1.week
  config.job_backend = :none
  config.varnish_servers << { :host => "0.0.0.0", :port => 6082 }
  config.retries = 5
  config.purge_command = "ban.url"
  config.pass_command = "pass"
end

缓存控制 API

在 config/initializers/caches.rb 中注册缓存规则：

Lacquer.cache_control.configure do |config|
  config.register :static, :url => "^/images", :expires_in => "365d"
  config.register :static, :url => "^/stylesheets", :expires_in => "365d"
  config.register :static, :url => "^/javascripts", :expires_in => "365d"
end

清除缓存 API

在 Sweeper 中使用 Lacquer.cache_control.purge 清除缓存：

Lacquer.cache_control.purge(:open_scoring, class_section)

4. 项目安装方式

手动安装

1. 安装 lacquer gem：

   gem install lacquer
   

2. 生成配置文件：

   rails generate lacquer:install
   

3. 配置相关文件并启动 Varnish。

使用 Capistrano 部署

1. 在 Capfile 中引入 lacquer/capistrano：

   require 'lacquer/capistrano'
   

2. 使用 Capistrano 任务控制 Varnish：

   cap lacquer:global_purge
   cap lacquer:restart
   cap lacquer:start
   cap lacquer:status
   cap lacquer:stop
   

通过以上步骤，您可以顺利安装并使用 Lacquer 项目，实现对 Varnish 缓存的支持。