イントロダクション
Laravelフレームワークの前設定ファイルは、config
ディレクトリに保存されています。各オプションには詳しいコメントが付いているので、各ファイルを一読し、使用できるオプションを把握しておきましょう。
環境設定
アプリケーションを実行している環境にもとづき、別の設定値に切り替えられると便利です。たとえば、ローカルと実働サーバでは、異なったキャッシュドライバを使いたいことでしょう。
これを簡単にできるようにするために、LaravelではVance
Lucas氏により作成された、DotEnv
PHPライブラリーを使用しています。新たにLaravelをインストールすると、アプリケーションのルートディレクトリには、env.example
ファイルが含まれています。ComposerによりLaravelをインストールした場合は自動的に、このファイルは.env
に名前が変更されます。Composerを使わずにインストールした場合は、名前を変更してください。
Tip!!
.env.testing
ファイルを作成することもできます。このファイルは.env
ファイルの値をPHPUnitテスト実行時と、Artisanコマンドを--env=testing
オプション付きで起動した場合にオーバーライドします。
環境設定の取得
このファイルにリストしている値は、アプリケーションがリクエストを受け取った時点で、$_ENV
PHPスーパーグローバル変数へロードされます。しかし、設定ファイルの変数をenv
ヘルパを使用して、値を取得できます。実際にLaravelの設定ファイルを見てもらえば、このヘルパで多くのオプションが使われているのに気がつくでしょう。
'debug' => env('APP_DEBUG', false),
env
関数の第2引数は「デフォルト値」です。この値は指定したキーの環境変数が存在しない場合に返されます。
.env
ファイルをアプリケーションのソース管理に含めてはいけません。アプリケーションの各開発者/サーバで異なった環境設定が必要になるからです。
チーム開発を行っている場合、.env.example
ファイルをアプリケーションに含めたいと思うでしょう。サンプルの設定ファイルに、プレースホルダーとして値を設定しておけば、チームの他の開発者は、アプリケーションを実行するために必要な環境変数をはっきりと理解できるでしょう。
現在環境の決定
現在のアプリケーション環境は、.env
ファイルのAPP_ENV
変数により決まります。APP
ファサードのenvironment
メソッドにより、この値へアクセスできます。
$environment = App::environment();
指定した値と一致する環境であるかを確認するために、environment
メソッドへ引数を渡すこともできます。必要であれば、複数の値をenvironment
メソッドへ渡せます。値のどれかと一致すれば、メソッドはtrue
を返します。
if (App::environment('local')) {
// 環境はlocal
}
if (App::environment('local', 'staging')) {
// 環境はlocalかstaging
}
設定値へのアクセス
アプリケーションのどこからでもグローバルのconfig
ヘルパ関数を使用し、設定値へ簡単にアクセスできます。設定値はファイルとオプションの名前を含む「ドット」記法を使いアクセスします。デフォルト値も指定でき、設定オプションが存在しない場合に、返されます。
$value = config('app.timezone');
実行時に設定値をセットするには、config
ヘルパへ配列で渡してください。
config(['app.timezone' => 'America/Chicago']);
設定キャッシュ
アプリケーションをスピードアップさせるために、全設定ファイルを一つのファイルへまとめる、config:cache
Artisanコマンドを使ってください。これによりアプリケーションの全設定ファイルのオプションが、単一のファイルに結合され、素早くロードできるようになります。
通常は開発ルーティンの一環として、php artisan config:cache
コマンドを実行すべきでしょう。アプリケーション開発時は、しばしば設定が変更されるでしょうから、ローカルでの開発中にこのコマンドを実行してはいけません。
Note: 開発期間中に
config:cache
コマンドを実行する場合は、設定ファイルの中では確実にenv
関数のみを使用してください。
メンテナンスモード
アプリケーションをメンテナンスモードにすると、アプリケーションに対するリクエストに対し、すべてカスタムビューが表示されるようになります。アプリケーションのアップデート中や、メンテナンス中に、アプリケーションを簡単に「停止」状態にできます。メンテナンスモードのチェックは、アプリケーションのデフォルトミドルウェアスタックに含まれています。アプリケーションがメンテナンスモードの時、ステータスコード503でMaintenanceModeException
例外が投げられます。
メンテナンスモードにするには、down
Artisanコマンドを実行するだけです。
php artisan down
down
コマンドには、message
とretry
オプションを付けることもできます。message
の値はカスタムメッセージを表示、もしくはログするために使用し、retry
の値はHTTPヘッダのRetry-After
としてセットされます。
php artisan down --message="Upgrading Database" --retry=60
メンテナンスモードから抜けるには、up
コマンドを使います。
php artisan up
メンテナンスモードのレスポンステンプレート
メンテナンスモードレスポンスのデフォルトテンプレートは、resources/views/errors/503.blade.php
です。アプリケーションの必要に合わせ、自由に変更してください。
メンテナンスモードとキュー
アプリケーションがメンテナンスモードの間、キューされたジョブは実行されません。メンテナンスモードから抜け、アプリケーションが通常状態へ戻った時点で、ジョブは続けて処理されます。
メンテナンスモードの代替
メンテナンスモードでは、アプリケーションがその間ダウンタイムになってしまいますので、Laravelでの開発でゼロダウンタイムを実現するEnvoyerのような代替サービスを検討してください。