JavaのJacksonライブラリで日付をフォーマットする方法｜setDateFormat()の使い方を解説

JacksonはJavaベースのライブラリで、JavaオブジェクトをJSONへ変換したり、JSONをJavaオブジェクトへ変換したりする際に非常に便利です。Jackson APIは他のAPIよりも処理速度が速く、必要なメモリ領域も少ないため、大きなオブジェクトの処理にも適しています。

日付のフォーマットを行うには、ObjectMapperクラスのsetDateFormat()メソッドを使用します。このメソッドは、日時の値を文字列としてシリアライズする際、またJSON文字列からデシリアライズする際に適用される、デフォルトのDateFormatを設定するためのものです。

構文

public ObjectMapper setDateFormat(DateFormat dateFormat)

使用例

以下の例では、SimpleDateFormatで「yyyy-MM-dd」というパターンを定義し、setDateFormat()でObjectMapperに登録しています。その後、JSON文字列をEmployeeオブジェクトにデシリアライズしています。

import java.io.*;
import java.text.*;
import java.util.*;
import com.fasterxml.jackson.databind.*;

public class JacksonDateformatTest {
    final static ObjectMapper mapper = new ObjectMapper();

    public static void main(String[] args) throws Exception {
        JacksonDateformatTest jacksonDateformat = new JacksonDateformatTest();
        DateFormat df = new SimpleDateFormat("yyyy-MM-dd");
        mapper.setDateFormat(df);
        jacksonDateformat.dateformat();
    }

    public void dateformat() throws Exception {
        String json = "{\"birthDate\":\"1980-12-08\"}";
        Reader reader = new StringReader(json);
        Employee emp = mapper.readValue(reader, Employee.class);
        System.out.println(emp);
    }
}

// Employeeクラス
class Employee implements Serializable {
    private Date birthDate;

    public Date getBirthDate() {
        return birthDate;
    }

    public void setBirthDate(Date birthDate) {
        this.birthDate = birthDate;
    }

    @Override
    public String toString() {
        return "Employee [birthDate=" + birthDate + "]";
    }
}

実行結果

Employee [birthDate=Mon Dec 08 00:00:00 IST 1980]

このように、setDateFormat()を設定しておくことで、「1980-12-08」という形式のJSON文字列が正しくDate型として読み込まれ、以降のシリアライズ・デシリアライズにも同じフォーマットが自動的に適用されます。

補足：@JsonFormatアノテーションを使う方法

ObjectMapper全体ではなく、特定のフィールドにのみフォーマットを適用したい場合は、フィールドに@JsonFormatアノテーションを付与する方法もあります。

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
private Date birthDate;

用途に応じて、グローバルな設定にはsetDateFormat()、個別の制御には@JsonFormatを使い分けるとよいでしょう。