デバッグ on ララジャパン

withInput(), withErrors(), with()

Sat, 03 Oct 2020 02:10:22 +0900

前回では、入力画面で投稿した入力値やバリデーションエラーを画面に表示するために、セッションを利用してそれらの値がキープされることを知りました。今回はそれらがどのようにコントローラで指示されるかを見てみます。

Laravelの認証パッケージで提供されるものは、より複雑なので簡単な会員登録のコントローラをここでは使います。

RegisterController.php

namespace App\Http\Controllers;

use App\User;

use Illuminate\Http\Request;

class RegisterController extends Controller
{
    /**
     * Create
     *
     * @return \Illuminate\View\View
     */
    public function create()
    {
        return view('auth.register');
    }

    /**
     * Store
     *
     * @param  \Illuminate\Http\Request $request
     * @return \Illuminate\Http\RedirectResponse
     */
    public function store(Request $request)
    {
        $rules = [
            'name'                  => 'required',
            'email'                 => 'required|email',
            'password'              => 'required|confirmed',
            'password_confirmation' => 'required',
        ];

        $request->validate($rules);

        User::create($request->all);

        return redirect()
            ->route('login')
            ->with('status', '新規作成完了');
    }
}

３４行目の$request->validate($rules)のコードが、バリデーションエラーが起こったときに、入力値やエラーをセッションに一時的に保存する作業をすべてやってくれるのですが、これではシンプルすぎ（もちろん良いことですが）で説明のしようがないので、以下のように拡張したコードに変えてみます。

...
        $validator = validator($request->all(), $rules); // バリデーションを実行

        if ($validator->fails()) { // バリデーションエラーがあるなら、
            return back()   // 前の画面にリダイレクト
                ->withInput() // セッション(_old_input)に入力値すべてを入れる
                ->withErrors($validator); // セッション(errors)にエラーの情報を入れる
        }
...

上でコメントを入れましたが、back()にチェーンされた、withInput()とwithErrors()の関数が入力値とエラーをセッションに保存してくれます。

withInput()の引数として、配列関数を指定することもできます。例えば、

...
            return back()
                ->withInput($request->except('email')) // email以外の入力値を保存
                ->withErrors($validator);
...

さらに、入力値やエラーと関係ない値も、with()でセッションに保存して、次の画面で使用も可能です。

...
            return back()
                ->withInput($request->except('email'))
                ->with('error', '入力エラーがあります')
                ->with(['more' => 'メッセージ', 'more2' => 'メッセージ2']);
...

デバッグバーで見ると、セッションに保存されていることがわかります。

with()で渡した値は、ブレードでは、session()ヘルパーを利用して、

@if (session('error')) 
    <div class="alert alert-danger">{{ session('error') }}</div>
@endif

のように使えます。

old()ヘルパー

Fri, 25 Sep 2020 23:42:41 +0900

Laravelのブレードファイルでよく見かける、old()ヘルパー。エラーが起こった時に入力した値をキープしてエラーとともに入力項目に残してくれる優れものです。今回はこの仕組みを見てみます。

ブレードファイル

old()ヘルパーはブレードファイルに使われます。以下は、Laravelのデフォルトの認証に使用されるブレードのファイルの一部をとってきました。

...
<div class="form-group row">
	<label for="email" class="col-md-4 col-form-label text-md-right">{{ __('E-Mail Address') }}</label>

	<div class="col-md-6">
		<input id="email" type="text" class="form-control @error('email') is-invalid @enderror" name="email" 
		    value="{{ old('email') }}" required autocomplete="email">

		@error('email')
			<span class="invalid-feedback" role="alert">
				<strong>{{ $message }}</strong>
			</span>
		@enderror
	</div>
</div>
...

inputのHTML文で、value="{{ old(’email’) }}"にヘルパーが使われていますね。

このために、以下のようにエラーが起こると、入力した値が再表示されます（ここでは、デモののためにtype=“email"ではなく、type=“text"としています）。

