1. ホーム
  2. スクリプト・コラム
  3. ルビートピックス

Ruby on Rails ラックミドルウェア基礎学習チュートリアル

2022-01-04 16:48:46

ラックは、ルビーサーバーとラックアプリケーションの間のフレームワークです。レール、シナトラはラック上に構築されており、すべてラックアプリケーションの一部です。

rack は、サーバーと対話するための標準的なインターフェイスを提供します。標準的なラックアプリケーションは、呼び出しに応答できるオブジェクトで、オブジェクト、proc、ラムダ、あるいはメソッドであっても、envパラメータ(環境オブジェクト)を受け取り、その配列を返します。

  • ステータス(status)、httpレスポンスステータスコード
  • httpヘッダー情報にはハッシュを使用できます。
  • each メソッドを持つオブジェクトで、それぞれが文字列を返します。

ラックはミドルウェアによって拡張される。つまり、元のラックのプログラムを装飾して、元の戻り配列をさらに処理し、ラックオブジェクトを返している

簡単なラックプログラム

require 'rack'

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



ミドルウェアを使用したラックプログラムです。
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メソッドを使うと、rakアプリケーションにルート
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はフルスタックであるため、ラックミドルウェアが多く、並列性が高いがシンプルな業務サイトやAPIで使用されることがある
応答時間が長すぎる場合、racksやsinatraの使用を検討することができます。

ラックスのプログラムを起動する方法は2つあります。

1. .rbファイルをrubyで直接実行すると、デフォルトで8080でサービスを開始し、ログファイルはありません。
2. rakup を使用します。これはデフォルトで 9292 でサービスを開始し、ログファイルを出力します。rakup は -o で ip を指定し、-p でポート番号を指定できます。

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


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


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], [Rack::ShowExceptions], [Rack::Lint], [Rack::TempfileReaper]
    ]

    m
   end



本文の長さのエラーヒントのアクセスログなどを含める。

rackには、ディレクトリファイルのWebサービスを生成するDirectory用のミドルウェアがあります。
使い方は一言で言うとシンプルです。

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


ホームディレクトリ内のすべてのファイルとフォルダをブラウザに表示します。

railsアプリでrake 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はracksで定義されたミドルウェアと、カスタムミドルウェアを使用しており、カスタムルートはracksのプログラムで、ルートはrailsコントローラのアクションをラムダに変換してrailsのプログラムとして、railsコンソールに入力して実行されます。

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) #: add the new middleware to the end of the list.
config.middleware.insert_before(existing_middleware,
 new_middleware, args)#: add the new middleware to the end of the list; config.middleware.


 その前に新しいミドルウェアを追加すること。

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


 その後に新しいミドルウェアを追加する。

config.middleware.swap ActionDispatch::ShowExceptions, Lifo::ShowExceptions #Replace middleware
config.middleware.delete "Rack::Lock"#delete middleware


ミドルウェアが行うこと

  • 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(リローダ)。開発環境におけるコードのリロードを支援するために、"prepare" と "cleanup" コールバックが提供されます。
  • ActionDispatch::コールバック。リクエストを処理する前に "Prepare"コールバックを呼び出します。
  • ActiveRecord::Migration::CheckPending: 保留中のマイグレーションがあるかどうかを確認し、ある場合はActiveRecord::PendingMigrationError例外を投げます。
  • ActiveRecord::ConnectionAdapters::ConnectionManagement。リクエストが開始された環境で rack.test が true に設定されていない限り、リクエスト処理の完了後にアクティブな接続をクリーンアップします。
  • ActiveRecord::QueryCache: Active Record のクエリキャッシュを有効にします。
  • ActionDispatch::Cookies。要求されたクッキーを設定します。
  • ActionDispatch::Session::CookieStore。セッションをクッキーに保存する役割を担います。
  • ActionDispatch::Flash: Flashメッセージのキーを設定します。config.action_controller.session_store オプションが設定されている場合のみ使用可能です。
  • ActionDispatch::ParamsParser: リクエストのパラメータを params に渡したり、 params から出したりします。
  • ActionDispatch::Head: HEAD リクエストを GET リクエストに変換し、処理します。
  • Rack::ConditionalGet。ページが変更されていない場合は応答しない "条件付き GET" のサポートを追加します。
  • Rack::ETag。すべての文字列型ボディにETagsヘッダを追加。ETags はキャッシュを検証するために使用されます。