Railsの設定
このガイドでは、Railsアプリケーションの設定と利用可能な機能の初期化について説明します。 このガイドを読むことで、次の事が学べるはずです。
- Railsアプリケーションの動作を適合させる方法
- アプリケーション開始時に追加コードを実行する方法
- 1. 初期化コードの置き場所
- 2. Railsの前にコードを実行する
- 3. Railsコンポーネントの構築
- 4. Rails環境の設定
- 5. 初期化ファイルの使用
- 6. イベントの初期化
- 7. データベースのプーリング
1. 初期化コードの置き場所
Railsは初期化コードの配置をするにあたり、標準で4つの場所を提供します。
- config/application.rb
- 環境特有の設定ファイル
- Initializers
- Initializers後
2. Railsの前にコードを実行する
稀なケースですが、アプリケーションがRailsが読み込まれる前に幾つかのコードの実行が必要な場合、
config/application.rb
内のrequire 'rails/all'
呼び出しより上に、
そのコードを配置します。
3. Railsコンポーネントの構築
通常、Railsの設定動作は、Rails自身も含めたRailsのコンポーネントを設定することを意味します。
設定ファイルであるconfig/application.rb
と、
環境独自の設定ファイル(config/environments/production.rb
のような)は、
開発者が全てのコンポーネントに対して適用したい様々な設定を可能にしてくれます。
例えば、デフォルトのconfig/application.rb
ファイルは、下記の設定を含みます。
config.filter_parameters += [:password]
これは、Rails自身のための設定です。
もし、個別にRailsのコンポーネントに設定の指定を行いたい場合は、
config/application.rb
内の同じconfig
オブジェクトを通して、それを行うことが可能です。
config.active_record.schema_format = :ruby
Active Recordは、この特定の設定を使用するようになります。
3.1 Railsの一般的な設定
これらの設定メソッドは、Rails::Engine
またはRails::Application
のサブクラスなどの、
Rails::Railtie
オブジェクト上で呼び出されます。
-
config.after_initialize
はブロックを受け取り、 Railsがアプリケーションの初期化を終えた後にそれが実行されます。 これには、フレームワーク自身、エンジン、config/initializers
内の全てのアプリケーションの初期化処理が含まれます。 このブロックは、rakeタスクのために(?)実行される事に注意してください。(翻訳に自信なし) 他の初期化によって設定された値を使用する際に便利です。config.after_initialize do ActionView::Base.sanitized_allowed_tags.delete 'div' end
-
config.asset_host
は、assetsのためのホストを設定します。 CDNがassetsのホスティングとして使用される際に、 または異なるドメインエイリアスを使用したブラウザの同一ドメイン制約を避けたい際に便利です。config.action_controller.asset_host
のショートバージョンです。 -
config.autoload_once_paths
は、 Railsが自動読み込みし、各リクエストでは参照しない定数のパスの配列を受け取ります。 関連してdevelopmentモードの場合にはデフォルトで、config.cache_classes
はfalse
になります。(翻訳に自信なし) そうでなければ、全ての自動読み込みは1度だけ発生します。 また、この配列の全ての要素は、自動読み込みするパス(autoload_paths)でなければいけません。 デフォルトでは、空の配列になります。 -
config.autoload_paths
は、Railsが自動読み込みする定数から、パスの配列を受け取ります。 デフォルトは、app
配下の全てのディレクトリになります。 -
config.cache_classes
は、アプリケーションクラスとモジュールの各リクエスト毎の再読み込みを制御します。 デフォルトでは、developmentモードはfalse、testとproductionのモードではtrueになります。 また、threadsafe!
を使用する際にも、有効にすることが出来ます。 -
config.action_view.cache_template_loading
は、テンプレートの各リクエスト毎の再読み込みを制御します。 デフォルトでは、config.cache_classes
のものが設定されます。 -
config.cache_store
は、Railsのキャッシュ格納について設定を行います。 オプションには、:memory_store
、:file_store
、:mem_cache_store
、:null_store
、またはキャッシュAPIを実装したオブジェクトのシンボルのうち1つが含まれます。 デフォルトでは、tmp/cache
が存在すれば:file_storeになり、そうでなければ:memory_storeになります。 -
config.colorize_logging
は、ログ情報の出力時にANSIカラーコードを使用するか否かを指定します。 デフォルトはtrueです。 -
config.consider_all_requests_local
はフラグになります。 もし、trueであればエラーが発生した際に詳細なデバッグ情報をHTTPレスポンスに出力し、 Rails::Infoコントローラーは、/rails/info/properties
内にアプリケーションランタイムのコンテキストを表示します。 デフォルトでは、developmentとtestはtrue
で、productionではfalse
になります。 細かく制御するには、これをfalseに設定し、コントローラーにlocal_request?
を実装して、 リクエストが提供すべきエラーのデバッグ情報を指定します。 -
config.console
は、railsコンソール実行に使用するコンソールのクラス設定を可能にしてくれます。 コンソールブロックでそれを実行するのが良いでしょう。console do # このブロックはコンソール実行時にのみ呼びだされ、 # 安全にpryを読み込むことが出来ます。 require "pry" config.console = Pry end
-
config.dependency_loading
は、falseにすることで定数の自動読み込みを無効にすることが出来るフラグです。 これはconfig.cache_classes
がtrueの場合にのみ作用し、デフォルトでproductionモードがtrueになっています。 このフラグは、config.threadsafe!
でfalseに設定されています。 -
config.eager_load
がtrueの場合、登録された全てのconfig.eager_load_namespaces
をEager loadingします。 これは、作成したアプリケーション、エンジン、Railsフレームワーク、その他の登録された名前空間が含まれます。 -
config.eager_load_namespaces
はconfig.eager_load
がtrueの際に、 Eager Loadする名前空間を登録します。 登録された全ての名前空間は、eager_load!
メソッドに応答しなければいけません。 -
config.eager_load_paths
は、config.cache_classes
が有効の場合、 Railsから起動時にEager Loadしたパスの配列を受け取ります。 デフォルトは、アプリケーションのapp
ディレクトリ内の各フォルダになります。 -
config.encoding
はアプリケーション全体のエンコーディングの設定を行います。 デフォルトはUTF-8です。 -
config.exceptions_app
は、例外発生時にShowException
ミドルウェアによって実行される例外アプリケーションを設定します。(翻訳に自信なし) デフォルトは、ActionDispatch::PublicExceptions.new(Rails.public_path)
になります。 -
config.file_watcher
は、config.reload_classes_only_on_change
がtrueの際に、 ファイルシステム内のファイル更新を検知するのに使用されるクラスです。 これは、ActiveSupport::FileUpdateChecker
APIに従わなければいけません。 -
config.filter_parameters
は、パスワードやクレジットカード番号のような、 ログに表示させたくないパラメータをフィルタリングするのに使用されます。 -
config.force_ssl
は、ActionDispatch::SSL
ミドルウェアを使用することで、 全てのリクエストをHTTPSプロトコル下に強制します。 -
config.log_formatter
は、Railsのログのフォーマッターを定義します。 このオプションはデフォルトでは、productionを除く全てのモードがActiveSupport::Logger::SimpleFormatter
のインスタンスで、 productionはLogger::Formatter
になります。(翻訳に自信なし) -
config.log_level
は、Railsが出力するログの冗長性(ログレベル)を設定します。 デフォルトで、productionを除くモードでは:debug
、productionは:info
になります。 -
config.log_tags
は、request
オブジェクトに応答するメソッドのリストを受け取ります。 これにより、サブドメインとリクエストされたIDのようなデバッグ情報をログに簡単にタグ付けできるようになるため、 複数ユーザーによるproductionアプリケーションのデバッグで非常に有用です。(翻訳に自信なし) -
config.logger
は、Log4rのインターフェースに従うロガーまたはデフォルトのRubyのロガークラスを受け取ります。 デフォルトは、productionモードでauto flushingがオフのActiveSupport::Logger
のインスタンスになります。 -
config.middleware
は、アプリケーションのミドルウェアの設定を可能にしてくれます。 詳細は、この後のミドルウェアの設定のセクションを参照してください。 -
config.reload_classes_only_on_change
は、 追跡(tracked)ファイルが変更された際にのみ行うクラスのリロードの有効/無効を設定します。 デフォルトでは、自動読み込みするパスの全てを追跡し、trueに設定されています。config.cache_classes
がtrueの場合、このオプションは無視されます。 -
config.secret_key_base
は、セッションが改竄されるのを防ぐために、 アプリケーションの安全なキーであることを照合するのに使用されるキーの指定に使用されます。 アプリケーションはconfig/initializers/secret_token.rb
内で、 ランダムなキーで初期化されたconfig.secret_key_base
を取得します。 -
config.serve_static_assets
は、Rails自身が提供する静的なアセット(assets)の設定を行います。 デフォルトはtrueですが、サーバソフトウェア(例:NginxまたはApache)が代わりに静的なアセットを提供すべきものとして、 production環境ではfalseになっています。 Rails自身がそれを実行する際(絶対にお勧めできません!)や、WEBrickを使用してproductionモードでアプリケーションをテストする際に、 デフォルトとは異なるtrueを設定します。 そうでなければ、ページのキャッシュ、そして通常public
ディレクトリ下に存在し、 Railsアプリケーションとして出力されるファイルへのリクエストの処理をすることが出来なくなります。 -
config.session_store
は、通常config/initializers/session_store.rb
内で設定され、 セッションの格納に何のクラスを使用するかを指定します。 指定可能な値は、デフォルトの:cookie_store
と:mem_cache_store
と:disabled
です。 最後の:disabledは、Railsにセッションを扱わない事を伝えます。 また、カスタマイズしたセッション格納を指定することも可能です。config.session_store :my_custom_store
この場合、
ActionDispatch::Session::MyCustomStore
として、定義されていなければいけません。 -
config.time_zone
は、アプリケーションのデフォルトのタイムゾーンを設定し、 Active Recordのためのタイムゾーン認識を有効にします。 -
config.beginning_of_week
は、デフォルトのアプリケーションの週始まりの日を設定します。 これは、有効な曜日のシンボル(例::monday
)を受け取ります。 -
config.whiny_nils
は、一定のメソッドがnil上で実行され応答できない際の警告の有効/無効を設定します。 デフォルトでは、developmentとtestの環境でtrueです。
3.2 アセットの設定
-
config.assets.enabled
は、アセットパイプライン(asset pipeline)の有効/無効を制御するフラグです。 これは、config/application.rb
内で明確に初期化されます。 -
config.assets.compress
は、コンパイルするアセットの圧縮の有効/無効を制御するフラグです。config/production.rb
内(productionモード)で明示的にtrueに設定されています。 -
config.assets.css_compressor
は、使用するCSSコンプレッサー(圧縮器)を定義します。 デフォルトの設定は、sass-rails
が定義されています。 現在の唯一の代替値は:yui
で、これはyui-compressor
gemを使用します。 -
config.assets.js_compressor
は、使用するJavaScriptコンプレッサー(圧縮器)を定義します。 指定可能な値は、:closure
、:uglifier
、:yui
で、 それぞれclosure-compiler
、uglifier
、yui-compressor
のgemの使用が必要になります。 -
config.assets.paths
は、アセットを探すのに使用されるパスが含まれます。 この設定オプションにパスを追加すると、アセットを探すのにそれらのパスが使用されるようになります。 -
config.assets.precompile
は、rake assets:precompile
実行時に、 プリコンパイルされる追加アセット(application.css
とapplication.js
以外)の指定を可能にしてくれます。 -
config.assets.prefix
は、アセットが提供される場所のプレフィックスを定義します。 デフォルトは/assets
になります。 -
config.assets.digest
はアセット名に使用するMD5フィンガープリントを有効にします。production.rb
内でデフォルトでtrueに設定されています。 -
config.assets.debug
は、アセットの連結と圧縮を無効にします。development.rb
内でデフォルトでtrueに設定されています。 -
config.assets.cache_store
は、Sprocketsを使用するキャッシュストアを定義します。 デフォルトは、Railsファイル格納になります。 -
config.assets.version
は、MD5ハッシュ生成に使用される任意の文字列です。 これは再コンパイルすることで、全てのファイルに対して強制的に変更することが出来ます。 -
config.assets.compile
は、 production環境で「ライブSprocketsコンパイル」をオンにするのに使用する真偽値です。 -
config.assets.logger
は、Log4rの実装に従うロガー、またはデフォルトのRubyロガークラスを受け取ります。 デフォルトでは、config.logger
で設定されているものと同じになります。 config.assets.loggerをfalseに設定すると、アセットのログ提供がオフになります。
3.3 ジェネレーターの設定
Railsでは、config.generators
で使用するジェネレーターを差し替える事が出来ます。
このメソッドはブロックを受け取ります。
config.generators do |g|
g.orm :active_record
g.test_framework :test_unit
end
下記のメソッドを、このブロック内で使用することが可能です。
-
assets
はスキャフォールド生成時にアセットの生成を許可します。デフォルトはtrueです。 -
force_plural
は複数形のモデル名を許可します。デフォルトはfalseです。 -
integration_tool
は使用する統合ツールを定義します。デフォルトはnilです。 -
javascripts
は、ジェネレーター内でJavaScriptファイルのためのフックをオンにします。 Railsスキャフォールドのジェネレーター時に使用されます。デフォルトはtrueです。 -
javascript_engine
は、アセット生成時に使用されるエンジン(例:coffee)を設定します。デフォルトはnilです。 -
orm
は、orm使用を定義します。デフォルトはfalseで、デフォルトのActive Recordを使用します。 -
resource_controller
は、rails generate resource
コマンドを実行する際に、 コントローラー生成に使用されるジェネレーターを定義します。 デフォルトは、:controller
です。 -
scaffold_controller
は、resource_controllerと異なり、rails generate scaffold
コマンドを実行する際に、 スキャフォールドでのコントローラー生成時に使用されるジェネレーターを定義します。 デフォルトは:scaffold_controller
です。 -
stylesheets
は、ジェネレーターでのスタイルシートのフックをオンにします。 Railsでスキャフォールドの実行時に使用されますが、このフックは他のジェネレーターでも同様に使用されます。 デフォルトはtrueです。 -
stylesheet_engine
は、アセット生成時にスタイルシートのエンジン(例: sass)を設定します。 デフォルトは:css
です。 -
test_framework
は、使用するテストフレームワークを定義します。 デフォルトはfalseで、デフォルトのTest::Unit
を使用します。 -
template_engine
は、ERBやHamlのような使用するテンプレートエンジンを定義します。 デフォルトは、:erb
です。
3.4 ミドルウェアの設定
ミドルウェアの標準セット付きのRailsアプリケーションは、開発環境ではこの順序で使用されます。
-
ActionDispatch::SSL
は各リクエストをHTTPSプロトコル配下に強制します。config.force_ssl
がtrueに設定されると、利用可能になります。config.ssl_options
を使用して、これにオプションを渡すことで設定を行うことが可能です。 -
ActionDispatch::Static
は、静的なアセットの提供に使用されます。 無効にするには、config.serve_static_assets
をfalseにします。 -
Rack::Lock
は、Mutexのアプリケーションをラップするため、 同時に1つのスレッドからのみ呼び出されるようにすることが出来ます。config.cache_classes
がfalseの場合にのみ、有効になります。 -
ActiveSupport::Cache::Strategy::LocalCache
は、基本的なメモリのバックアップキャッシュとして提供されます。 このキャッシュはスレッドセーフでは無く、シングルスレッドのための一時的なメモリキャッシュとして機能するためのものです。 -
Rack::Runtime
は、X-Runtimeヘッダーを設定し、そのリクエストの処理に掛かった時間(秒)を含めるようにします。 -
Rails::Rack::Logger
は、リクエストの開始にログに通知します。 リクエストが完了すると、全てのログをクリアします。 -
ActionDispatch::ShowExceptions
は、 リクエストがローカル、またはconfig.consider_all_requests_local
がtrueに設定されていれば、 アプリケーションによる何らかの例外をrescueし、ユーザーに対して表示しても問題のない例外ページを描画します。 もし、config.action_dispatch.show_exceptions
がfalseに設定されていると、 それらとは関係無く例外が発生します。 -
ActionDispatch::RequestId
は、レスポンスで利用可能な一意のX-Request-Id
ヘッダーを作成し、ActionDispatch::Request#uuid
メソッドを有効にします。 -
ActionDispatch::RemoteIp
は、IPスプーフィング攻撃を調べるために、 リクエストヘッダーから有効なclient_ip
を取得します。config.action_dispatch.ip_spoofing_check
とconfig.action_dispatch.trusted_proxies
オプションで設定します。 -
Rack::Sendfile
はファイルから提供されるbodyを奪い、 サーバに指定されたX-Sendfileヘッダーを使用してそれを置換します。config.action_dispatch.x_sendfile_header
で設定します。 -
ActionDispatch::Callbacks
は、リクエストが提供される前に準備を行うコールバックを実行します。 -
ActiveRecord::ConnectionAdapters::ConnectionManagement
は、rack.test
キーがリクエストされた環境でtrueに設定されていなければ、 各リクエスト後にアクティブな接続をクリーンアップします。 -
ActiveRecord::QueryCache
は、リクエストによる全てのSELECTクエリーをキャッシュします。 もし、何らかのINSERTまたはUPDATEがそこに発生すれば、そのキャッシュをクリーンアップします。 -
ActionDispatch::Cookies
は、そのリクエストのためのCookieを設定します。 -
ActionDispatch::Session::CookieStore
は、Cookie内のセッションの格納を請け負います。 代替のミドルウェアは、config.action_controller.session_store
を代替値に変更することで、これを使用することが出来ます。 更にconfig.action_controller.session_options
を使用して、オプションを渡すことで設定することが可能です。 -
ActionDispatch::Flash
は、flash
キーを設定します。config.action_controller.session_store
に値が設定されている場合のみ、利用することが出来ます。 -
ActionDispatch::ParamsParser
はリクエストに含まれるパラメータを解析し、 それをparams
に入れます。 -
Rack::MethodOverride
は、params[:_method]
が設定されていた場合、 それを上書き可能にします。 これは、PATCH、PUT、DELETEのメソッドタイプをサポートするHTTPミドルウェアです。 -
ActionDispatch::Head
は、HEADリクエストをGETリクエストに変換し、 GETリクエストであるとして提供します。
これらの通常のミドルウェア以外にも、config.middleware.use
メソッドを使用して、
独自のものを追加することが出来ます。
config.middleware.use Magical::Unicorns
これにより、Magical::Unicorns
ミドルウェアがスタックの最後に配置されます。
他のミドルウェアの前に追加したければ、insert_before
を使用します。
config.middleware.insert_before ActionDispatch::Head, Magical::Unicorns
また、他のミドルウェアの後に追加をするinsert_after
も存在します。
config.middleware.insert_after ActionDispatch::Head, Magical::Unicorns
ミドルウェアはまた、完全にスワップアウトし、他のものに置き換えることも可能です。
config.middleware.swap ActionController::Failsafe, Lifo::Failsafe
また、スタックから完全に取り除くことも可能です。
config.middleware.delete "Rack::MethodOverride"
3.5 i18nの設定
-
config.i18n.default_locale
は、デフォルトでi18nのためにアプリケーションに使用されロケールを指定します。 デフォルトは、:en
です。 -
config.i18n.load_path
は、Railsがロケールファイルを探すためのパスを設定します。 デフォルトは、config/locales/*.{yml,rb}
です。
3.6 Active Recordの設定
config.active_record
には、様々な設定オプションが含まれています。
-
config.active_record.logger
は、何らかの新しいデータベース接続作成に渡されるLog4rのインターフェースに沿ったロガー、 またはデフォルトのRubyロガークラスを受け取ります。 開発者は、Active RecordモデルクラスまたはActive Recordインスタンスのいずれかで、このロガーを呼び出すことで取得する事が出来ます。nil
を設定すると、ログ出力は無効になります。 -
config.active_record.primary_key_prefix_type
は、主キーカラムの命名の調整を可能にしてくれます。 デフォルトでは、Railsは主キーのカラムをid
と命名しようとします。 (また、このオプションへの設定が必要無ければ) 他に2つの選択肢が存在します。:table_name
は、主キーをCustomerクラスであればcustomerid
にし、:table_name_with_underscore
は、主キーをCustomerクラスであればcustomer_id
にします。 -
config.active_record.table_name_prefix
は、テーブル名の前に付けられるグローバルな文字列の設定を可能にしてくれます。 もし、これにnorthwest_
を設定すると、Customerクラスは自身のテーブルとしてnorthwest_customers
を探します。 デフォルトは空文字列です。 -
config.active_record.table_name_suffix
は、テーブル名の後ろに付けられるグローバルな文字列の設定を可能にしてくれます。 もし、これに_northwest
を設定すると、Customerクラスは自身のテーブルとしてcustomers_northwest
を探します。 デフォルトは空文字列です。 -
config.active_record.pluralize_table_names
は、 Railsがデータベースの単数形または複数形のテーブル名のどちらを参照するかを指定します。 true(デフォルト)が設定されていれば、Customerクラスはcustomers
テーブルを使用します。 falseが設定されていれば、Customerクラスはcustomer
テーブルを使用します。 -
config.active_record.default_timezone
は、データベースから日付けと時間を取得する際に、Time.local
(:local
を設定)とTime.utc
(:utc
を設定)のどちらを使用するかを決定します。 Railsではデフォルトは:utc
ですが、Rails外で使用する場合、Active Recordのデフォルトは:local
です。 -
config.active_record.schema_format
は、データベースのスキーマがファイルにdumpされるフォーマットを制御します。 オプションには、マイグレーションに依存したデータベースとは独立した:ruby
(デフォルト)、 またはSQL文のセット(潜在的にデータベース依存)である:sql
があります。 -
config.active_record.timestamped_migrations
はマイグレーションに、 シリアル数値またはタイムスタンプでのナンバー付けのどちらにするかを制御します。 デフォルトはtrueでタイムスタンプを使用します。 複数の開発者が同じアプリケーションを開発をする場合は、こちらの方が良いでしょう。 -
config.active_record.lock_optimistically
は、Active Recordが楽観的ロックを使用するかを制御し、 デフォルトはtrueです。 -
config.active_record.cache_timestamp_format
は、キャッシュキー内のタイムスタンプ値のフォーマットを制御します。 デフォルトは、:number
です。
MySQLアダプタの場合、設定の追加オプションが1つあります。
-
ActiveRecord::ConnectionAdapters::MysqlAdapter.emulate_booleans
は、 Active RecordがMySQLデータベースの全てのtinyint(1)
のカラムを真偽値とみなすか否かを制御します。 デフォルトはtrueです。
スキーマのdumpは、設定オプションを1つ追加します。
-
ActiveRecord::SchemaDumper.ignore_tables
は、 スキーマファイルの生成に含めるべきではないテーブルの配列を受け取ります。 この設定は、config.active_record.schema_format == :ruby
で無ければ、無視されます。
3.7 Action Controllerの設定
config.action_controller
は、幾つかの設定が含まれます。
-
config.action_controller.asset_host
はアセット用のホストを設定します。 アプリケーションサーバ自身では無くアセット用のホストとしてCDNを使用する場合に便利です。 -
config.action_controller.perform_caching
は、アプリケーションがキャッシュを行うか否かを設定します。 developmentモードではfalse、productionではtrueが設定されます。 -
config.action_controller.default_static_extension
は、キャッシュページで使用される拡張子を設定します。 デフォルトは.html
です。 -
config.action_controller.default_charset
は、全ての描画でのデフォルトの文字コード設定を指定します。 デフォルトは、"utf-8"
です。 -
config.action_controller.logger
は、Log4rのインターフェースに沿ったロガー、 またはデフォルトのRubyロガークラスを受け入れ、Actionコントローラーからのログ情報に使用します。 nilを設定すると、ログ出力が無効になります。 -
config.action_controller.request_forgery_protection_token
は、 リクエストフォージェリのためのトークンパラメータ名を設定します。protect_from_forgery
の呼び出しは、 デフォルトで:authenticity_token
を設定します。 -
config.action_controller.allow_forgery_protection
はCSRFに対する防御の有効・無効を設定します。 デフォルトではテストモードではfalseで、それ以外のモードではtrueです。 -
config.action_controller.relative_url_root
は、Railsにデプロイするサブディレクトリを伝えるのに使用されます。 デフォルトは、ENV['RAILS_RELATIVE_URL_ROOT']
です。 -
config.action_controller.permit_all_parameters
は、 全てのパラメータのmass assignmentがデフォルトのままで許可されるかを設定します。 デフォルト値はfalseです。 -
config.action_controller.action_on_unpermitted_parameters
は、 もし明示的に許可されていないパラメータが見つかった場合のログ出力または例外発生を有効にします。:log
または:raise
を設定すると、有効になります。 development、test環境のデフォルト値は:log
で、 その他の環境ではfalseです。 -
config.action_dispatch.session_store
は、セッションデータのストア名を設定します。 デフォルトは:cookie_store
で、その他の有効なオプションには:active_record_store
、:mem_cache_store
、またはオリジナルのカスタムクラスの名前になります。 -
config.action_dispatch.default_headers
は、 デフォルトで各レスポンスの値が設定されたHTTPヘッダーのハッシュです。 デフォルトでは下記のように定義されます。config.action_dispatch.default_headers = { 'X-Frame-Options' => 'SAMEORIGIN', 'X-XSS-Protection' => '1; mode=block', 'X-Content-Type-Options' => 'nosniff' }
-
config.action_dispatch.tld_length
は、アプリケーションのためのTLD(トップレベルドメイン)の長さ(数)を設定します。 デフォルトは1です。 -
ActionDispatch::Callbacks.before
は、リクエストの前に実行するコードのブロックを取得します。 -
ActionDispatch::Callbacks.to_prepare
は、ActionDispatch::Callbacks.beforeの後、 ただしリクエストの前に実行するブロックを取得します。 development環境では各リクエストで実行されますが、cache_classes
がtrueに設定されているproduction環境などでは、1度だけです。 -
ActionDispatch::Callbacks.after
は、リクエストの後に実行するコードのブロックを取得します。
3.8 Action Dispatchの設定
3.9 Action Viewの設定
config.action_view includes a small number of configuration settings:
-
config.action_view.field_error_proc
は、 Active Recordからのエラーを表示するためのHTMLジェネレーターを提供します。 デフォルトは下記の通りです。Proc.new do |html_tag, instance| %Q(<div class="field_with_errors">#{html_tag}</div>).html_safe end
-
config.action_view.default_form_builder
は、デフォルトで使用するフォームのビルダーをRailsに伝えます。 デフォルトはActionView::Helpers::FormBuilder
です。 もし、自分のフォームのビルダークラスを初期化(development環境では各リクエストで再読み込みされます)の後に読み込ませたい場合、 文字列(String
)としてそれを渡すことが可能です。 -
config.action_view.logger
は、Action Viewからのログ情報出力に使用される、 Log4rのインターフェースに従ったロガー、またはデフォルトのRubyロガークラスを受け取ります。 nilを設定すると、ログ出力は無効になります。 -
config.action_view.erb_trim_mode
は、 ERBによって使用されるトリム(trim)モードを提供します。 デフォルトは、'-'
です。 詳細は、ERBドキュメントの情報を参照してください。 -
config.action_view.embed_authenticity_token_in_remote_forms
は、:remote => true
であるフォーム内のauthenticity_token
のためのデフォルトの挙動を設定します。 デフォルトではfalseに設定されており、これはremoteフォームがauthenticity_token
を含まない事を意味し、 フォームのfragment-caching(断片キャッシュ)をする際に便利です。 remoteフォームはメタタグから信頼(authenticity)情報を取得するため、 JavaScriptがオフのブラウザをサポートしない限り、この埋め込みは不要です。 そのようなケースでは、フォームのオプションとして:authenticity_token => true
を渡すか、 この設定をtrueにすることで対応可能です。 -
config.action_view.prefix_partial_path_with_controller_namespace
は、 名前空間名が付けられたコントローラーのpartialをの描画テンプレートを、サブディレクトリから探すか否かを決定します。 例えば、コントローラー名がAdmin::PostsControllerで、下記のテンプレートを描画することを考えてみます。<%= render @post %>
デフォルトで設定されているtrueであれば、
/admin/posts/_post.erb
のpartialを使用します。 値をfalseに設定すると、PostsControllerのような名前空間が無い場合と同じように、/posts/_post.erb
を描画します。
3.10 Action Mailerの設定
config.action_mailer
には、下記の設定項目が利用可能です。
3.11 Active Supportの設定
3.12 データベースの設定
ほぼ全てのRailsアプリケーションは、データベースと連携します。
データベースを使用するには、config/database.yml
と呼ばれる設定ファイルを指定します。
新しいRailsアプリケーション上でこのファイルをが開くと、デフォルトでSQLite3を使用する設定がされている事が分かります。
このファイルは、Railsがデフォルトで実行できる3つの異なる環境のためのセクションを含みます。
-
development
環境は、開発者がアプリケーションを直接手を加える開発/ローカル環境のコンピュータで使用されます。 -
test
環境は、自動テストを実行する際に使用されます。 -
production
環境は、あなたのアプリケーションを世界に向けて公開するために、デプロイする際に使用されます。
あなたは手動でデータベースの設定を更新する必要はありません。
もし、アプリケーションジェネレーターのオプションを見れば、
オプションの1つに--database
という名前のものがある事に気づくでしょう。
このオプションで、最も使用されるデータベースのリストから、アダプターを選択することが可能です。
ジェネレータを繰り返し実行することが出来ます。(cd .. && rails new blog --database=mysql
)
config/database.yml
の上書きを確認すると、
アプリケーションはSQliteの代わりに、MySQLを設定します。
一般的なデータベースの接続例を、この後詳しく紹介していきます。
3.12.1 SQLite3の設定
Railsは軽量なサーバ不要のデータベースアプリケーションであるSQLite3を組み込みでサポートしています。 SQLiteは負荷の多いproduction環境では荷が重く適さないため、 developmentとtest環境で使用するのが良いでしょう。 新しいプロジェクトを作成すると、RailsはデフォルトでSQliteデータベースを使用しますが、 これはその後いつでも変更することが可能です。
下記は、デフォルトの設定ファイル(config/database.yml
)のdevelopment環境の接続情報のセクションです。
development:
adapter: sqlite3
database: db/development.sqlite3
pool: 5
timeout: 5000
Railsは、データベースの設定を何も行わなくても動作する事から、 デフォルトのデータストレージにSQLite3データベースを使用します。 Railsはまた、"すぐに使える"MySQLとPostgreSQLもサポートし、多くのデータベースシステムのためのプラグインが用意されています。 もし、production環境でデータベースを使用する場合は、Railsにはそれらのアダプタが設定されるでしょう。
3.12.2 MySQLの設定
もし、デフォルトのSQLite3の代わりに、MySQLを選択する場合、
config/database.yml
を少し変更する必要があります。
下記はdevelopmentセクションの例になります。
development:
adapter: mysql2
encoding: utf8
database: blog_development
pool: 5
username: root
password:
socket: /tmp/mysql.sock
もし、開発マシンにrootユーザーと空パスワードで、MySQLがインストールされていれば、 この設定で動作するはずです。 そうでなければ、developmentセクションのusernameとpasswordを適切なものに変更してください。
3.12.3 PostgreSQLの設定
もし、PostgreSQLを選択するのであれば、config/database.yml
をPostgreSQLを使用するように変更します。
development:
adapter: postgresql
encoding: unicode
database: blog_development
pool: 5
username: blog
password:
PREPARE文は、このようにして無効にすることが出来ます。
production:
adapter: postgresql
prepared_statements: false
3.12.4 JRubyプラットフォームのためのSQLite3の設定
もし、SQLite3とJRubyを使用するのであれば、
config/database.yml
を少し変更する必要があります。
下記はdevelopmentセクションになります。
development:
adapter: jdbcsqlite3
database: db/development.sqlite3
3.12.5 JRubyプラットフォームでのMySQLの設定
もし、MySQLとJRubyを使用するのであれば、
config/database.yml
は少し変更する必要があります。
下記はdevelopmentセクションになります。
development:
adapter: jdbcmysql
database: blog_development
username: root
password:
3.12.6 JRubyプラットフォームでのPostgreSQLの設定
もし、PostgreSQLとJRubyを使用するのであれば、
config/database.yml
は少し変更する必要があります。
下記はdevelopmentセクションになります。
development:
adapter: jdbcpostgresql
encoding: unicode
database: blog_development
username: blog
password:
development
セクション内のusernameとpasswordは、適切なものに変更してください。
3.13 Rails環境の設定
デフォルトで、Railsには3つの"development"、"test"、"production"の環境が備わっています。 ほとんど場合これで十分ですが、やむを得ず環境がもっと必要になるようなケースも存在するかもしれません。
production環境をミラーリングしますが、テストでしか使用されないサーバをあなたが持っていると仮定してください。
そのようなサーバは一般的に"ステージングサーバ"と呼ばれます。
"ステージング"と呼ばれる環境をこのサーバのために定義するには、
config/environments/staging.rb
と呼ばれるファイルを作成します。
config/environments
内に存在するファイルを使用して、スタート時に必要な変更を指定してみてください。
作成したステージングの環境はデフォルトで用意されているものと同じく、
rails server -e staging
でサーバを起動し、
rails console staging
、Rails.env.staging?などが動作します。
4. Rails環境の設定
Railsの一部は、環境値が与えられることによって設定することも可能です。 下記の環境値は、Railsの様々な部分で見分けられます。
5. 初期化ファイルの使用
フレームワークが読み込まれ、gemがアプリケーションに取り込まれると、
次にRailsは初期化を行います。
イニシャライザー(initializer)は、アプリケーション内のconfig/initializers
下に格納されたRubyファイルです。
イニシャライザーを使用して、全てのフレームワークとgemが読み込まれた後に、
オプションの設定のような、行うべき設定を保持させることが出来ます。
Railsはイニシャライザーのフォルダの階層を下って探してくれるため、 必要であれば、イニシャライザーにサブディレクトリを使用することが出来ます。
もし、イニシャライザーで依存関係の都合で読み込み順を指定する必要がある場合、
ファイルの名前付けによって読み込み順を制御することが可能です。
イニシャライザーのファイルは、それらのパスのアルファベット順で読み込まれます。
例えば、01_critical.rb
は、02_normal.rb
の前に読み込まれます。
6. イベントの初期化
Railsは、フックする事が出来る5つの初期化イベントを持ちます。 (リストされている順に実行されます)
これらのフックするイベントを定義するには、
Rails::Application
、Rails::Railtie
、Rails::Engine
サブクラスのいずれかの中で、
ブロック文法を使用します。
module YourApp
class Application < Rails::Application
config.before_initialize do
# 初期化コードをここに書きます。
end
end
end
代わりに、Rails.applicationオブジェクト上のconfig
メソッドを使用してそれを行うことも可能です。
Rails.application.config.before_initialize do
# ここに初期化コードを書きます。
end
ルーティング(経路)を明確にするアプリケーションの一部は、
after_initialize
ブロックが呼ばれるこの時点ではまだ設定されません。
6.1 Rails::Railtie#initializer
Railsは開始時に実行される幾つかのイニシャライザーを持ち、
それは全てRails::Railtie
のinitializer
を使用して定義されています。
下記は、Active Supportでのinitialize_whiny_nils
イニシャライザーの例です。
initializer "active_support.initialize_whiny_nils" do |app|
require 'active_support/whiny_nil' if app.config.whiny_nils
end
initializer
メソッドは、1つ目がイニシャライザーの名前、
2つ目がオプションのハッシュ、3つ目がブロックの3つの引数を受け取ります。
オプション内の:before
キーは、このイニシャライザーの前に実行する必要のあるイニシャライザーを指定することができ、
:afeter
はその後に実行する必要のあるイニシャライザーを指定することが可能です。
initializer
メソッドを使用して定義されたイニシャライザーは、
:before
または:after
を使用したものを除き、定義された順に実行されます。
ロジックに問題が無ければ、他のイニシャライザーのチェーンの前または後にイニシャライザーを配置しても構いません。 あなたが、"one"から"four"と名付けられた(その順に定義された)4つのイニシャライザーを持ち、 "four"を「"four"の前に、ただし"three"の後に」と定義したとすると、 これはロジックに問題があるため、Railsはイニシャライザーの順番を判断することが出来ません。(翻訳に自信なし)
initializer
メソッドのブロック引数は、アプリケーション自身のインスタンスであり、
例のようにしてconfig
メソッドを使用することによってconfigにアクセスする事が可能です。
何故なら、Rails::Application
はRails::Railtie
(間接的に)から継承されており、
config/application.rb
内のメソッドをアプリケーションのイニシャライザーを定義するために使用することが出来るためです。
6.2 Initializers
下記は、Rails内の定義されている順に列挙した包括的なイニシャライザーのリストです。 (そのため、特に明記しない限り、実行されます(翻訳に自信なし))
7. データベースのプーリング
Active Recordのデータベース接続は、コネクションプールがデータベース接続の制限された数のスレッドアクセス量で同期することを保証する
ActiveRecord::ConnectionAdapters::ConnectionPool
によって管理されます。
この制限のデフォルトは5で、database.yml
で設定可能です。
development:
adapter: sqlite3
database: db/development.sqlite3
pool: 5
timeout: 5000
デフォルトでコネクションプーリングはActive Record内で扱われるため、 全てのアプリケーションサーバ(Thin、mongrel、Unicorn等)で同じように扱うべきです。 始めはデータベースコネクションプールは空で、必要に応じて追加のコネクションを作成し、 コネクションプールの制限に達するまでそれを行います。
リクエストは始めにデータベースへアクセスする必要があるコネクションを調べ、 その後リクエストの最後に再びコネクションを調べます。 これは、追加のコネクションスロットがキュー内の次のリクエストのために再び利用可能であることを意味します。(翻訳に自信なし)
もし、Rails.threadsafe!
モードが有効なのであれば、
いくつかのスレッドが同時に複数のコネクションにアクセスしているかもしれません。
そのため、あなたの現在のリクエスト負荷に応じて、
限られた接続数で競合する複数のスレッドを持つことも可能です。(翻訳に自信なし)
© 2010 - 2017 STUDIO KINGDOM