Springの型変換とフォーマットを徹底解説!Converter/Formatterと@InitBinderの基本
生徒
「Springで文字列を日付や数値に自動で変換するには、どうすればいいんですか?」
先生
「Spring MVCでは、ConverterやFormatter、そして@InitBinderを使って、リクエストパラメータを任意の型に変換したり、独自のフォーマットで扱ったりできますよ。」
生徒
「たとえば、日付を「yyyy/MM/dd」形式で扱いたい場合にも使えますか?」
先生
「もちろん可能です。それでは、型変換とフォーマットの基礎から具体的な実装方法まで、順を追って解説していきましょう。」
1. Springの型変換とは?
Springの型変換は、リクエストパラメータの文字列をオブジェクト型へ変換したり、逆にオブジェクトを文字列として出力する際に自動的に働く機能です。代表的な用途としては、文字列をDate型やEnum型、カスタムクラスへ変換したり、独自の表示フォーマットに整えるなどが挙げられます。
2. ConverterとFormatterの違い
ConverterとFormatterは似た役割を持ちますが、使い分けがあります:
- Converter: 型と型の変換(例:String → UserId)に使う
- Formatter: 表示用フォーマットが関わる型(例:DateやBigDecimalなど)に使う
どちらもSpring MVCでリクエスト処理やバリデーションの過程で呼び出されるため、型変換を一元的に制御できます。
3. Converterの実装方法
ここでは、文字列をID型(たとえばUserIdクラス)に変換するConverterの例を紹介します。
public class StringToUserIdConverter implements Converter<String, UserId> {
@Override
public UserId convert(String source) {
return new UserId(Long.parseLong(source));
}
}
これをWebMvcConfigurerに登録すれば、全コントローラーで有効になります。
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(new StringToUserIdConverter());
}
}
4. Formatterの実装方法
Formatterでは、入力された日付文字列をLocalDateなどに変換しつつ、表示形式も整えられます。
public class LocalDateFormatter implements Formatter<LocalDate> {
private final DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy/MM/dd");
@Override
public LocalDate parse(String text, Locale locale) {
return LocalDate.parse(text, formatter);
}
@Override
public String print(LocalDate object, Locale locale) {
return formatter.format(object);
}
}
こちらもWebConfigで登録します。
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addFormatter(new LocalDateFormatter());
}
}
5. @InitBinderで個別設定を行う
@InitBinderは、特定のコントローラーメソッドに限定してPropertyEditorやCustomDateEditorなどを登録する方法です。日付フォーマットを柔軟に制御したいときに便利です。
@Controller
public class SampleController {
@InitBinder
public void initBinder(WebDataBinder binder) {
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
sdf.setLenient(false);
binder.registerCustomEditor(Date.class, new CustomDateEditor(sdf, false));
}
@PostMapping("/submit")
public String submit(@RequestParam("date") Date date, Model model) {
model.addAttribute("date", date);
return "result";
}
}
6. HTMLでの入力例と注意点
日付や数値などを独自フォーマットで入力させる場合は、inputタグのtype属性を意識しながら、Formatterや@InitBinderと連携します。
<form th:action="@{/submit}" method="post">
<div class="mb-3">
<label for="date">日付(yyyy-MM-dd形式)</label>
<input type="text" name="date" class="form-control" placeholder="2025-09-04">
</div>
<button type="submit" class="btn btn-primary">送信</button>
</form>
このように、HTMLフォームとSpringの型変換/フォーマット機能は密接に関係しています。
7. 型変換エラーのハンドリング
不正なフォーマットの値が入力された場合は、BindingResultでエラーを受け取り、画面側でメッセージを表示できます。
@PostMapping("/submit")
public String submit(@Valid @ModelAttribute SampleForm form, BindingResult result, Model model) {
if (result.hasErrors()) {
return "form";
}
return "success";
}
8. 型変換とフォーマットの活用例
実務では以下のような場面で型変換とフォーマットの技術が活躍します:
- ユーザーの入力値を
BigDecimalに変換して金額計算 - 日付や時間を統一フォーマットで処理
- IDやコード値をクラスへ変換してバリューオブジェクト化
- 画面表示時に値を整形してわかりやすく見せる
このように、Spring MVCの型変換とフォーマットは、フォーム処理やバリデーションの基盤として重要な役割を果たします。
まとめ
今回はSpringの型変換とフォーマット機能について、ConverterとFormatterの違い、WebMvcConfigurerでの登録方法、そして@InitBinderによる個別設定までを体系的に解説しました。Spring MVCでは、リクエストパラメータは基本的に文字列として受け取られますが、実際の業務アプリケーションでは日付型や数値型、Enum型、さらには独自のバリューオブジェクトへと変換する必要があります。その役割を担うのが型変換とフォーマットの仕組みです。
Converterは型と型の変換に特化しており、例えばStringからUserIdのような独自クラスへの変換を安全に行えます。一方Formatterは、日付や金額など表示形式が重要な値を扱う際に活躍します。入力時の文字列解析と表示時のフォーマット整形を一つのクラスで管理できるため、コードの可読性と保守性が向上します。特にLocalDateやBigDecimalを扱う場面では、Formatterの導入によって統一されたフォーマット管理が可能になります。
また、@InitBinderを活用すれば、特定のコントローラーに限定した型変換ルールを定義できます。グローバル設定とローカル設定を使い分けることで、アプリケーション全体の一貫性を保ちながら柔軟な制御が実現できます。さらに、BindingResultと組み合わせることで、型変換エラーやフォーマット不一致を安全にハンドリングし、ユーザーへ分かりやすいエラーメッセージを表示できます。
Spring MVCにおける型変換とフォーマットの理解は、フォーム処理、バリデーション、データバインディング、モデル管理を一貫して設計するための基礎です。日付フォーマットの統一、金額入力の正確な処理、識別子のバリューオブジェクト化など、実務で頻出する要件を安全に実装できるようになります。これらの技術を理解することで、堅牢で保守性の高いWebアプリケーション開発が可能になります。
ConverterとFormatterの基本的な活用例
@Configuration
public class WebConfig implements WebMvcConfigurer {
@Override
public void addFormatters(FormatterRegistry registry) {
registry.addConverter(new StringToUserIdConverter());
registry.addFormatter(new LocalDateFormatter());
}
}
型変換とフォーマットが登録されました
このように設定することで、Spring MVC全体で統一された型変換ルールとフォーマット処理を適用できます。フォーム入力、REST API、テンプレート表示など、さまざまな場面で自動的に変換処理が実行されます。
生徒
「Springの型変換とフォーマットは、リクエストパラメータを自動でオブジェクトに変換する重要な仕組みだと分かりました。ConverterとFormatterの違いも理解できました。」
先生
「良い理解ですね。Converterは単純な型変換、Formatterは表示形式を含む変換に向いています。用途に応じて使い分けることが大切です。」
生徒
「@InitBinderを使えば、特定のコントローラーだけにフォーマットを適用できる点も実務で役立ちそうです。」
先生
「その通りです。グローバル設定と個別設定を理解することで、より柔軟な設計が可能になります。型変換エラーのハンドリングも忘れずに行いましょう。」
生徒
「フォーム入力やREST APIの実装でも活用できるので、これからは型変換とフォーマットを意識して設計してみます。」
先生
「それが大切です。Spring MVCの型変換機能を正しく理解すれば、安全で保守性の高いアプリケーション開発が実現できます。」