Laravel5.7から追加された「dump-server」を使ってみる



Laravel5.7から追加されたartisanコマンド「dump-server」の紹介です。

Laravelフレームワークの内部では 多くのSymfonyフレームワークのコンポーネントが使われています。

その中の1つに 変数をダンプ( var_dump, print_rの様な機能 )する ' dump 'メソッドが含まれており、
Laravelフレームをお使いの人は 値を確認したい時に ' dd ' や ' dump ' メソッドを使う事も多いのではないでしょうか。

そんな dump メソッドを更に便利に使えるように Laravel 5.7 から ' dump-server ' コマンドが追加されました。

dump-server で出来ること 

- テンプレート上ではなく、コマンドライン上に値をアウトプットさせることが出来ます

* dump-serverを起動させて値をダンプ 


dump-server の使い方

dump-serverの使い方は簡単で、コマンドライン上から下記のarisanコマンドを使って dump-serverを起動させるだけで使うことが出来ます。
 * ' php artisan serve ' も同時に起動させる必要があります

# dump-serverを起動
php artisan dump-server


dump-server コマンドを打つと tcpポートでサーバーが起動し、
' dump ' メソッド内の値は dump-server を起動させたコマンドライン上にアウトプットされます。
* ' dd ' メソッドを使うと呼び出した時点で処理が終了するので、 ' dump ' メソッドを使う必要があります

// サンプルコード

Route::get('/', function () {
    // 配列
    $arr = [
      '1' => 'arr1',
      '2' => 'arr2',
      '3' => 'arr3',
      '4' => 'arr4',
      '5' => 'arr5',
      '6' => 'arr6',
      '7' => 'arr7',
    ];

    dump($arr); // 値をdump

    return view('welcome'); // Viewをレンダリング
});

* dump-serverを起動させたGIF 


Summary

dump-serverは もともと、Symfonyが開発した機能の1つで Symfony 4.1 から利用することができます。

Laravel フレームワークには 5.7から追加されましたが、Laravel本体とは独立したパッケージなので、composer 上からパッケージを追加すれば Laravel 5.6上でも使うことが出来ます。

ローカルサーバー起動時に 一緒にdump-serverを起動させていれば、
POST処理で渡す値の確認に javascript上で ' console.log ' 処理を書く手間が省けたりするので 開発が少し楽になりそうです。

GitHub : beyondcode/laravel-dump-server

 

この記事のカテゴリ
プログラミング

この記事に付けられているタグ