Ruby on Rails中Rack中间件的基础学习教程

    rack是ruby服务器和rack应用程序之间的一个框架,rails,sinatra都是基于rack构建的,都属于rack应用程序。

    rack提供了一个标准的接口,用于与服务器进行交互。标准的rack程序是一个可以响应call的对象,可以是对象、Proc、lambda甚至是method,它接收env参数(环境对象),返回一个数组,数组包括:

    • 状态(status),http响应状态码
    • 可以是hash,为http的header信息
    • 拥有each方法的对象,each返回字符串

    rack通过中间件来进行扩展,即对原始的rack程序进行装饰,在原有返回数组的基础上进一步处理,并返回rack对象

    简单的rack程序

    
    require 'rack'
    
    app = lambda{|env|[200,{},["hello from rack"]]}
    Rack::Handler::WEBrick.run app
    
    

    使用中间件的rack程序:
    require ‘rack’

    
    class Decorator
     def initialize(app)
      @app = app
     end
     def call(env)
      status, headers, body = @app.call(env)
      new_body = "from middleware input <br/>"
      body.each{|str| new_body << str}
      headers['Content-Length'] = new_body.bytesize.to_s
      [status, headers, [new_body]]
     end
    end
    
    app = lambda{|env|[200,{},["hello from rack"]]}
    Rack::Handler::WEBrick.run Decorator.new(app)
    
    

    上面使用中间件的方法在使用多个时容易混乱,rack有一个Builder类可以有效管理
    使用如下
    require ‘rack’

    
    require 'decorator'
    
    app = Rack::Builder.new{
     use Rack::ContentLength
     use Decorator
     run lambda {|env| [200, {"Content-Type"=>"text/html"}, ["hello world"]]}
    }.to_app
    Rack::Handler::WEBrick.run app
    
    

    使用Rack::Builder的map方法,可以创建有路由的rack程序
    require ‘rack’

    
    app = Rack::Builder.new {
     map '/hello' do
    run lambda {|env| [200, {"Content-Type" => "text/html"}, ["hello"]] } end
    map '/world' do
    run lambda {|env| [200, {"Content-Type" => "text/html"}, ["world"]] }
    end
    map '/' do
    run lambda {|env| [200, {"Content-Type" => "text/html"}, ["all"]] } end
    }.to_app
    Rack::Handler::WEBrick.run app, :Port => 3000
    

    由于rails的全栈性,rack中间件很多,在一些高并发但业务简单的网站或api使用时
    响应时间过长,在这种情况下可以考虑使用rack或者sinatra。

    启动一个rack程序有两种方式:

    1.直接使用ruby运行.rb文件,默认在8080启动服务,无日志文件
    2.使用rackup,默认在9292 启动服务,有日志文件,rackup可使用 -o 指定ip, -p 指定端口号

    
    require 'rack'
    app = lambda{|env| [200,{},["hello world"]] }
    Rack::Server.new.server.run app
    ruby xxx.rb
    

    https://www.lingkb.com/wp-content/uploads/2020/08/20200819101443-5f3cfb93a5f66.png (688×98)

    
    #test.ru
    run lambda{|env| [ 200,{},["rackup start"] ]}
    rackup test.ru
    

    https://www.lingkb.com/wp-content/uploads/2020/08/20200819101448-5f3cfb987ad59.png (1126×126)

    rack会在启动时默认加载一些中间件:

    
    def logging_middleware
        lambda { |server|
         server.server.name =~ /CGI/ || server.options[:quiet] ? nil : [Rack::CommonLogger, $stderr]
        }
       end
    
        m = Hash.new {|h,k| h[k] = []}
        m["deployment"] = [
         [Rack::ContentLength],
         [Rack::Chunked],
         logging_middleware,
         [Rack::TempfileReaper]
        ]
        m["development"] = [
         [Rack::ContentLength],
         [Rack::Chunked],
         logging_middleware,
         [Rack::ShowExceptions],
         [Rack::Lint],
         [Rack::TempfileReaper]
        ]
    
        m
       end
    
    

    包括body长度错误提示访问记录等。

    rack有一个Directory的中间件,可以为目录文件生成一个web服务。
    使用很简单一句话:

    
    #test.ru
    run Rack::Directory.new "~/"
    rackup test.ru
    

    这样就会把home目录下的所有文件、文件夹在浏览器中显示

    https://www.lingkb.com/wp-content/uploads/2020/08/20200819101452-5f3cfb9c9524c.png (1240×371)

    rails应用中使用rake middleware即可显示所有的middleware(中间件)

    
    ** **rake middleware
    use Rack::Sendfile
    use ActionDispatch::Static
    use Rack::Lock
    use #<ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x007feef1563b90>
    use Rack::Runtime
    use Rack::MethodOverride
    use ActionDispatch::RequestId
    use Rails::Rack::Logger
    use ActionDispatch::ShowExceptions
    use WebConsole::Middleware
    use ActionDispatch::DebugExceptions
    use ActionDispatch::RemoteIp
    use ActionDispatch::Reloader
    use ActionDispatch::Callbacks
    use ActiveRecord::Migration::CheckPending
    use ActiveRecord::ConnectionAdapters::ConnectionManagement
    use ActiveRecord::QueryCache
    use ActionDispatch::Cookies
    use ActionDispatch::Session::CookieStore
    use ActionDispatch::Flash
    use ActionDispatch::ParamsParser
    use Rack::Head
    use Rack::ConditionalGet
    use Rack::ETag
    run Fool::Application.routes
    

    rails使用了rack定义的一些中间件,自定义了一些中间件,其中自定义的routes为rack程序,routes 把rails controller的action变为lambda并作为rack程序运行,在rails console里输入

    
    2.2.1 :001 > QuestionsController.action(:new)
     => #<Proc:0x007fbe482ee0b0@/Users/killman/.rvm/gems/ruby-2.2.1/gems/actionpack-4.2.1/lib/action_controller/metal.rb:237 (lambda)>
    

    在config/application.rb可添加、删除、修改中间件

    
    config.middleware.use(new_middleware, args)#:把新中间件添加到列表末尾;
    config.middleware.insert_before(existing_middleware,
     new_middleware, args)#:在 existing_middleware
    

     之前添加新中间件;

    
    config.middleware.insert_after(existing_middleware,
     new_middleware, args)#:在 existing_middleware
    

     之后添加新中间件;

    
    config.middleware.swap ActionDispatch::ShowExceptions, Lifo::ShowExceptions #替换中间件
    config.middleware.delete "Rack::Lock"#删除中间件
    

    中间件的作用:

    • Rack::Sendfile :设置服务器上的 X-Sendfile 报头。通过 config.action_dispatch.x_sendfile_header选项设置。
    • ActionDispatch::Static :用来服务静态资源文件。如果选项 config.serve_static_assets为 false,则禁用这个中间件。
    • Rack::Lock :把 env[“rack.multithread”]旗标设为 false,程序放入互斥锁中。
    • ActiveSupport::Cache::Strategy::LocalCache::Middleware :在内存中保存缓存,非线程安全。
    • Rack::Runtime :设置 X-Runtime 报头,即执行请求的时长,单位为秒。
    • Rack::MethodOverride :如果指定了 params[:_method]参数,会覆盖所用的请求方法。这个中间件实现了 PUT 和 DELETE 方法。
    • ActionDispatch::RequestId :在响应中设置一个唯一的 X-Request-Id 报头,并启用 ActionDispatch::Request#uuid方法。
    • Rails::Rack::Logger :请求开始时提醒日志,请求完成后写入日志。
    • ActionDispatch::ShowExceptions :补救程序抛出的所有异常,调用处理异常的程序,使用特定的格式显示给用户。
    • ActionDispatch::DebugExceptions :如果在本地开发,把异常写入日志,并显示一个调试页面。
    • ActionDispatch::RemoteIp :检查欺骗攻击的 IP。
    • ActionDispatch::Reloader :提供“准备”和“清理”回调,协助开发环境中的代码重新加载功能。
    • ActionDispatch::Callbacks :在处理请求之前调用“准备”回调。
    • ActiveRecord::Migration::CheckPending :检查是否有待运行的迁移,如果有就抛出 ActiveRecord::PendingMigrationError异常。
    • ActiveRecord::ConnectionAdapters::ConnectionManagement :请求处理完成后,清理活跃的连接,除非在发起请求的环境中把 rack.test设为 true。
    • ActiveRecord::QueryCache :启用 Active Record 查询缓存。
    • ActionDispatch::Cookies :设置请求的 cookies。
    • ActionDispatch::Session::CookieStore :负责把会话存储在 cookies 中。
    • ActionDispatch::Flash :设置 Flash 消息的键。只有设定了 config.action_controller.session_store选项时才可用。
    • ActionDispatch::ParamsParser :把请求中的参数出入 params。
    • ActionDispatch::Head :把 HEAD 请求转换成 GET 请求,并处理。
    • Rack::ConditionalGet :添加对“条件 GET”的支持,如果页面未修改,就不响应。
    • Rack::ETag :为所有字符串类型的主体添加 ETags 报头。ETags 用来验证缓存。