この記事にはプロモーションが含まれています。

【Laravel11】バリデーションの実装方法やエラーメッセージのカスタマイズ

2024-09-29

Laravelではバリデーションを簡単に実装する仕組みが用意されています。

この記事ではLaravelバージョン11でバリデーションを実装する方法をご紹介します。

この記事で分かること

Laravelバージョン11でバリデーションを実装する基本的な方法
バリデーションのエラーメッセージのカスタマイズ方法
フォームリクエストを利用して高度なバリデーションカスタマイズを行う方法

ケケンタ

Webアプリを開発するならバリデーション実装は必須です！
この記事が少しでもお役に立てば何よりです。

Web技術への理解を深め、Webアプリ開発者を目指したい方へ

「プロになるためのWeb技術入門」 ――なぜ、あなたはWebシステムを開発できないのか／小森裕介 (著)

by Amazon

プロになるためのWeb技術入門なぜ，あなたはWebシステムを開発できないのか [ 小森裕介 ]

created by Rinker

バリデーションとは？

まずは「そもそもバリデーションとは何か？」、　「その役割とは？」についてお伝えします。

バリデーションとは？

バリデーションとは、簡単にいうとユーザの入力値が意図した値になっているかどうかを検証することです。

そんなバリデーションの具体的な役割は以下の通りです。

バリデーションの役割

ユーザの入力値を制御することでWebアプリにおけるデータの整合性を保つ
悪意あるユーザからのセキュリティ攻撃を予防する

バリデーションを実装することでWebアプリを安全に稼働できます。

逆にいえば、バリデーションを実装しないと、悪意あるユーザによるセキュリティ攻撃を素通りさせることになり、重要情報の漏洩などの被害が発生する危険性が高まります。

【基本】バリデーションの実装方法

本章よりLaravelバージョン11でバリデーションを実装する方法を解説します。

バリデーションの実装方法を解説する上で、入力フォームやそこからの値を受け取りデータベースへ保存する処理などがあると話が進めやすいため、この記事では以下の例を元に解説をします。

この記事で扱うWebアプリと処理の例

TODOアプリ
タスクの登録処理

ケケンタ

上記の例にそって、以下よりルーティングやコントローラーなどのソースコードをご紹介していきます！

ルーティング

// タスク登録ページを表示するルーティング
Route::get('/tasks/create', [TasksController::class, 'create'])->name('tasks.create');

// タスク登録処理を実行するルーティング
Route::post('/tasks/create', [TasksController::class, 'store']);

バリデーションルールの設定

/*
 * タスク登録ページ（create.blade.php）を表示
 */
public function create()
{
    return view('tasks.create');
}

/*
 * タスク登録処理
 */
public function store(Request $request, Task $task)
{
    // バリデーションルール（★）
    $validated = $request->validate([
        'title' => 'required|max:50',
    ]);

    // タスク登録処理
    $task->title = $request->title;
    $task->save();

    return redirect()->route('tasks.index');  // タスク一覧ページへリダイレクト（※本記事ではページファイル省略）
}

上記の例では、titleに以下２つのバリデーションルールを適用しています。

上記のソースコードで適用しているバリデーションルール

required（入力必須）
max:50（50文字まで入力許可）

このように、Laravel11ではデータベースへの保存処理の前にバリデーションルールを記述することで、そのデータに対して簡単にバリデーションを実装することが可能です。

バリデーションエラーが発生した際に出力するエラーメッセージについては次節で解説します。

【日本語ドキュメント】https://readouble.com/laravel/11.x/ja/validation.html
参照項目：「使用可能なバリデーションルール」

エラーメッセージの出力

続いて、バリデーションによって入力エラーが発生したときに出力するエラーメッセージについて解説します。

Laravel11ではバリデーションのエラーメッセージ用ファイルがデフォルトで用意されていません。
そのため、エラーメッセージを正常に出力させるためには、後述するエラー内容をカスタマイズするの解説内容もあわせて対応する必要があります。

