🈚️
Laravel で null ドライバを .env から指定するときは "'null'" と書こう
タイトルがすべてですが、例えばログ設定で 'null'
チャンネル [1] を使いたいときはこう書きましょう
.env
LOG_CHANNEL="'null'"
# or
LOG_CHANNEL='"null"'
なんで?
env()
ヘルパーが .env
に書かれている文字列の null
を NULL
値として解釈してしまうからです
実際に .env
を以下のように書いて [2]
.env
LOG_CHANNEL=null
env()
ヘルパーの挙動を確かめると
>>> var_dump(getenv('LOG_CHANNEL'))
string(4) "null"
>>> var_dump(env('LOG_CHANNEL'))
NULL
NULL
値が返ってきます
config/logging.php
で 'null'
チャンネルを利用した際はログの出力が一切ないことを期待していますが、
この状態でログ出力を実際に試すと emergency logger が利用され、 storage/logs/laravel.log
にログが出力されてしまいます
storage/logs/laravel.log
[2021-03-14 15:46:10] laravel.EMERGENCY: Unable to create configured logger. Using emergency logger. {"exception":"[object] (InvalidArgumentException(code: 0): Log [] is not defined. at /var/www/html/vendor/laravel/framework/src/Illuminate/Log/LogManager.php:192)
[stacktrace]
#0 /var/www/html/vendor/laravel/framework/src/Illuminate/Log/LogManager.php(118): Illuminate\\Log\\LogManager->resolve()
#1 /var/www/html/vendor/laravel/framework/src/Illuminate/Log/LogManager.php(98): Illuminate\\Log\\LogManager->get()
#2 /var/www/html/vendor/laravel/framework/src/Illuminate/Log/LogManager.php(608): Illuminate\\Log\\LogManager->driver()
#3 /var/www/html/vendor/laravel/framework/src/Illuminate/Support/Facades/Facade.php(261): Illuminate\\Log\\LogManager->debug()
...(snip)...
[2021-03-14 15:46:10] laravel.DEBUG: hoge
"'null'"
にするとどうなるの?
環境変数は string(6) "'null'"
として解釈されますが、 env()
ヘルパーは string(4) "null"
を返します
>>> var_dump(getenv('LOG_CHANNEL'))
string(6) "'null'"
>>> var_dump(env('LOG_CHANNEL'))
string(4) "null"
これは env()
ヘルパーの実装がよしなにやってくれているからです
これで 'null'
チャンネルが正しく使われて、ログがどこにも出力されなくなります
>>> Log::debug('hoge')
=> null
>>> # どこにもログが出力されない
'null'
チャンネルっていつ使うの?
ログの テスト実行時など、ログを出したくないときに便利です
'null'
以外のドライバ名にしないの?
- ログの
'null'
チャンネル名は当初'none'
としてプロポーザルが出されていました [3] - 最終的に、
null
ドライバなんだからnull
という名前をつけたほうが一貫性があって良い、で落ち着いたようです [4] - この手の問題は、将来的に
null
を残しつつ別名もサポートしたほうが便利だね、という話も出ていましたが、まだ実現はしていないようです [5]
参考
- [5.8] BUG: Fix quoted environment variable parsing
- [Proposal] Null logging channel #1806
- [6.x] Add 'null' logging channel #5106
-
LOG_CHANNEL='null'
やLOG_CHANNEL="null"
も同様 ↩︎ -
https://github.com/laravel/laravel/pull/5106#issuecomment-531220153 ↩︎
-
https://github.com/laravel/framework/pull/27691#issuecomment-467872248 ↩︎
Discussion