リクエストの流れ

エラーが出力するまでのリクエストの流れをたどってみると、以下の３つのリクエストとリスポンスからなります。

GETのリクエストで空の入力画面が表示されます。
次に、不正なEmailの値を入れて、「Register」のボタンを押すとPOSTのリクエストでサーバー、つまりLaravelのコントローラに送信されます。
そこのバリデーションでエラーが起こると（つまりメールアドレスのフォーマットではない）、入力した値とエラーを表示するためにGETのリクエストで以下の画面となります。

さて、どうやってLaravelはPOSTした入力値を次のGETで表示される画面に出力しているのでしょう？

Laravelはこの目的のためにセッションを利用しています。上の２番目のPOSTのリクエストでセッションに入力値を保存して、次のGETのリクエストのときに、セッションから取り出します。このセッションの保存は特別で、使用は次のリクエストのみです。それゆえに同じ画面を手動でリフレッシュすると上の１の空の入力の画面となります。

デバッグバー

ここ実際のセッションの状態がどう遷移するか見てみたいですね。

そこで登場するのがデバッグバーのパッケージです。

以下でインストールできます。

$ composer require barryvdh/laravel-debugbar --dev

デバッグバーをインストールして、同じ画面でエラーを発生させると、以下のように画面下で実行したDBクエリーやセッションなどの情報を見ることできます。

赤の矢印の部分をクリックすると、セッションの情報が表示されます。あれれ、old()の値となるセッション項目は空ですね。おかしいかなと思いきや、この画面は、流れの３番目の画面を表示後の段階で、もう保存した値はセッションにはないのです。その前のPOSTのの直後のセッションの値を見る必要あります。

POSTへ戻るには、青箱のフォルダーアイコンをクリックします。そこでポップアップ表示される以下のダイアログにおいて、POSTの行をクリックします。

以下がPOSTの直後でのセッションの値です。見ての通りに、_old_inputには入力された値、errorsにはエラーのデータが保存されています。さらに、_flashの配列には、oldとして_old_inputとerrorsがあり、これらは次のリクエストで利用できることを示しています。

ddd()

Sat, 29 Feb 2020 02:03:48 +0900

Laravelではdd()というヘルパー関数をデバッグでよく使用しますが、ddd()は初耳です。なぜなら、Laravel 6.xバージョンで新登場したデバッグの関数だからです。

dd()
新登場のddd()の比較のためと、Laravel 6.xの以前のバージョンのために、まずdd()の使用を見てみましょう。
dd()を以下のように追加すると、

routes/web.php

Route::get('/', function () { $user = App\User::first(); dd($user); return view('welcome'); });
以下のように実行を止めて、引数で指定した変数の情報をブラウザに表示してくれます。

その時点で、実行した関数のスタックトレースをしたいなら、

routes/web.php

