Laravel でのデータ検証: 便利で強力

公開: 2023-05-03

アプリケーション内のデータが有効かつ正確で、すべてのシステム要件を満たしていることが、これまで以上に重要になっています。データの一貫性を維持し、セキュリティの脆弱性を回避する必要性に対処します。

Laravel は、データ検証を簡単かつ直感的にします。モデルビューコントローラー (MVC) アーキテクチャに従い、PHP とオブジェクト指向プログラミング (OOP) の概念に関する一般的な知識のみが必要です。さらに、Laravel は受信データを検証するためのいくつかの方法を提供します。

これらのアプローチのいくつかと、検証ルールをデータセットに適用する方法を調べてください。

Laravelでデータ検証が簡単に

Laravel は、アプリケーションのユーザーがフォーム経由でデータを送信するときに、すぐに使用できるバリデーションルールをいくつか提供します。入力フィールドを必須としてマークし、最小または最大の長さを設定し、一意の (重複しない) エントリと有効な電子メールアドレスを要求することができます。 Laravelバリデーターは、入力がこれらのルールまたは指定した他のルールを満たしているかどうかをチェックします。

これらの Laravel 検証ルールには以下が含まれます。

required — フィールドデータを null または空にすることはできません。
array — フィールドデータは PHP 配列でなければなりません。
bail — 検証ルールは、最初の検証エラーが発生した後に実行を停止します。
email — フィールドデータは有効な電子メールアドレスである必要があります。
unique — データベーステーブル内でフィールドデータに重複があってはなりません。

すべての検証方法には長所と短所がありますが、その多様性により、ニーズに最適なアプローチを選択できます。選択した方法に応じて、Laravel の検証はいくつかの方法で発生し、手動または自動のエラーメッセージが表示されます。

最も一般的な方法は code>validate で、着信 HTTP 要求に使用されます。このメソッドは要求データにチェーンされ、検証ルールを実行します。以下の例に示すように、各フィールドのルールをコンマで区切ることができます。

 use Illuminate\Http\Request; public function store (Request $request){ $validated = $request->validate([ 'email' => ['required, unique:users, email, bail'], 'name' => ['required'], ]); }

ここで、 email必須入力です。つまり、null にすることはできません。さらに、同じ電子メールアドレスが 2 回登録されないように、 usersデータベーステーブル内で一意である必要があります。最後のルールは、電子メールアドレスも有効である必要があることを示しています。それ以外の場合、検証プロセスは停止します。名前フィールドは必須ですが、他のルールはありません。

いずれかの Laravel 検証ルールが失敗した場合、応答が自動的に生成されます。

1 つのデータエラーですべてのハードワークが台無しにならないようにしてください。データを検証し、プロジェクトを安全かつ健全に保ちます️ Click to Tweet

検証の基本

検証方法をよりよく理解するために、次の例を検討してください。エンドポイントのルートを定義し、要求データを検証して処理するためのコントローラーを作成します。

まず、ユーザーがメールとパスワードを保存できるようにする単純なエンドポイントを作成します。

ルートを定義する

Laravel ルートは、Web アプリケーション用のroutes/web.phpファイルまたは API 用のroutes/api.phpファイルで定義されます。この例では、 api.phpを使用します。

 use App\Http\Controllers\UserController; Route::post('/store', [UserController::class]);

コントローラーを作成する

次のアーティザンコマンドを実行して、コントローラーを作成します。

 php artisan make:controller UserController

このコマンドは、 app/Http/ControllersディレクトリにUserController.phpファイルを作成します。

ここで、 store エンドポイントに入るデータを保存する前に検証するためのstoreメソッドを定義します。

この例では、これらのルールを使用して次のフィールドを検証します。

email — 一意で、有効な電子メールである必要があり、必須である必要があります
password — 最小の長さ、パスワードの確認が必要であり、必須である必要があります
age — 数値である必要があり、必須である必要があります

