タイトル: メッセージ式
SEOタイトル: Thymeleaf メッセージ式と国際化 (i18n) 完全ガイド
| この記事の要点 |
|
メッセージ式とは
Thymeleaf の #{...} は、テンプレート内に直接文字列を書くのではなく、外部のプロパティファイルから読み込む仕組みです。これにより (1) 多言語対応 (i18n)、(2) 翻訳作業をデザイナと分業、(3) 文言変更時にテンプレート再ビルド不要といった利点があります。
最小サンプル
1. messages.properties (デフォルト)
# src/main/resources/messages.properties
home.title=ホーム
home.welcome=ようこそ
home.button.login=ログイン
home.button.signup=新規登録
article.title=記事タイトル
article.body=本文
article.created_at=作成日時
error.required={0} は必須です
error.minLength={0} は {1} 文字以上で入力してください
2. テンプレート
ホーム
ようこそ
多言語対応 (i18n)
ファイル命名規約
| ファイル名 | 適用条件 |
|---|---|
messages.properties | デフォルト (どのロケールにも該当しない時) |
messages_ja.properties | 日本語 |
messages_en.properties | 英語 |
messages_en_US.properties | アメリカ英語 |
messages_zh_CN.properties | 簡体字中国語 |
サンプル
# messages_ja.properties
home.title=ホーム
home.welcome=ようこそ
home.button.login=ログイン
# messages_en.properties
home.title=Home
home.welcome=Welcome
home.button.login=Login
# messages_zh_CN.properties
home.title=主页
home.welcome=欢迎
home.button.login=登录
application.properties
# 既定で messages という basename を読みます。明示も可
spring.messages.basename=messages
# 複数の basename を読む場合
# spring.messages.basename=messages,errors,validation
spring.messages.encoding=UTF-8
spring.messages.fallback-to-system-locale=false
spring.messages.use-code-as-default-message=true
ロケール切替の方法
Spring MVC はロケール解決を 3 つの方法で行えます:
// 1. URL パラメータ ?lang=en で切替
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Bean
public LocaleResolver localeResolver() {
SessionLocaleResolver resolver = new SessionLocaleResolver();
resolver.setDefaultLocale(Locale.JAPANESE);
return resolver;
}
@Bean
public LocaleChangeInterceptor localeChangeInterceptor() {
LocaleChangeInterceptor interceptor = new LocaleChangeInterceptor();
interceptor.setParamName("lang"); // ?lang=en
return interceptor;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(localeChangeInterceptor());
}
}
// 2. Accept-Language HTTP ヘッダ
// AcceptHeaderLocaleResolver (Spring Boot のデフォルト)
// 3. クッキー
// CookieLocaleResolver
引数つきメッセージ
# messages.properties
greeting=こんにちは {0} さん、{1} 件の通知があります
error.required={0} は必須項目です
error.range={0} は {1} 以上 {2} 以下で入力してください
こんにちは ゲスト さん
必須エラー
範囲エラー
属性へのメッセージ展開
Welcome, taro!
テキスト中に直接埋め込み
[[#{home.welcome}]] さん
通知あり
Controller で MessageSource を直接使う
@RestController
public class ApiController {
private final MessageSource messageSource;
public ApiController(MessageSource messageSource) {
this.messageSource = messageSource;
}
@GetMapping("/api/hello")
public String hello(Locale locale) {
return messageSource.getMessage("home.welcome", null, locale);
}
@GetMapping("/api/error")
public String error(Locale locale) {
return messageSource.getMessage(
"error.required",
new Object[]{"メールアドレス"},
locale
);
}
}
UTF-8 設定 (文字化け対策)
古い Spring では messages_ja.properties を Unicode エスケープ (こん...) する必要がありました。Spring Boot 1.4+ では UTF-8 がデフォルトですが、明示推奨:
# application.properties
spring.messages.encoding=UTF-8
spring.thymeleaf.encoding=UTF-8
server.servlet.encoding.charset=UTF-8
server.servlet.encoding.enabled=true
server.servlet.encoding.force=true
FAQ
Q: ??home.welcome_ja_JP?? と表示される
A: メッセージキー未定義。messages.properties に定義漏れか、basename 設定ミス。
Q: HTML タグを含むメッセージを出したい
A: th:utext="#{key}" でエスケープ無効化。XSS 注意。
Q: 改行をメッセージに入れたい
A: properties に \n と書き、テンプレートで style="white-space:pre-line" で改行を表示。