【Java】GsonライブラリでnullフィールドをJSONにシリアライズする方法

デフォルト設定では、Gsonはnull値を持つフィールドをJSONにシリアライズしません。Javaオブジェクト内のフィールドがnullである場合、そのフィールドは出力から除外されます。

しかし、GsonBuilderクラスを利用することで、null値も強制的にシリアライズさせることが可能です。具体的には、Gsonオブジェクトを生成する前に、GsonBuilderインスタンスに対してserializeNulls()メソッドを呼び出します。このメソッドを呼び出した後に作成されたGsonインスタンスは、シリアライズ結果のJSONにnullフィールドを含めるようになります。

構文

public GsonBuilder serializeNulls()

コード例

以下は、serializeNulls()を使用してnull値を持つフィールドを出力に含めるサンプルプログラムです。

import com.google.gson.*;
import com.google.gson.annotations.*;

public class NullFieldTest {
    public static void main(String args[]) {
        GsonBuilder builder = new GsonBuilder();
        builder.serializeNulls();
        Gson gson = builder.setPrettyPrinting().create();
        Employee emp = new Employee(null, 25, 40000.00);
        String jsonEmp = gson.toJson(emp);
        System.out.println(jsonEmp);
    }
}

// Employeeクラス
class Employee {
    @Since(1.0)
    public String name;
    @Since(1.0)
    public int age;
    @Since(2.0)
    public double salary;

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

実行結果

上記のコードを実行すると、nameフィールドがnullであっても、JSON出力に「"name": null」が含まれていることが確認できます。

{
    "name": null,
    "age": 25,
    "salary": 40000.0
}

ポイントまとめ

• デフォルトのGsonでは、nullのフィールドはJSONから除外される
• nullも出力したい場合は、GsonBuilderのserializeNulls()を呼び出してからGsonインスタンスを作成する
• setPrettyPrinting()を組み合わせると、整形された読みやすいJSONが出力できる