Springのエラーメッセージを国際化！ValidationMessages.propertiesの書き方を初心者向けに解説

1. Springのバリデーションと国際化

" onerror="this.onerror=null; this.src='/img/view/java-exception-introduce.jpg';">

1. Springのバリデーションと国際化

Spring Frameworkでは、@Validや@Validatedアノテーションを使って、フォームの入力チェック（バリデーション）を行うことができます。デフォルトでは、エラーメッセージは英語で表示されますが、多言語対応（i18n）を行うことで、日本語など他言語で表示することが可能です。

このエラーメッセージの切り替えを実現するのが、ValidationMessages.propertiesファイルです。ファイル名に「_ja」などを付けることで、日本語への対応もできます。

2. ValidationMessages.propertiesファイルの役割と配置場所

2. ValidationMessages.propertiesファイルの役割と配置場所

ValidationMessages.propertiesは、バリデーションエラーメッセージをカスタマイズし、多言語対応を可能にするためのプロパティファイルです。一般的には以下の場所に配置します。

src/main/resources/ValidationMessages.properties
src/main/resources/ValidationMessages_ja.properties

Spring Bootでは、自動的にこのファイルを読み込んでくれます。エラーメッセージのキーと値を定義することで、各バリデーションルールに対応したメッセージが表示されるようになります。

3. ValidationMessages.propertiesの書き方と例

3. ValidationMessages.propertiesの書き方と例

それでは実際に、ValidationMessages.propertiesに記述する具体的な内容を見てみましょう。ここでは、@NotBlankや@Sizeなどに対応するエラーメッセージを定義します。

NotBlank.userForm.name=名前は必須項目です。
Size.userForm.name=名前は2文字以上30文字以下で入力してください。

ここでのポイントは、NotBlank.クラス名.フィールド名の形式で書くことで、特定のフィールドに対するカスタムエラーメッセージを指定できる点です。

4. 日本語ファイルを追加する方法（ValidationMessages_ja.properties）

4. 日本語ファイルを追加する方法（ValidationMessages_ja.properties）

日本語のエラーメッセージを表示させたい場合は、ValidationMessages_ja.propertiesというファイルを作成し、以下のように書きます。

NotBlank.userForm.email=メールアドレスは必須です。
Email.userForm.email=正しい形式のメールアドレスを入力してください。

このように記述することで、日本語ロケールが適用されている環境では、自動的にこのファイルが使われるようになります。

5. application.propertiesでの設定（省略可能）

5. application.propertiesでの設定（省略可能）

Spring Bootでは、デフォルトでValidationMessages.propertiesが読み込まれますが、念のため明示的に設定したい場合はapplication.propertiesに以下のように追記します。

spring.messages.basename=ValidationMessages

この設定によって、SpringはValidationMessages.propertiesやValidationMessages_ja.propertiesを自動的に選択してくれます。

6. バリデーション対象のクラスとアノテーションの例

6. バリデーション対象のクラスとアノテーションの例

ここでは、バリデーション対象となるJavaのフォームクラスを例として示します。

import jakarta.validation.constraints.*;

public class UserForm {

    @NotBlank(message = "{NotBlank.userForm.name}")
    @Size(min = 2, max = 30, message = "{Size.userForm.name}")
    private String name;

    @NotBlank(message = "{NotBlank.userForm.email}")
    @Email(message = "{Email.userForm.email}")
    private String email;

    // Getter, Setterなど
}

アノテーションのmessage属性にキー名を記述することで、プロパティファイルから対応するエラーメッセージが読み込まれます。

7. ロケールの切り替え方法とLocaleResolverの設定

7. ロケールの切り替え方法とLocaleResolverの設定

アプリケーションで言語を切り替えたい場合は、LocaleResolverを定義することで対応可能です。

@Bean
public LocaleResolver localeResolver() {
    SessionLocaleResolver slr = new SessionLocaleResolver();
    slr.setDefaultLocale(Locale.JAPAN);
    return slr;
}

これにより、ブラウザやセッションに応じて自動的に日本語ロケールが適用され、ValidationMessages_ja.propertiesの内容が表示されます。

8. よくある間違いと注意点

8. よくある間違いと注意点

• プロパティファイルのキーが間違っていると、デフォルトの英語メッセージが表示される
• ファイルの文字コードはUTF-8で保存する（特に日本語対応時）
• プロパティファイルはresourcesディレクトリ直下に配置する

これらのポイントを押さえておけば、Springでのバリデーションエラーメッセージの国際化はスムーズに行えます。

9. HTMLの表示側の工夫でさらにわかりやすく

9. HTMLの表示側の工夫でさらにわかりやすく

最後に、HTML側でのエラーメッセージの表示方法も簡単に紹介しておきます。以下はThymeleafを使った例です。

<form th:action="@{/submit}" th:object="${userForm}" method="post">
    <input type="text" th:field="*{name}" />
    <div class="text-danger" th:if="${#fields.hasErrors('name')}" th:errors="*{name}">名前のエラー</div>
    <button type="submit">送信</button>
</form>

このようにすることで、バリデーションの結果に応じて、適切なエラーメッセージを画面に表示することができます。