Rails 中的 Rack 中间件

19 Oct 2010 / Edit / History

0. 背景知识

0.1 Rack 协议

Rack 起源于 Python 的 WSGI 协议, 是一个语言相关的 HTTP 服务端接口 (CGI, FCGI, SCGI 是语言无关的接口, WSGI, Rack, Servlet 则属于语言相关的接口), 该协议下一个简单的应用形式如下


# config.ru
class Helloworld
 def call(env)
   [200, {'Content-Type' => 'text/plain'}, ['hello world!']]
 end
end
run Helloworld.new

将该文件存为 config.ru, 然后在该目录下运行 rackup 即可启动该应用, 详细规范可以参考 http://rack.rubyforge.org/doc/files/SPEC.html

Rails 3.0, Sinatra 都使用了 Rack 作为自己的底层, 也就是说这两个 web 框架可以共用 Rack 中间件

0.2 Rack 中间件(middleware)接口

Rack 的协议本身很简单, 需要通过中间件来支持常见的 HTTP 功能，比如 cookie, session, flash, log, cache, ...

中间件本身也是一个 Rack 应用程序, 与简单 app 略有不同的是中间件通常以下一个 app 作为初始化参数

如下的代码就是 Rack::Runtime 中间件，用于记录应用程序的执行时间:


module Rack
  class Runtime
    def initialize(app)
      @app = app
      @header_name = "X-Runtime"
    end

    def call(env)
      start_time = Time.now
      status, headers, body = @app.call(env)
      request_time = Time.now - start_time
      if !headers.has_key?(@header_name)
        headers[@header_name] = "%0.6f" % request_time
      end
      [status, headers, body]
    end
  end
end

中间件的使用也很方便, 只需加一句 "use Rack::Runtime" 即可, 如下所示


# config.ru
class Helloworld
  def call(env)
    [200, {'Content-Type' => 'text/plain'}, ['hello world!']]
  end
end
use Rack::Runtime
run Helloworld.new

1. 如何在 Rails 程序中查看使用了哪些中间件


$ rake middleware
(in /path/to/project)
use ActionDispatch::Static
use Rack::Lock
use Rack::Runtime
use Rails::Rack::Logger
use ActionDispatch::ShowExceptions
use ActionDispatch::RemoteIp
use Rack::Sendfile
use ActionDispatch::Callbacks
use ActionDispatch::Cookies
use ActionDispatch::Session::CookieStore
use ActionDispatch::Flash
use ActionDispatch::ParamsParser
use Rack::MethodOverride
use ActionDispatch::Head
use ActionDispatch::BestStandardsSupport
use OpenIdAuthentication
run ProjectName::Application.routes

这些中间件大部分在 $GEM_PATH/railities-3.0.0/lib/rails/application.rb 的 default_middleware_stack 函数中定义。

2. 这些中间件有什么用

ActionDispatch::Static, 静态文件(即 public/ 下的文件)支持, 一般在生产环境下会禁用此功能
Rack::Lock, 线程锁, 保证 rails 代码单线程运行, 同时设置 env['rack.multithread'] = false, 你可以通过设置 config.allow_concurrency = true 来去掉该中间件

Rack::Runtime, 统计运行时间, 放在 response 的 "X-Runtime" header 中

Rails::Rack::Logger, 比如 log/development.log 中的这一行 "Started GET "/" for 127.0.0.1 at Wed Sep 15 21:46:51 +0800 2010"

ActionDispatch::ShowExceptions, 截获异常，把异常转换为 HTTP 错误号 (一般转为 500, 但一些特殊异常转到相应的错误号，比如 "ActionController::MethodNotAllowed" 会被转为 405, 同时显示对应的错误页面，对应开发环境，会显示异常的 backtrace, 对于生产环境，则会显示 public/500.html, 对于测试环境，该中间件会被禁用，直接把异常抛出

ActionDispatch::RemoteIp, 解决服务器转发, 代理导致客户端真实 IP 丢失的问题，用户的真实IP放在 env["action_dispatch.remote_ip"]

Rack::Sendfile, 如果返回数据已经放在一个文件里边了(比如生成的 PDF), 则可以让 nginx 服务器直接从该文件读取，降低系统消耗

ActionDispatch::Callbacks, 测试环境下用于检测源文件是否改变, 产品环境下作用不明 (TODO)
ActionDispatch::Cookies, cookie 支持
ActionDispatch::Session::CookieStore, session 支持，此处使用 cookie store
ActionDispatch::Flash, flash 支持，参见 http://guides.rubyonrails.org/action_controller_overview.html#the-flash
ActionDispatch::ParamsParser, 分析XML， JSON参数，放到 env["action_dispatch.request.request_parameters"]
Rack::MethodOverride, 支持用 POST 来模拟 PUT, DELETE, ..., 可以在 POST 使用 _method 参数，也可以使用 HTTP 头 "HTTP_X_HTTP_METHOD_OVERRIDE"
ActionDispatch::Head, 把 HEAD 请求转为 GET 请求, 同时设置 env["rack.methodoverride.original_method"] = "HEAD"
ActionDispatch::BestStandardsSupport, 设置 HTTP 头: X-UA-Compatible
ProjectName::Application.routes, 终于进入你的 rails 程序了, 开始路由, 同时开始使用 rails 的协议栈

3. 如何配置中间件

3.1 通过 config 来配置

可以参考 $GEM_PATH/railities-3.0.0/lib/rails/application.rb 的 default_middleware_stack 函数, 源码显示了如何使用 config 来控制中间件

3.2 直接修改中间件

你可通过 config.middleware (如果在配置外则需使用 Rails::Application.middleware) 来访问 middleware, 这是一个 ActionDispatch::MiddlewareStack 对象, 你可以通过他的方法来操纵 middleware, 比如你要删除 Rack::Runtime, 就可以新添 config/initializers/stack.rb 文件，内容如下
Rails::Application.middleware.delete Rack::Runtime

3.3 覆盖 default_middleware_stack 函数

修改 config/application.rb, 把 Application 类改为如下所示


module MyApp
  class Application < Rails::Application
    def default_middleware_stack
      ActionDispatch::MiddlewareStack.new.tap do |x|
        x.use Rack::Runtime
      end
    end
  end
end

再运行 rake middleware, 可以看到大部分 middleware 都不见了

3.4 通过 rails 的插件体系

比如 vendor/plugins/open_id_authentication/init.rb 中间就有一句:
config.middleware.use OpenIdAuthentication

这句话就把 OpenIdAuthentication 这个中间件放到了 MiddlewareStack 的栈顶

Tags: ruby, rack, rails, middleware

LI Daobing's blog