APIキーを.envにいれてconfig関数で呼び出す理由と方法【Laravel入門講座】

Laravelでは、APIキーや接続情報などを .env ファイルに保存します。

.envファイルの情報をコントローラーやビューで使うときは、configヘルパ関数を使います。

テスト環境では不要ながら、本番環境では、このステップが必要です。

3ステップで設定方法を紹介した後に、なぜこんなことをするのか、理由を解説していきますね。

LaravelでAPIキーを.envにいれてconfig経由で使う方法
LaravelでAPIキーを.envにいれてconfig経由で使う理由
まとめ

LaravelでAPIキーを.envにいれてconfig経由で使う方法

まずは方法を、3ステップで解説していきますね。

今回はStripeというサービスのAPIキーを例にとって、説明していきます。

ステップ① .envファイルに入力

まず.env（環境設定）ファイルを開き、次のようにAPIキーを入力します。

設定名=キー

なお.envに入力する際には、大文字でいれるルールがあります。

実際の入力例はこちら。

STRIPE_KEY=STRIPE公開可能キー
STRIPE_SECRET=STRIPEシークレットキー

1 2	STRIPE_KEY=STRIPE公開可能キー STRIPE_SECRET=STRIPEシークレットキー

ステップ② configファイルに入力

次に app/configフォルダのservices.phpファイルを開きます。

下記のように、.envファイルの内容を読み込ませます。

return [
‘設定名’ => env(‘envファイルでの設定名’),
],

return[],はすでに入っているので、入力不要です。

ひとつのシステムに複数のキーがあって、まとめて入れる場合には、配列が使えます。

実際の入力例はこちら。

    'stripe' => [
        'pb_key'=>env('STRIPE_KEY'),
        'st_key'=>env('STRIPE_SECRET'),
    ],

'stripe' => [

'pb_key'=>env('STRIPE_KEY'),

'st_key'=>env('STRIPE_SECRET'),

ステップ③ コントローラーやビューで設定値を呼び出す

最後に、この情報をコントローラーやビューファイルで読み込みます。

この際、configヘルパ関数を使って、下記のようにキーを呼び出せます。

confit(‘ファイル名.設定値名’）

具体的には、コントローラーでキーを呼び出す場合には、次のように書きます。

$value=config('services.stripe.pb_key');

1	$value=config('services.stripe.pb_key');

ビューファイルでは、下記のようにします。

{{ config('services.stripe.pb_key') }}

1	{{ config('services.stripe.pb_key') }}

ひとことメモ

config内の既存ファイル（service.php）に書く方法を解説しましたが、新規ファイルを作ってもOK。

入力するキーが多い場合には、そのほうが分かりやすいです。

LaravelでAPIキーを.envにいれてconfig経由で使う理由

ここまでで、設定方法を解説しました。

次に、なぜ、.envファイルの内容を直接読み込んではいけないかを解説します。

Laravelには、config:cacheというコマンドがあります。

php artisan config:cache

1	php artisan config:cache

本番環境に移行する前に、実施したほうが良いコマンドのひとつ。

これを行うと、設定情報が１つのファイルに統合され、高速でロードができるようになります。

公式マニュアルには、本コマンドについて、下記のように説明があります。

アプリケーションをスピードアップさせるために、全設定ファイルを一つのファイルへまとめる、config:cache Artisanコマンドを使ってください。これによりアプリケーションの全設定ファイルのオプションが、単一のファイルに結合され、フレームワークが素早くロードできるようになります。

一般的には、本番環境へのデプロイ作業の一環として、php artisan config:cacheコマンドを実行すべきでしょう。

*参考元：Laravel8 公式マニュアル

ところが、このコマンドには、大きな落とし穴が！

config:cacheコマンドを入力すると、.envファイルはロードされなくなってしまうのです。

そのため、.envから直接設定値を呼び出している箇所では、すべて null という値が返ってきてしまうことに。