【Spring Boot】入力チェックのバリデーションメッセージを任意に変更する方法

この記事では、メッセージファイルを使って、エラーメッセージの内容を任意の文言にする方法を解説します。

プロジェクトの作成
用意するソース
実行結果

目次へ

プロジェクトの作成

VSCodeでSpringBootのMavenプロジェクトを作成します。
手順は以下の記事を参照。

2021年11月28日【Windows版】VSCodeで始めるSpringBoot(Mavenプロジェクト編)

プロジェクト作成時、以下の5つの依存関係を選択します。5個目のvalidationを選択しておかないと入力チェックができないので注意してください。

Spring Boot DevTools
Spring Web
Thymeleaf
Lombok
validation

用意するソース

SpringBootで新規プロジェクトを作成したら、以下のソースを用意して実行できる状態にします。

コントローラー`(BaseController.java)`

com.example.demo3.controlloer直下に以下の内容でBaseController.javaを作成します。

BaseController.java

package com.example.demo3.controlloer;

import com.example.demo3.model.Person;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class BaseController{

    @GetMapping("/")
    public String home(@ModelAttribute Person person) {
      return "form";
    }

    @PostMapping("/form")
    public String result(@Validated
                        @ModelAttribute Person person,
                        BindingResult result){
        if(result.hasErrors()){
            return "form";
        }
        return "result";
    }
}

モデル`(Person.java)`

com.example.demo3.model直下に以下の内容でPerson.javaを作成します。

Person.java

package com.example.demo3.model;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

import javax.validation.constraints.Email;
import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import lombok.Data;

@Data
public class Person {

    /**
     * <p>項目名：名前</p>
     * <p>必須入力かつ、最大10文字まで</p>
     */
    @NotBlank
    @Size(max=10)
    private String name;

    /**
     * <p>項目名：年齢</p>
     * <p>1以上</p>
     */
    @NotNull
    @Min(1)
    @Max(120)
    private Integer age;

    /**
     * <p>項目名：職業</p>
     * <p>必須入力かつ、最大10文字まで</p>
     */
    @NotBlank
    @Size(max=10)
    private String business;

    /**
     * <p>項目名：メールアドレス</p>
     * <p>条件：必須入力かつ、最大64文字まで</p>
     */
    @NotBlank
    @Email
    @Size(max=64)
    private String email;
}

遷移元ページ`(form.html)`

resources\templates直下に以下の内容でform.htmlを作成します。

form.html

<!DOCTYPE html>
<html lang="ja" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        <title>form</title>
        <script type="text/javascript"></script>
        <style type="text/css">
            .errorStr {color:red;}
        </style>
    </head>
        <body>
            <form th:action="@{/form}" th:object="${person}" method="post" novalidate>
                <label for="name">名前：</label>
                <input type="text" th:field="*{name}">
                <span class="errorStr" th:errors="*{name}"></span>
                <br>

                <label for="age">年齢：</label>
                <input type="number" th:field="*{age}">
                <span class="errorStr" th:errors="*{age}"></span>
                <br>

                <label for="business">職業：</label>
                <input type="text" th:field="*{business}">
                <span class="errorStr" th:errors="*{business}"></span>
                <br>

                <label for="email">Eメール：</label>
                <input type="text" th:field="*{email}">
                <span class="errorStr" th:errors="*{email}"></span>
                <br>

                <button>送信</button>
            </form>
        </body>
</html>

メッセージプロパティ`(messages_ja.properties)`

resources\ms直下に以下の内容でmessages_ja.propertiesを作成します。

name = 名前
age = 年齢
business = 職業
email = Email

解説

validationMessages_ja.propertiesで定義している{0}の部分に上記の値が代入されるようになります。

エラーメッセージプロパティ`（validationMessages_ja.properties）`

resources\ms直下に以下の内容でvalidationMessages_ja.propertiesを作成します。

# 画面項目「名前」に対するエラーメッセージ
NotBlank.person.name={0}が空欄になっています。
Size.person.name={0}は{1}文字以内で入力してください。

# 画面項目「年齢」に対するエラーメッセージ
NotNull.person.age={0}が空欄になっています。
Min.person.age={0}は{1}以上の値を入力してください。
Max.person.age={0}は{1}以下の値を入力してください。


# 画面項目「email」に対するエラーメッセージ
NotBlank.person.email={0}が空欄になっています。
Size.person.email={0}は{1}文字以内で入力してください。
Email.person.email={0}がEmailの形式になっていません。

# 共通メッセージ（アノテーションメッセージ）
NotBlank={0}が正しくないようです。（=NotBlank）
NotNull={0}が正しくないようです。（=NotNull）
Size={0}が正しくないでようです。（=Size）

# 型変換エラー
typeMismatch.person.age = {0}は型変換に失敗しました。

設定ファイル`（application.properties）`

messages_ja.propertiesとvalidationMessages_ja.propertiesの格納先をapplication.propertiesに追記します。

spring.messages.basename=ms/messages,ms/validationMessages

実行結果

ブラウザでhttp://localhost:8080/にアクセスします。
すると以下の画面が表示されます。これは遷移元ページ(form.html)が表示されています。

何も入力せずに「送信」ボタンを押すと以下のようにエラーメッセージが表示されます。

解説

画面項目「名前」は未入力なのでNotBlank.person.name={0}が空欄になっています。が適用されます。

画面項目「年齢」も未入力なのでNotNull.person.age={0}が空欄になっています。が適用されます。

画面項目「職業」も未入力ですが、この項目に対する処理は記述していないのでNotBlank={0}が正しくないようです。（=NotBlank）が適用されます。

画面項目「email」は未入力なのでNotBlank.person.email={0}が空欄になっています。が適用されます。

以下は別のエラーメッセージを表示してみたパターンです。

解説

画面項目「名前」は10文字以上入力されているのでSize.person.name={0}は{1}文字以内で入力してください。が適用されます。

画面項目「年齢は」121と入力しているのでMax.person.age={0}は{1}以下の値を入力してください。が適用されます。

画面項目「Email」はEmailの形式としてふさわしくない入力をしているのでEmail.person.email={0}がEmailの形式になっていません。が適用されます。

validationMessages_ja.propertiesのtypeMismatch.person.age = {0}は型変換に失敗しました。を表示するには画面項目「年齢」に1.1などのように入力して「送信」ボタンを押します。

以上です。

以上で記事の解説はお終い！

もっとJavaやSpringを勉強したい方にはUdemyがオススメ！同僚に差をつけよう！

【Udemy厳選】2023年Javaで人気のオススメ動画コース6選

プロジェクトの作成

用意するソース

コントローラー(BaseController.java)

モデル(Person.java)

遷移元ページ(form.html)

メッセージプロパティ(messages_ja.properties)

エラーメッセージプロパティ（validationMessages_ja.properties）

設定ファイル（application.properties）