環境構築

laravelデバッグバーの導入

2018/10/12

Laravelには Laravelデバッグバー という便利なLaravel専用のデバッカーがあります。

Laravelデバッグバーを入れるとデバッグ作業では重宝するので入れることをお勧めします。

Laravelデバッグバーはビュー画面の下にデバッグバーが表示されます。

デバッグバーでは

・Messages:追加情報を表示
・Timeline:Laravelの起動時間(booting)とコードの実行時間(Application)に分かれて表示
・Exceptions:例外のログ
・Views:ビューのプロパティーを表示
・Route:ルートの情報
・Queries:クエリー情報
・Mails:メールのpretendの情報
・Request:リクエストの内容

といった情報を確認することできます。

今回はlaravelデバッグバーについてエントリーします。

 

チュートリアル

ローカル開発環境にてLaravelデバッグバーを入れる。
(※本番環境で利用するのはやめましょう)

手順

1)composerでLaravelデバッグバーをインストール
2)設定ファイル(config/app.php)の編集
  1.サービス・プロバイダーの追加
  2.ファサードの追加
  3.envファイルの編集
3)動作確認

 

1)composerでLaravelデバッグバーをインストール

barryvdh/laravel-debugbarというパッケージを入れます。

composerでインストールします。

cd { laravel-project }
composer require barryvdh/laravel-debugbar
ポイント!

もし上手くcomposerでインストールができなかったらバージョンを指定してあげるといいです。

composer require barryvdh/laravel-debugbar:2.4

 

2)設定ファイル(config/app.php)の編集

1.サービス・プロバイダーの追加

Laravelの設定ファイルである config/app.php にてサービスプロバイダーの項目にデバッグバーを追記します。

 'providers' => [
        :
  Barryvdh\Debugbar\ServiceProvider::class,
  ],

 
2.ファサードの追加

Laravelの設定ファイルである config/app.php にてファサードの項目にデバッグバーを追記します。

  'aliases' => [
        :
  'Debugbar' => Barryvdh\Debugbar\Facade::class,
  ],

 
3.envファイルの編集

ローカル環境に置いてある .envファイル の APP_DEBUG の定数をtrueにします。

APP_DEBUG=true
【 注意 】
①本番環境に置いてある .envファイルはfalseにします。
②envファイルを編集したら

php artisan config:cache

でキャッシュをクリアにします。

 

3)動作確認

ブラウザを起動してビューの画面を確認します。

ユースケース1

下記の情報を追記するとデバッグバーの「message」に表示されます。

Debugbar::info($object);
Debugbar::error('Error!');
Debugbar::warning('Watch out…');
Debugbar::addMessage('Another message', 'mylabel');

 
ユースケース2

下記のように例外処理をスローするとデバッグバーの「exceptions」に表示されます。

try {
    throw new Exception('foobar');
} catch (Exception $e) {
    Debugbar::addThrowable($e);
}
【 注意 】
ローカルでlaravelデバッグバーをインストールすると composer.json/composer.lock にも情報が追記されます。
本番環境にこれらのファイルをデプロイしたら composer install を実行しましょう。
なお、さくらレンタルサーバーでマルチドメインでプロジェクトを管理している場合は以下のコマンドになります。

% php ../composer.phar install

 
Laravelのデバッグバーに関しては以上です。

本庄マサノリ

仕事でLaravelを使っています。気づいたことや新しい発見など情報を発信していきます。メールはこちら

 

-環境構築