Route::get('/', function () { $user = App\User::first(); dd(print_r(debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS),true));//面倒なら、debug_backtrace(2)でもＯＫ return view('welcome'); });
とすると、

Array ( [0] => Array ( [file] => /vol1/usr/www/repos/repos/l6x/vendor/laravel/framework/src/Illuminate/Routing/Route.php [line] => 205 [function] => {closure} [class] => Illuminate\Routing\RouteFileRegistrar [type] => -> ) [1] => Array ( [file] => /vol1/usr/www/repos/repos/l6x/vendor/laravel/framework/src/Illuminate/Routing/Route.php [line] => 179 [function] => runCallable [class] => Illuminate\Routing\Route [type] => -> ) [2] => Array ( [file] => /vol1/usr/www/repos/repos/l6x/vendor/laravel/framework/src/Illuminate/Routing/Router.php [line] => 681 [function] => run [class] => Illuminate\Routing\Route [type] => -> ) ...
ddd()

さて、Laravel 6.xのバージョンのddd()ヘルパーを使用すると、

routes/web.php

Route::get('/', function () { $user = App\User::first(); ddd($user); return view('welcome'); });
以下のように、とても見やすいＵＩで出力してくれます。

そればかりでなく、関数スタックのトレースもメニューを選択して表示してくれます。しかも、Laravel内部での関数の実行を隠して（拡張して見ることも可能）開発した関数だけを見せてくれます。

こういう便利な機能を追加してくれると、Laravelをアップグレードするモチベーションが上がりますね。

コントローラのコンストラクタで引数を取り出す

Sat, 09 Feb 2019 00:00:40 +0900

以前に、Laravel 5.3　コントローラのコンストラクタの重要な変更として、コントローラで定義するメソッド間で共有するコードをコンストラクタに入れることが可能なことを説明しました。今度は同じコンストラクタ内で、コントローラのメソッドに渡される引数の取り出しかたを説明します。何を言っているかというと、まずは準備から。

準備
例として、routes/web.phpにおいて、以下のようなrouteを定義します。
... Route::resource('product', 'ProductController'); ...
これは、以下のようなURIを生成します。

+--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+ | Domain | Method | URI | Name | Action | Middleware | +--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+ | | GET|HEAD | product | product.index | App\Http\Controllers\ProductController@index | web | | | POST | product | product.store | App\Http\Controllers\ProductController@store | web | | | GET|HEAD | product/create | product.create | App\Http\Controllers\ProductController@create | web | | | GET|HEAD | product/{product} | product.show | App\Http\Controllers\ProductController@show | web | | | PUT|PATCH | product/{product} | product.update | App\Http\Controllers\ProductController@update | web | | | DELETE | product/{product} | product.destroy | App\Http\Controllers\ProductController@destroy | web | | | GET|HEAD | product/{product}/edit | product.edit | App\Http\Controllers\ProductController@edit | web | +--------+-----------+-------------------------------+-----------------------+------------------------------------------------------------------------+----------------------------------------------+
そして、ProductController.phpを以下のように定義します。

namespace App\Http\Controllers; use Illuminate\Http\Request; use App\Models\Product; class ProductController extends Controller { /** * 情報画面 * * @param \App\Models\Product $product * @return \Illuminate\View\View */ public function show(Product $product) { 　　　 // } /** * 編集画面 * * @param \App\Models\Product $product * @return \Illuminate\View\View */ public function edit(Product $product) { // } /** * 編集保存 * * @param \Illuminate\Http\Request $request * @param \App\Models\Product $product * @return \Illuminate\Http\RedirectResponse */ public function update(Request $request, Product $product) { // } }
コンストラクタで引数を取り出す

用意ができたところで、

例えば、

product/456

のGETのアクセスでは、id = 456に対応するProductのEloquentオブジェクトがshow()のメソッドの引数$productの値として渡されます。

そして、

product/456/edit

のGETは、id = 456に対応するProductのオブジェクトがedit()のメソッドの引数$productの値として渡されます。

さて、このid = 456のProductのオブジェクト、それぞれのメソッドの引数と渡される前に、コンストラクタで取り出すには？

namespace App\Http\Controllers; use Illuminate\Http\Request; use App\Models\Product; class ProductController extends Controller { public function __construct() { parent::__construct(); $this->middleware(function ($request, $next) { $product = $request->product;　//id = 456のProductのオブジェクトを取得 debug(get_class($product), $product->id); return $next($request); }); } ...
と、middleware()の関数を使えば、その匿名関数の中で簡単に取り出せますね！

product/456

のURIにブラウザでアクセスすれば、Debugbarでは、

debug　App\Models\Product debug 456
とデバッグ文を表示します。

product/456/edit

でも

product/456/update

でも、同じようにそれぞれのメソッドを実行する前に、引数にアクセスすることが可能となります。

ひとつここで疑うのは、Productのオブジェクトを取得するために以下のようなSQL文が、middleware()で１回、そしてさらにshow()のようなメソッドの引数でもう１回、計２回実行されることになるか、です。

select * from product where id = 456
これもDebugbarのQueryの出力で１回しか実行されていないことを確認しました。一度作成したオブジェクトを同じコントローラ内で２度作成することはなりません。

取り出して、それからどうする？

ここが大事なのですが、例えば、この商品（product）がEコマースで販売される商品とします。商品の登録や編集は、裏側の管理画面で商品の製造元の店舗がログインして行います。しかし、複数の店舗が存在するので、店舗Aが店舗Bの商品を編集できては困ります。しかし、URIには商品のIDが表示されるので、IDの数字を変えて他の店舗の商品を閲覧（公開されていない情報がある）や編集することが可能となってしまいます。それを防ぐためには、

... public function __construct() { parent::__construct(); $this->middleware(function ($request, $next) { $product = $request->product; //id = 456のProductのオブジェクトを取得 $user = auth('shop')->user(); // 現在ログインしている店舗のユーザー if ($product->shop_id != $user->shop_id) { //この商品の店舗ではない！ abort(404); } return $next($request); }); } ...
のように設定すれば、いちいちshow()やedit()やupdate()などで、同様なコードを繰り返さずに済みプログラムの管理性が高まる、ということです。

Debugbarで楽々デバッグ

Mon, 06 Jun 2016 03:25:24 +0900

以前に紹介した、Debugbar。

私には、もうなくてはならないものになりました。対象の画面で実行されたDBのクエリーはすべて見ることができるし、セッションの中身の値も確認できる。

そして、もうひとつ、プログラムの中で自分が見たいという変数をdebug()のヘルパー関数で、以下のように使用すれば、

class UserController extends Controller { public function getUpload() { return view('user/upload'); } public function postUpload(Request $request) { debug($request->all()); $file = $request->file('file'); $filename = $file->getClientOriginalName(); $request->file('file')->move(public_path('images'), $filename); } }
以下の画面のように、バーで表示してくれます。

行をクリックすれば、詳細を表示します。

ユーザー認証（１４）Debugbar

Fri, 12 Feb 2016 08:26:57 +0900

マルチ認証のトピックが続いていますが、同じブラウザを使用して「会員」と「管理者」の両方にログインしたらどうなるのでしょう？

ログインはブラウザのクッキーを使用して、サーバーのセッションと繋がっています。Laravelはそれぞれに違うセッション、違うクッキーを使用するのでしょうか？それとも同じセッションで違う情報を保持するのでしょうか？興味ありませんか？

ということで、便利なツールの紹介とともに、認証のセッションがどうなっているかチェックしてみましょう。

ここで紹介するツールはDebugarというLaravelのためのツールです。

これをインストールすると、画面下にDebugarの情報パネルが表示され、実行したLaravelの様々な情報を見ることができます。

例えば、以下は会員のログイン成功直後の画面ですが、実行したDBのクエリーを見ることができます。DBテーブルusersに対するクエリーがあります。

このツールのインストールはとても簡単です（GitHubにリポあります）。

まず、以下を実行します。

composer require barryvdh/laravel-debugbar
composer.jsonが更新されライブラリがダウンロードされインストールされます。

次に、config/app.phpに以下を追加します。

... 'providers' => [ ... Barryvdh\Debugbar\ServiceProvider::class, ], 'aliases' => [ ... 'Debugbar' => Barryvdh\Debugbar\Facade::class, ], ];
これで完了です。

先の会員ログインを実行では、DBのクエリーの情報を見ることができましたが、セッションはどうなのでしょう？

赤丸の部分がセッションの情報を見るボタンです。そして赤の四角の部分が、会員が認証されていることを示す情報です。login-user..の部分です。

さて、同じブラウザでもう１つタブを作成して今度は、管理画面にログインしてみましょう。以下が、ログイン成功後のセッション値です。

値が増えていますね。しかし、今度は、login-admin..と違う名前となっていますね。

つまり、セッションの中でguardの値をセッションの変数名として使い分けているわけです。