先生と生徒の会話形式で理解しよう

生徒

「Play Frameworkでフォームを作ったんですが、変な値を入力されてもそのまま処理されてしまいます。」

先生

「それは入力値の検証、つまりバリデーションをまだ設定していないからですね。」

生徒

「バリデーションって、入力チェックのことですよね？難しそうで不安です。」

先生

「基本の考え方はとても単純です。Play Frameworkでは、初心者でも扱いやすい仕組みが用意されています。」

1. バリデーションとは何をする仕組みか

Play Frameworkにおけるバリデーションとは、フォームから送信された入力値が正しいかどうかを確認する仕組みです。入力必須なのに空欄だったり、文字数が足りなかったりする場合に、処理を止めて利用者に知らせます。

入力値の検証を行わないと、想定外のデータが登録され、画面表示の崩れやエラーの原因になります。安全で使いやすいWebアプリケーションを作るために、バリデーションは欠かせない基本要素です。

2. なぜ入力値の検証が必要なのか

利用者は必ずしも正しい値を入力してくれるとは限りません。うっかり未入力のまま送信したり、意図しない文字を入力したりすることは日常的に起こります。

バリデーションは、こうした入力ミスを防ぎ、利用者にやさしい画面を作るための仕組みです。また、アプリケーション内部のデータを守る役割も担っています。

3. Play Frameworkでのバリデーションの考え方

Play Frameworkでは、フォーム用クラスにルールを書くだけで、入力値の検証を行えます。複雑な条件分岐を書く必要はありません。

どの項目が必須か、どのくらいの長さが必要かといったルールを、あらかじめクラスに設定しておくことで、自動的にチェックが行われます。

4. 必須入力をチェックする基本的な方法

まずは最も基本となる必須入力のバリデーションを見てみましょう。名前が必ず入力されていなければならない場合、次のように設定します。


package forms;

import javax.validation.constraints.NotBlank;

public class UserForm {

    @NotBlank
    public String name;

    public String comment;
}

この設定により、名前が空欄のまま送信されると、エラーとして扱われます。特別な処理を書かなくても、Play Frameworkが自動で検証してくれます。

5. 文字数を制限するバリデーション

入力できる文字数を制限することも、よく使われるバリデーションです。長すぎる文章を防ぐことで、画面やデータの整合性を保てます。


import javax.validation.constraints.Size;

public class MessageForm {

    @Size(min = 1, max = 100)
    public String message;
}

この例では、メッセージは一文字以上百文字以内でなければなりません。条件に合わない場合、自動的にエラーになります。

6. コントローラでのバリデーション結果の扱い方

バリデーションの結果は、コントローラで確認できます。エラーがある場合と、正しい場合で処理を分けるのが基本です。


public Result submit(Http.Request request) {
    Form<UserForm> form = formFactory.form(UserForm.class).bindFromRequest(request);

    if (form.hasErrors()) {
        return badRequest("入力内容にエラーがあります");
    }

    UserForm user = form.get();
    return ok("送信完了：" + user.name);
}

このように、エラーがあるかどうかを確認するだけで、入力チェックが完了します。