Springの型変換とフォーマットを徹底解説！Converter／Formatterと@InitBinderの基本

型変換とフォーマット：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でリクエスト処理やバリデーションの過程で呼び出されるため、型変換を一元的に制御できます。

将来を見据えて、＋αのスキルを身につけたい方へ

JavaやLinuxを学んでいても、「このままで市場価値は上がるのか」「キャリアの選択肢を広げたい」と感じる方は少なくありません。

AIを学ぶならアイデミープレミアム

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";
}