プログラミング

Laravel 入力検証の基本

最終更新： 17/04/2025
1 分の読み

Laravelにおける「入力の検証」は、アプリケーションのセキュリティやデータの整合性を保つために非常に重要な作業です。正しいデータがアプリケーションに送信されることを確保するために、入力内容の検証は欠かせません。本記事では、Laravelで入力検証を行うための基本的な方法から、便利な機能、カスタム検証ルールの作成方法まで、幅広く解説します。

1. 入力検証の基本

Laravelでは、リクエストに含まれるデータを検証するために、主に2つの方法が提供されています。validateメソッドを利用する方法と、FormRequestクラスを使用する方法です。

関連記事

1.1 validateメソッドによる入力検証

一番簡単に使える方法は、コントローラ内でvalidateメソッドを使用する方法です。これにより、リクエストデータが指定したルールに従っているかどうかを自動的に検証できます。例えば、以下のようなコードで検証を行います。

php
public function store(Request $request)
{
    $validated = $request->validate([
        'name' => 'required|string|max:255',
        'email' => 'required|email|unique:users,email',
        'password' => 'required|string|min:8|confirmed',
    ]);

    // バリデーションに成功した場合、次の処理へ
    // ユーザーの作成など
}

ここでは、nameフィールドは必須で、文字列で、最大255文字まで、emailフィールドは必須で、メール形式で、passwordフィールドは必須で、最小8文字以上であることを検証しています。

1.2 FormRequestクラスを使用した入力検証

より高度な検証を行いたい場合や、複雑な検証ロジックを分けて管理したい場合には、FormRequestクラスを使用することをお勧めします。これにより、検証ルールをコントローラから分離でき、可読性や再利用性が向上します。

まず、php artisan make:requestコマンドでFormRequestクラスを作成します。

bash
php artisan make:request StoreUserRequest

次に、StoreUserRequestクラスを編集します。

php
namespace App\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;

class StoreUserRequest extends FormRequest
{
    public function authorize()
    {
        // ユーザーがリクエストを実行する権限があるかどうかをチェック
        return true;
    }

    public function rules()
    {
        return [
            'name' => 'required|string|max:255',
            'email' => 'required|email|unique:users,email',
            'password' => 'required|string|min:8|confirmed',
        ];
    }
}

このクラスでは、検証ルールをrulesメソッド内に記述し、authorizeメソッドでリクエストが許可されているかを判定します。このリクエストクラスをコントローラで使用するには、次のようにします。

php
public function store(StoreUserRequest $request)
{
    // 入力検証は自動的に実行されます
    // ユーザー作成処理など
}

FormRequestクラスを使うことで、検証ロジックがコントローラから分離され、さらにテストや再利用がしやすくなります。

2. Laravelの入力検証ルール

Laravelには、データを検証するための多数のビルトインルールが提供されています。以下に、よく使われるルールをいくつか紹介します。

2.1 required

入力が必須であることを検証します。フィールドが空でないことを確認するために使用します。

php
'name' => 'required'

2.2 string

入力が文字列であることを検証します。

php
'name' => 'string'

2.3 email

入力が有効なメールアドレス形式であることを検証します。

php
'email' => 'email'

2.4 unique

データベースのカラム内で値が一意であることを検証します。

php
'email' => 'unique:users,email'

2.5 min / max

入力の長さが指定された最小値または最大値を満たしているかを検証します。

php
'password' => 'min:8|max:20'

2.6 confirmed

パスワード確認など、2つのフィールドが一致するかどうかを検証します。例えば、passwordとpassword_confirmationの一致を確認する場合に使用します。

php
'password' => 'confirmed'

3. カスタム検証ルール

Laravelでは、標準の検証ルールに加えて、自分自身でカスタムの検証ルールを作成することもできます。カスタムルールは、Ruleファサードを使って作成します。

3.1 カスタムルールを作成する

次のコマンドでカスタムルールのクラスを作成できます。

bash
php artisan make:rule Uppercase

Uppercaseというルールを作成し、以下のようにクラスを編集します。

php
namespace App\Rules;

use Illuminate\Contracts\Validation\Rule;

class Uppercase implements Rule
{
    public function passes($attribute, $value)
    {
        return strtoupper($value) === $value; // 入力が大文字であることを確認
    }

    public function message()
    {
        return 'The :attribute must be uppercase.';
    }
}

このUppercaseルールを検証ルールに追加することで、入力が大文字であるかを確認することができます。

php
use App\Rules\Uppercase;

$request->validate([
    'username' => ['required', new Uppercase],
]);

3.2 クロージャーを使ったカスタムルール

また、クロージャーを使ってカスタム検証を一時的に定義することもできます。

php
$request->validate([
    'username' => ['required', function($attribute, $value, $fail) {
        if (strtolower($value) === $value) {
            $fail($attribute.' must be uppercase.');
        }
    }],
]);

4. エラーメッセージのカスタマイズ

検証に失敗した場合、Laravelは自動的にエラーメッセージを表示しますが、メッセージをカスタマイズすることも可能です。エラーメッセージは、resources/lang/{言語}/validation.phpファイルに定義されています。

例えば、nameフィールドの検証エラーメッセージをカスタマイズしたい場合、以下のように設定します。

php
'custom' => [
    'name' => [
        'required' => '名前は必須です。',
        'string' => '名前は文字列でなければなりません。',
    ],
],

このようにして、アプリケーションで表示されるエラーメッセージをカスタマイズできます。

5. バリデーションの後処理

バリデーションが成功した場合、データは自動的にコントローラに渡されます。しかし、バリデーションに失敗した場合、エラーメッセージは自動的にセッションに格納され、リダイレクトが行われます。エラーメッセージを表示するには、Bladeテンプレート内で次のようにします。

php
@if ($errors->any())
    
    
        @foreach ($errors->all() as $error)
            
  • {{ $error }}
    • 
        @    endforeach
    

@endif

これにより、検証エラーがユーザーに表示されます。

結論

Laravelの入力検証機能は、データの正確性とセキュリティを守るために非常に強力で便利です。基本的なバリデーションの使用から、カスタムルールの作成、エラーメッセージのカスタマイズまで、さまざまな方法でアプリケーションに適用できます。検証をしっかりと行うことで、ユーザーから送られたデータが期待通りであることを確認し、安全で堅牢なシステムを構築できます。

最終更新： 17/04/2025
1 分の読み
Back to top button