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

Gsonは、Googleが開発したJava向けのJSONライブラリです。Gsonを利用すると、JavaオブジェクトからJSON文字列を生成したり、その逆にJSONをJavaオブジェクトへ変換したりすることができます。

Gsonインスタンスを作成するには、まずGsonBuilderのインスタンスを生成し、create()メソッドを呼び出します。そして、Dateオブジェクトを任意の日付形式でシリアライズしたい場合は、setDateFormat()メソッドを使用します。このメソッドに日付パターンを渡すことで、Gsonは指定されたパターンに従ってDateオブジェクトをJSON文字列へ変換します。

構文

public GsonBuilder setDateFormat(java.lang.String pattern)

コード例

以下の例では、従業員情報を持つEmployeeクラスのオブジェクトをJSONに変換しています。setDateFormat("yyyy-MM-dd")を指定することで、入社日（doj）が「年-月-日」の形式で出力されます。

import java.util.Date;
import com.google.gson.*;

public class DateformatTest {
    public static void main(String[] args) {
        Employee emp = new Employee(115, "Surya", new Date(), 25000.00);
        Gson gson = new GsonBuilder().setDateFormat("yyyy-MM-dd").create();
        String result = gson.toJson(emp);
        System.out.println(result);
    }
}

// 従業員クラス
class Employee {
    private int id;
    private String name;
    private Date doj;
    private double salary;

    public Employee(int id, String name, Date doj, double salary) {
        this.id = id;
        this.name = name;
        this.doj = doj;
        this.salary = salary;
    }
}

実行結果

{"id":115,"name":"Surya","doj":"2019-09-26","salary":25000.0}

ポイント解説

• setDateFormat()に渡すパターンは、java.text.SimpleDateFormatと同じ規則に従います。「yyyy」は西暦4桁、「MM」は月2桁、「dd」は日2桁を表します。
• setDateFormat()を呼び出さない場合、Dateオブジェクトはロケールに依存したデフォルトの形式でシリアライズされるため、意図しない形式になることがあります。
• 時刻も含めたい場合は、setDateFormat("yyyy-MM-dd HH:mm:ss")のようにパターンを変更するだけで対応できます。