Kotlin 髙妻智一

Spring Boot | リクエストパラメータのyyyy-mm-dd形式の文字列をjava.util.Dateで受け取る方法




Javaの日付データの扱いはややこしい

Java初心者には日付データを扱うのが非常にわかりにくいですよね。自分は今でもDateの扱いは調べないとできません。。。まあ覚えないといけないくらい複雑って時点で言語的にダメな気がしてるんですけど。

util.Date、sqlDate、Timestamp、Calender、LocalDate、ZoneDate、OffsetDateなどなどJava初心者には理解不能。。。

リクエストからこれらの値をどう受け取るかも最初は謎すぎた。

リクエストパラメータから文字列の日付情報を受け取る

yyyy-MM-ddとかyyyy-mm-dd hh:MMl:ssといったパターンの文字列をDate型に変換するのに@InitBinderと@ControllerAdviseを使います。

まず文字列をDate型に変換する方法としてInitBinderというものを使用します。これはControllerに渡ってくるパラメータに対して事前に処理を加えることができます。

このInitBinderをどのタイミングで実行するか定義するのにControllerAdviseを使用します。これはControllerの処理の前後に任意の処理を仕込むことができるものでこの仕組みを使ってInitBinderの処理を割り込ませます。

実装はたったこれだけです。

package com.sample.controller_advise

import org.springframework.beans.propertyeditors.CustomDateEditor
import org.springframework.stereotype.Component
import org.springframework.web.bind.WebDataBinder
import org.springframework.web.bind.annotation.ControllerAdvice
import org.springframework.web.bind.annotation.InitBinder
import java.text.SimpleDateFormat
import java.util.Date

@ControllerAdvice
@Component
class BinderAdvise {

    @InitBinder
    fun initBinder(binder: WebDataBinder) {
        // 日付文字列をDateにバインドする設定
        val dateFormat: SimpleDateFormat = SimpleDateFormat("yyyy-MM-dd")
        dateFormat.setLenient(false)
        binder.registerCustomEditor(Date::class.java, "startDate", CustomDateEditor(dateFormat, true))
        binder.registerCustomEditor(Date::class.java, "endDate", CustomDateEditor(dateFormat, true))

        // 日時文字列をDateにバインドする設定
        val datetimeFormat: SimpleDateFormat = SimpleDateFormat("yyyy-MM-dd HH:mm:ss")
        datetimeFormat.setLenient(false)
        binder.registerCustomEditor(Date::class.java, "targetDatetime", CustomDateEditor(datetimeFormat, true))
    }
}

クラスの先頭に@ControllerAdviceをつけると全コントローラーに対して処理を割り込ませることができます。DIしないといけないので@Componetもつけてください。

@InitBinderがリクエストパラメータから受け取ったデータに対して任意の処理を実行できるものです。

startDate,endDate,targetDatetimeという文字列はリクエストパラメータとして送られてくる変数名を設定しています。

文字列の日付データを数行で定義できて、全部のControllerに対して適用できるのでここら辺の仕組みは非常に簡単です。

設定も複数かけて２種類のフォーマットを定義しても問題ありません。

おすすめ書籍

Springの概要からインストール方法、各コア機能（Security, Sessionなど）の解説が体系的にまとめられています。2018年に出版されたばかりなので情報も新しいです。これからSpring Bootでアプリケーション開発をしたい方の最初に読む一冊としておすすめします。対象は初心者だけでなく上級者まで幅広く学べるので是非読んでみてください！

Spring Boot 2プログラミング入門

posted with ヨメレバ
掌田津耶乃 秀和システム 2018年01月31日
Amazon
Kindle
楽天ブックス

 

The following two tabs change content below.
Twitter のプロフィール

髙妻智一

2013年CyberAgent新卒入社 スマホゲームを作る子会社に所属し、サーバーサイドのエンジニアを担当。２年目の終わりから新規子会社の立ち上げに参加し、サーバーサイドのエンジニアリーダーとしてサービースのリリースから運用までを担当。 2018年仮想通貨のスマホウォレットを提供するGinco Incにブロックチェーンエンジニアとして入社。






よく読まれている関連記事はこちら




コメントを残す

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

RECOMMENDこちらの記事も人気です。