@NotNullや@Sizeなどの基本バリデーションアノテーションを初心者向けにわかりやすく解説！

新人と先輩の会話形式で理解しよう

新人

「バリデーションアノテーションって具体的にどんなものなんですか？」

先輩

「バリデーションアノテーションとは、Javaのクラスのフィールドに付ける注釈で、入力値のチェックルールを簡単に指定できる仕組みです。Spring MVCと組み合わせて使うことが多いですよ。」

新人

「@NotNullや@Sizeってどんな役割があるんですか？」

先輩

「@NotNullは値がnullであってはいけないことを示し、必須入力のチェックに使います。@Sizeは文字列や配列の長さの範囲を指定して、長すぎたり短すぎたりしないかをチェックします。」

1. バリデーションアノテーションとは何か？基本的な説明

バリデーションアノテーションは、JavaのBean Validation仕様で定義されている注釈です。これらをクラスのフィールドに付けることで、そのフィールドに対する入力チェックを簡単に設定できます。Spring MVCのフォームバリデーションでよく使われ、コードの見た目がすっきりし、メンテナンスもしやすくなります。

例えば、ユーザー登録フォームの名前やメールアドレスの入力チェックなどに活用されます。

2. @NotNullや@Sizeの役割と基本的な使い方

@NotNullは、そのフィールドがnullであってはいけない、つまり必ず値が入っている必要があることを示します。必須入力のチェックに使われることが多いです。

@Sizeは文字列やコレクションの長さを制限するアノテーションで、最小値と最大値を指定できます。例えばパスワードの長さが6文字以上20文字以下であることをチェックしたい場合に使います。

具体例を示します。


import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class UserForm {

    @NotNull(message = "名前は必須です")
    @Size(min = 1, max = 50, message = "名前は1文字以上50文字以内で入力してください")
    private String name;

    @NotNull(message = "パスワードは必須です")
    @Size(min = 6, max = 20, message = "パスワードは6文字以上20文字以内で入力してください")
    private String password;

    // getter, setter
}

この例では、nameとpasswordのフィールドに対して、nullチェックと長さチェックのバリデーションを設定しています。メッセージはエラー時にユーザーに表示される内容です。

3. それぞれのアノテーションの使い分け方と注意点

バリデーションアノテーションには似たようなものが複数あり、用途によって使い分けが必要です。代表的なものとして、@NotNull、@NotEmpty、@NotBlankがあります。

@NotNull：値がnullであってはいけないことを示します。ただし、空文字や空のコレクションは許容します。
@NotEmpty：nullと空の文字列・コレクションを許容しません。空の文字列はエラーになります。
@NotBlank：null、空文字に加えて空白だけの文字列も許容しません。文字列専用です。

例えば、ユーザー名などの必須入力に対しては@NotBlankを使うのが一般的です。数字やリストなどの場合は@NotEmptyが適切です。@NotNullはnullチェックだけなので注意が必要です。

以下にそれぞれの使い方の例を示します。


import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

public class UserForm {

    @NotNull(message = "ユーザーIDは必須です")
    private Integer userId;

    @NotEmpty(message = "趣味リストは空にできません")
    private List<String> hobbies;

    @NotBlank(message = "ユーザー名は必須です")
    private String username;

    // getter, setter
}

このように、データ型や用途に応じてアノテーションを使い分けることで、より適切な入力チェックが可能になります。

4. よく使われる他のバリデーションアノテーション紹介（@NotEmpty、@Emailなど）

バリデーションアノテーションは多岐に渡りますが、初心者がよく使うものを紹介します。

@Email：メールアドレスの形式をチェックします。正しいメール形式であるかを自動で検証。
@Pattern：正規表現によるパターンマッチを行います。電話番号や郵便番号など特定の形式のチェックに便利。
@Min、@Max：数値の最小値・最大値のチェック。
@Past、@Future：日付が過去・未来であることをチェック。

例として、メールアドレスと電話番号のチェックを含むフォームクラスを示します。


import javax.validation.constraints.Email;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.NotEmpty;

public class ContactForm {

    @NotEmpty(message = "メールアドレスは必須です")
    @Email(message = "正しいメールアドレスの形式で入力してください")
    private String email;

    @Pattern(regexp = "^\\d{10,11}$", message = "電話番号は10桁か11桁の数字で入力してください")
    private String phoneNumber;

    // getter, setter
}

この例では、@Emailでメール形式の自動チェック、@Patternで電話番号が10桁か11桁の数字であることを検証しています。@Patternは正規表現を使うため強力ですが、正規表現の書き方に注意が必要です。

これらのバリデーションアノテーションを組み合わせることで、入力ミスを減らし、ユーザーにわかりやすいエラーを返すことができます。Spring MVCと連携させて、効率的にフォーム入力チェックを実装しましょう。

5. バリデーションアノテーションの実践的な利用例（Controllerやフォームとの連携）

Spring MVCでは、バリデーションアノテーションを付けたフォームオブジェクトと連携し、フォーム入力チェックを実装します。Controllerで@Validアノテーションを付けることで、フォーム送信時に自動的にバリデーションが実行されます。

バリデーションエラーはBindingResultで受け取り、エラーがあれば再度フォーム画面に戻してユーザーに修正を促します。

以下に簡単なControllerの例を示します。


@Controller
public class UserController {

    @GetMapping("/register")
    public String showForm(Model model) {
        model.addAttribute("userForm", new UserForm());
        return "registerForm";
    }

    @PostMapping("/register")
    public String submitForm(@Valid @ModelAttribute UserForm userForm, BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            // 入力エラーがある場合、フォームに戻す
            return "registerForm";
        }
        // 正常処理（例：ユーザー登録）
        return "registerSuccess";
    }
}

また、Thymeleafのテンプレート側では、th:fieldでフォームの入力値とバリデーション結果を結びつけます。エラーメッセージはth:errorsを使って表示可能です。

以下は名前入力欄の例です。


<form th:action="@{/register}" th:object="${userForm}" method="post">
  <label for="name">名前：</label>
  <input type="text" id="name" th:field="*{name}" />
  <div th:if="${#fields.hasErrors('name')}" th:errors="*{name}" class="text-danger"></div>
  <button type="submit">登録</button>
</form>

このように、ControllerとThymeleafを連携させてバリデーション実装を行うことで、ユーザーに分かりやすいエラーメッセージを表示できます。