#16 Spring バリデーションのエラーメッセージの変更

今回はバリデーションにより発生するエラーメッセージを自分で作成したエラーメッセージに変更していきます。

前提条件

この記事はSpringの最低限の知識が必要になります。
また、なるべく分かりやすく書くつもりですが、この記事の目的は自分の勉強のアウトプットであるため、所々説明は省略します。

前回まで

Formクラスにバリデーション用のアノテーションを付与し、バリデーションによる入力チェックを行いました。

構築環境

各バージョン
Spring Boot ver 2.7.5
jquery ver 3.6.1
bootstrap ver 5.2.2
webjars-locator ver 0.46
依存関係

成果物

今回行うこと

今回は以下の流れに沿って進めていきます。

SignupForm.javaの内容を変更
ValidationMessages.propertiesにエラーメッセージ内容を追加
messages.propertiesの内容を変更
注意事項

1. SignupForm.javaの内容を変更

アノテーションの内容を変更しました。

SignupForm.java


// 省略

@Data
public class SignupForm {
	
	@NotBlank
	@Email
	private String userId;
	
	private Integer phoneNumber;
	
	private Integer postal1;

	private Integer postal2;
	
	private String address;
	
	@NotBlank
	private String userName;
	
	@NotBlank
	@Pattern(regexp="^(?=.*[A-Z])[a-zA-Z0-9_]+$") // 少なくとも大文字が1つ含まれる
	@Length(min=8, max=24)
	private String password;
	
	@DateTimeFormat(iso=DateTimeFormat.ISO.DATE)
	@Past // 過去の日付
	private Date birthday1;
	
	@DateTimeFormat(pattern="yyyy/MM/dd")
	private Date birthday2;
	
	@Min(5)
	@Max(100)
	private Integer age;
	
	private MultipartFile accountIcon;
	
	private Integer gender;
}

2. ValidationMessages.propertiesにエラーメッセージ内容を追加

以前作成したValidationMessages.propertiesに追加でエラーメッセージを記述します。
今回は記述を省略しますが、ValidationMessages_en.propertiesも同様に行います。

ValidationMessages.properties

# ========================
# バインドエラーメッセージ
# ========================

# パターン1
typeMismatch.signupForm.age=数値を入力してください
typeMismatch.signupForm.birthday2=yyyy/MM/dd形式で入力してください

# 省略

# ========================
# バリデーションエラーメッセージ
# ========================

NotBlank={0}は入力必須です
EMail={0}はメールアドレス形式で入力してください
Pattern={0}は1文字以上大文字を含む半角英数字で入力してください
Length={0}は{2}文字以上{1}文字以下の範囲で入力してください
Max={0}は{1}歳以下でなければなりません
Min={0}は{1}歳以上で無ければなりません

=の左側にSignupForm.javaで使用したバリデーション用のアノテーションを記述します。
=の右側にはエラーメッセージの内容を記述します。
{0}にはフィールド名が入ります。

例えば、下記のように設定されている項目userIdの入力フォームに何も入力しなかった場合、{0}=userIdとなるエラーメッセージが出力されます。

SignupForm.java

	@NotBlank
	@Email
	private String userId;

また、{0}以降の数字には、そのアノテーション内で設定した属性値を入れることができます。
例えば、@Length(min=8, max=24)のアノテーションが付与されていた場合、{1}=24(max)、{2}=8(min)となります。
Length={0}は{2}文字以上{1}文字以下の範囲で入力してくださいのようなエラーメッセージを記述した場合、チェックに引っかかると以下の画像のようになります。

{1}、{2}などの順番は属性名の 名前の順(昇順) で決定されます。
今回の場合、minとmaxではmaxの方が早いので{1}はmaになります。

3. messages.propertiesの内容を変更

現状のエラーメッセージはフィールド名がそのまま表示されてしまっています。

messages.propertiesで記述した内容をSignupFormに記述した項目名と一致するよう変更します。

messages.properties

# 共通部分
login = ログイン
userId = ユーザーID
password = パスワード

# ログイン画面
toSignup = 新規登録はこちらから

# 新規登録画面
usreRegistration = ユーザー登録
phoneNumber = 電話番号
postalNumber = 郵便番号
address = 住所
userName = ユーザー名
birthday = 誕生日
age = 年齢
accountIcon = アカウントアイコン(任意)
gender = 性別
male = 男性
female = 女性

変更する部分はバリデーション用のアノテーションを付与している項目だけで良いのですが見栄えの良さを取って上記のようにしました。
また、今回は記述を省略していますが、画面上(signup.html、login.html)で関連する部分も編集してあります。

messages.propertiesとFormクラスの項目名は一致させた方が良い

以上の編集を行うと、下記のようにエラーメッセージがmessages.propertiesで記述した項目名として出力されます。

4. 注意事項

messages.propertiesにバリデーション用のアノテーションを記述するときに注意することがあります。
例えばユーザーIDとパスワード両方に@patternアノテーションを付与した際に、同じアノテーションでもその内容は違うことがあります。

SignupForm.java

	@NotBlank(groups = ValidGroup1.class)
	@Pattern(regexp="^[a-zA-Z0-9_]+$", groups = ValidGroup2.class) // 半角英数字(大文字を含める必要はない)
	private String userName;
	
	@NotBlank(groups = ValidGroup1.class)
	@Pattern(regexp="^(?=.*[A-Z])[a-zA-Z0-9_]+$", groups = ValidGroup2.class) // 少なくとも大文字が1つ含まれる
	@Length(min=8, max=24 , groups = ValidGroup2.class)
	private String password;

ValidationMessages.properties

Pattern={0}は1文字以上大文字を含む半角英数字で入力してください

以下の画像のようにValidationMessages.propertiesで登録したメッセージが出てきてしまいます。

よって、同じアノテーションでも内容の違いから違うメッセージを表示させたい場合、個別にメッセージを登録してあげる必要があります。

その場合、messages.propertiesの@Patternを削除して以下のようにするのが良いと思います。

SignupForm.java

	@NotBlank(groups = ValidGroup1.class)
	@Pattern(regexp="^[a-zA-Z0-9_]+$", message="{0}は半角英数字で入力してください") // 半角英数字(大文字を含める必要はない)
	private String userName;
	
	@NotBlank(groups = ValidGroup1.class)
	@Pattern(regexp="^(?=.*[A-Z])[a-zA-Z0-9_]+$", message="{0}は1文字以上大文字を含む半角英数字で入力してください") // 少なくとも大文字が1つ含まれる
	@Length(min=8, max=24 , groups = ValidGroup2.class)
	private String password;

最後に

以上で、エラーメッセージの変更は完了しました。
しかし、パスワードの項目を見るとエラーメッセージが複数出力されています。入力欄が空白の場合、パスワードは入力必須です以外のエラーメッセージは出力する必要はありません。
次回は、エラーメッセージの出力順を変更していきたいと思います。