【Java】Jacksonの@JsonFormatアノテーションで複数の日付形式をマッピングする方法

JacksonはJavaベースの人気ライブラリで、JavaオブジェクトをJSONへ変換したり、その逆にJSONからJavaオブジェクトへ変換したりする際に広く利用されています。複数の日付形式をマッピングしたい場合は、@JsonFormatアノテーションを使用します。これは、プロパティの値がどのようにシリアライズされるかを設定するための汎用アノテーションです。

@JsonFormatには、次の3つの重要なフィールドが用意されています。

• shape: シリアライズ時に使用するデータの構造を定義します（JsonFormat.Shape.NUMBER または JsonFormat.Shape.STRING）。
• pattern: シリアライズとデシリアライズの両方で使用でき、日付の場合はSimpleDateFormat互換のパターンを指定します。
• timezone: シリアライズ時に適用されるタイムゾーンで、デフォルトはシステムのデフォルトタイムゾーンです。

構文

@Target(value={ANNOTATION_TYPE,FIELD,METHOD,PARAMETER,TYPE})
@Retention(value=RUNTIME)
public @interface JsonFormat

コード例

以下の例では、Employeeクラスの2つの日付フィールドに対して、それぞれ異なるパターンとタイムゾーンを指定しています。

import java.io.*;
import java.util.Date;
import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.databind.ObjectMapper;

public class JacksonDateformatTest {
    final static ObjectMapper mapper = new ObjectMapper();
    public static void main(String[] args) throws Exception {
        JacksonDateformatTest jacksonDateformat = new JacksonDateformatTest();
        jacksonDateformat.dateformat();
    }
    public void dateformat() throws Exception {
        String json = "{\"createDate\":\"1980-12-08\"," + "\"createDateGmt\":\"1980-12-08 3:00 PM GMT+1:00\"}";
        Reader reader = new StringReader(json);
        Employee employee = mapper.readValue(reader, Employee.class);
        System.out.println(employee);
    }
}
// Employeeクラス
class Employee implements Serializable {
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd", timezone = "IST")
    private Date createDate;
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm a z", timezone = "IST")
    private Date createDateGmt;
    public Date getCreateDate() {
        return createDate;
    }
    public void setCreateDate(Date createDate) {
        this.createDate = createDate;
    }
    public Date getCreateDateGmt() {
        return createDateGmt;
    }
    public void setCreateDateGmt(Date createDateGmt) {
        this.createDateGmt = createDateGmt;
    }
    @Override
    public String toString() {
        return "Employee [\ncreateDate=" + createDate + ", \ncreateDateGmt=" + createDateGmt + "\n]";
    }
}

実行結果

Employee [
 createDate=Mon Dec 08 00:00:00 IST 1980,
 createDateGmt=Mon Dec 08 07:30:00 IST 1980
]

このように、フィールドごとにpatternやtimezoneを個別に指定することで、同一クラス内でも複数の日付形式を柔の日付形式を柔軟に扱うことができます。また、デシリアライズ時にも、指定したパターンに一致する文字列であれば正しく日付として読み込まれるため、外部APIなど多様なフォーマットの日付データを扱う際に非常に便利です。