<?php namespace App\Http\Controllers; use Illuminate\Http\Request; class UserController extends Controller { /** * Store new user details. * */ public function store(Request $request){ $validated = $request->validate([ 'email' => 'required|unique:users|email', 'age' => 'required|numeric', 'password' => 'required|min:7|confirmed' ]); // After user data is validated, logic to store the data } }

confirmedルールを使用すると、ユーザーが登録時にパスワードを再入力するなど、データが正確であることを確認するために、特定のフィールドを 2 回要求することができます。このルールにはpassword_confirmationというフィールドが必要で、そのデータはpasswordフィールドと一致する必要があります。

エラーメッセージの表示

検証基準が満たされている場合、コードは引き続き正常に実行されます。検証が失敗した場合、 IlluminateValidationValidationException例外がスローされ、適切なエラー応答が返されます。

この例は、 422 Unprocessable Entity HTTP 応答を JSON 形式で返す API に基づいています。 Web アプリケーションの場合、以前の URL にリダイレクトしてエラーメッセージを表示し、要求データがセッションにフラッシュされました。

ビューで$errors変数を使用して、返されたエラーを表示できます。

 @if ($errors->any()) <div class="alert alert-danger"> <ul> @foreach ($errors->all() as $error) <li>{{ $error }}</li> @endforeach </ul> </div> @endif

最初のエラーのみを表示するか、ループスルーしてすべてを表示するかを選択することもできます。

 // Fetch all errors $errors->all() // Fetch only the first error $errors->first()

フォームの再入力

フォームを再入力すると、ユーザーは情報を再入力する手間が省け、エラーの修正に集中できます。電子メールアドレスが失敗する例では、 nameフィールドの古い値を呼び出すことで、フォームの残りの部分を再入力できます。

 $name = $request-> old('name') //Blade helper <input type="text" name="name" value="{{ old('name') }}">

前の入力がない場合、このルールはnullを返します。

高度な検証

Laravel は、フォームリクエストと呼ばれるバリデーションを記述する別の方法を提供します。フォームリクエストは、検証を整理し、コントローラを整理するカスタムリクエストクラスです。

これらには、大量の入力に適した独自の検証および承認ロジックがあり、検証ルールの定義やエラーメッセージのカスタマイズに使用できます。

フォームリクエストを作成するには、次の Artisan コマンドを実行します。

 php artisan make:request StoreUserRequest

このコマンドはapp/Http/RequestsディレクトリにStoreUserRequest.phpファイルを作成し、2 つのデフォルトメソッドを含みます。

rules要求データの検証規則を返します。
authorizeそのユーザーが要求されたアクションを実行する権限を持っているかどうかを示すブール値を返します。

前の例をフォームリクエストを使用するように変換します。

 <?php namespace App\Http\Requests; use Illuminate\Foundation\Http\FormRequest; class StoreUserRequest extends FormRequest { /** * Determine if the user is authorized to make this request. * * @return bool */ public function authorize() { // Add logic to check if the user is authorized to submit this data. return true; } /** * Get the validation rules that apply to the request. * * @return array<string, mixed> */ public function rules() { return [ 'email' => 'required|unique:users|email', 'age' => 'required|numeric', 'password' => 'required|min:7|confirmed' ]; } }

これらのルールのエラーメッセージをカスタマイズするには、 FormRequestクラスのメッセージメソッドをオーバーライドします。

 /** * Get the error messages for the defined validation rules. * * @return array */ public function messages() { return [ 'email.required' => 'An email address is required', 'email.email' => 'The email address must be valid', 'password.confirmed'=>'Re-type your password as password_confirmation, passwords does not match' ]; }

注:データ名と検証ルールは、メッセージデータの前にピリオド (.) で区切られます。

カスタム検証

カスタム検証を作成するには、 validateの代わりにValidatorファサードを使用できます。バリデータインスタンスには、検証するデータと検証ルールの配列の 2 つの引数が含まれます。これら 2 つの引数は、バリデータファサードの::makeメソッドに渡され、新しいバリデータインスタンスが生成されます。

 use Illuminate\Http\Request; public function store (Request $request){ $validator = Validator::make($request->all(),[ 'email' => 'required|unique:users|email', 'age' => 'required|numeric', 'password' => 'required|min:7|confirmed' ]); if ($validator->fails()) { // Return errors or redirect back with errors return $validator->errors(); } // Retrieve the validated input... $validated = $validator->validated(); // Continue logic to store the data }

自動ダイレクトを追加する場合は、既存のバリデータインスタンスでvalidateメソッドを実行できます。検証が失敗した場合、XHR リクエストは422 Unprocessable Entityをステータスコードとして含む JSON レスポンスを生成するか、ユーザーはすぐにリダイレクトされます。

 $validator = Validator::make($request->all(),[ 'email' => 'required|unique:users|email', 'password' => 'required|min:7|confirmed' ])->validate();

messagesと呼ばれる 3 番目の引数をValidate::make methodに渡すことで、エラーメッセージをカスタマイズすることもできます。

 $validator = Validator::make($request->all(),[ 'email' => 'required|unique:users|email', 'age' => 'required|numeric', 'password' => 'required|min:7|confirmed' ], $messages = [ 'required' => 'The :attribute field is required.', ]);

注: : :attribute検証中のフィールドの名前に置き換えられます。

大量のデータを扱うと、すぐに制御不能になる可能性があります。 Laravel バリデーションであなたのプロジェクト (そしてあなたの健全性!) を守りましょう。クリックしてツイートする方法は次のとおりです

まとめ

データ検証を実行することは、データセットをクリーンで正確かつ完全な状態に保つために重要です。データ検証を使用すると、破損したり、プロジェクトに影響を与えたりする可能性のあるデータのエラーを排除できます。大規模で大量のデータを扱う場合、検証はますます重要になります。

Laravel は、アプリケーションを通過するデータの整合性と正確性を確保するための多数の柔軟なアプローチを可能にします。デフォルトおよびカスタマイズ可能なメソッドを使用して複雑な検証ロジックを実現し、コードベースを適切に構造化して、より簡単に再利用できるようにすることができます。

Kinsta のアプリケーションホスティングサービスを使用して、Laravel アプリをより迅速に出荷します。