エラーメッセージの出力方法は大きく２つあります。

バリデーションのエラーメッセージを出力する「２つ」の方法

エラーメッセージを項目ごとにひとつずつ出力する
複数項目のエラーメッセージを一か所にまとめて出力する

方法①　エラーメッセージを項目ごとにひとつずつ出力する

<form action="{{ route('tasks.create') }}" method="post">
    @csrf
    <p>
        @error('title')
            <div class="alert alert-danger">{{ $message }}</div>
        @enderror
        <label for="title">タイトル</label>
        <input type="text" name="title" value="{{ old('title') }}">
    </p>
    <input type="submit" value="登録">
</form>

@error('DB上のカラム名')を使用することで、該当項目のバリデーションエラーが発生したときにエラーメッセージを出力することが可能です。

また、value属性にold('DB上のカラム名')のように記述しておくことで、エラー発生時に入力されていた値がフォームに保持されるようになります。
※old('DB上のカラム名')が無いとエラーが発生する度に入力内容が消えてしまい、再入力の手間が増えます。

方法②　複複数項目のエラーメッセージを一か所に出力する

@if ($errors->any())
    <div class="alert alert-danger">
        <ul>
            @foreach ($errors->all() as $error)
                <li>{{ $error }}</li>
            @endforeach
        </ul>
    </div>
@endif
<form action="{{ route('tasks.create') }}" method="post">
    @csrf
    <p>
        <label for="title">タイトル</label>
        <input type="text" name="title" value="{{ old('title') }}">
    </p>
    <input type="submit" value="登録">
</form>

@if ($errors->any())でエラーメッセージの有無をチェックしています。
もしバージョンエラーがあれば、@foreach ($errors->all() as $error)でループを回して、エラーメッセージをひとつずつ出力します。

また、value属性にold('DB上のカラム名')のように記述しておくことで、エラー発生時に入力されていた値がフォームに保持されるようになります。
※old('DB上のカラム名')が無いとエラーが発生する度に入力内容が消えてしまい、再入力の手間が増えます。

このように、バリデーションエラーによるエラーメッセージの出力方法は大きく２つあります。

ケケンタ

ただ、エラーが発生した項目ごとにエラーメッセージを出力した方が、ユーザにとっても分かりやすいと思うので、個人的には①の方法を使用する機会が多いのではないかと思っています。

エラー内容をカスタマイズする

バージョンによりますが、前述したようにLaravel11ではデフォルトだとバリデーションのエラーメッセージ用のファイルが用意されていません。

本章では、そのファイルの用意方法を含め、エラーメッセージ・項目名のカスタマイズ方法を解説します。

STEP１　日本語向けのバリデーション用ファイルを用意する

php artisan lang:publish

上記のコマンドを実行すると、プロジェクトディレクトリ直下にlang/enディレクトリが生成されます。

このをenをlang直下で複製し、そのディレクトリ名をjaとします。

このja内のvalidation.phpを編集することで、エラーメッセージを日本語対応させることが可能です。

STEP２　エラーメッセージのカスタマイズ

エラーメッセージをカスタマイズするときは、ja内のvalidation.phpを編集するとお伝えしました。

例えば、requiredルールによるエラーメッセージを編集するときは以下のようにします。

// 変更前
'required' => 'The :attribute field is required.',

// 変更後
'required' => ':attribute は必須です。',

:attributeの部分には、エラーが発生した項目名が自動設定されます。

STEP３　項目名のカスタマイズ

エラーメッセージ上の項目名は、デフォルトだとデータベースで使用しているカラム名になります。

しかし、それでは「titleは必須です」のようなメッセージとなり、ユーザにとって分かりづらい内容になってしまいます。

ケケンタ

そこで、本節では項目名のカスタマイズ方法をご紹介します！

validation.phpの下の方にあるattributesへ、以下のように

「キー名（DB上のカラム名） => ‘任意の項目名’」と記述することで項目名を簡単にカスタマイズできます。

'attributes' => [
    'title' => 'タイトル',
],

以上のように「バリデーション用ファイル」を用意することで、エラーメッセージが正常に出力されるようになります。

ケケンタ

カスタマイズも簡単にできますね！

高度なバリデーションの実装方法

Laravelにはフォームリクエストという、より複雑なバリデーションを実装できるクラスが用意されています。

より複雑なバリデーションシナリオの場合は、「フォームリクエスト」を作成することをお勧めします。フォームリクエストは、独自のバリデーションおよび認可ロジックをカプセル化するカスタムリクエストクラスです。フォームリクエストクラスを作成するには、make:request Artisan CLIコマンドを使用します。

引用元：Laravel11日本語ドキュメント（https://readouble.com/laravel/11.x/ja/validation.html）

基本的なバリデーション実装では、コントローラーの登録処理メソッド内にバリデーションルールを記載していました。

フォームリクエストを利用することで、バリデーション関係の処理をコントローラーから切り離し、なおかつ複雑なバリデーションの実装が可能になります。

ケケンタ

以下よりフォームリクエストを利用してバリデーションを実装する手順を解説します！

STEP１　フォームリクエストの作成

以下のコマンドを実行することでフォームリクエストファイルが作成されます。

php artisan make:request 任意のフォームリクエストファイル名

実行例

php artisan make:request StoreTaskRequest

STEP２　フォームリクエストファイルの編集

class StoreTaskRequest extends FormRequest
{
    /*
     * リクエストの認証制御
     * ※このメソッドをカスタマイズすることでリクエストの認証範囲を変更できますが、
     * 　当記事では割愛します。
     */
    public function authorize(): bool
    {
        return true; // falseをtrueへ変更（★）
    }

    /*
     * バリデーションルール
     */
    public function rules(): array
    {
        return [
            'title' => 'required|max:50',
        ];
    }

    /*
     * バリデーションメッセージのカスタマイズ
     * （★）手動で追加
     */
    public function messages(): array
    {
        return [
            'title.required' => ':attribute の入力は必須です。',
        ];
    }
}

ポイントを解説します。

authorize()

authorize()はリクエストの認証を制御するためのメソッドです。

デフォルトではfalseが返るようになっていますが、このままの状態だと403エラーが発生するため、ここをtrueへ変更してすべてのリクエストが認証されるようにします。

この記事では省略しますが、authorize()をカスタマイズすることでより正確な認証範囲の制御が可能になります。

rules()

rules()にはバリデーションルールを記載します。

【日本語ドキュメント】https://readouble.com/laravel/11.x/ja/validation.html
参照項目：「使用可能なバリデーションルール」

messages()

messages()はバリデーションエラーが発生した際のエラーメッセージをカスタマイズするためのメソッドです。

このメソッドを利用することで、前項「エラー内容をカスタマイズする」でご紹介したvalidation.phpを使わなくてもエラーメッセージを個別にカスタマイズすることが可能です。

フォームリクエストを作成した時点では用意されていないため、手動で追加する必要があります。

メソッド名は「messages」とする必要がある点にご留意ください。

STEP３　コントローラーの編集

フォームリクエストファイルでバリデーションを実装したため、コントローラーにはバリデーション関係の処理を書く必要が無くなります。

/*
 * タスク登録処理
 */
// public function store(Request $request, Task $task)　　　　 // 変更前
public function store(StoreTaskRequest $request, Task $task)  // 変更後
{
    // バリデーションルール（★削除）
    // $validated = $request->validate([
    //     'title' => 'required|max:50',
    // ]);

    $task->title = $request->title;
    $task->save();

    return redirect()->route('tasks.index');
}

ひとつ注意点として、メソッドの引数にあるRequest型を、紐づけたいフォームリクエストの型に書き換える必要があります。

今回の例ではStoreTaskRequest型に書き換えています。

ケケンタ

このように、フォームリクエストを使用すればコントローラーからバリデーション処理を切り離すことができ、かつより細かな制御をすることができるようになります。