Gson自定义类型适配器仅在一个对象类型上序列化null?

时间:2016-01-12 23:35:25

标签: java json serialization gson

我想在我的JSON主体中仅对一个PUT上的一个类型序列化null。我不想为对象中的任何其他类型序列化空值。我有这样的事情:

public class Patient {
    public Address address;
    public String first_name;
    public String last_name;
}

我只想在地址为空时序列化地址。例如,

Patient patient = new Patient();
patient.address = null;
patient.last_name = "Doe";

看起来像这样:

"address":null,
"last_name":"Doe"

如果地址被指定为null,则患者不在该对象之外,因为默认情况下Gson不会序列化我想要的空值,并且姓氏保留指定的字符串值。

我可以使用Gson自定义类型适配器吗?

public class GsonCustomAdapter extends TypeAdapter<Address>

我对这个概念一点也不熟悉,并且一直试图理解它。非常感谢任何帮助。

1 个答案:

答案 0 :(得分:8)

默认情况下,如果您不想序列化空值,只有在您实际阅读JsonWriter实例时,才能告诉Address序列化它。

让我们假设以下课程:

class Address {
    public String country = "UK";
    public String city = "London";
}

现在我们为Address类创建一个特定的类型适配器。在这里你明确地说,即使JsonWriter不应该在响应中写入null值,你也允许它只为Address字段这样做(参见注释)在代码中。)

class AddressAdapter extends TypeAdapter<Address> {
    @Override
    public void write(JsonWriter out, Address address) throws IOException {
        if (address == null) {
            //if the writer was not allowed to write null values
            //do it only for this field
            if (!out.getSerializeNulls()) {
                out.setSerializeNulls(true);
                out.nullValue();
                out.setSerializeNulls(false);
            } else {
                out.nullValue();
            }
        } else {
            out.beginObject();
            out.name("country");
            out.value(address.country);
            out.name("city");
            out.value(address.city);
            out.endObject();
        }
    }

    @Override
    public Address read(JsonReader in) throws IOException {
        if(in.peek() == JsonToken.NULL) {
            in.nextNull();
            return null;
        }
        in.beginObject();
        Address address = new Address();
        in.nextName();
        address.country = in.nextString();
        in.nextName();
        address.city = in.nextString();
        in.endObject();
        return address;
    }
}

现在您必须注册此适配器,以便解析器知道在序列化/反序列化Address字段时必须使用它。为此,请使用注释@JsonAdapter

class Patient {
    @JsonAdapter(AddressAdapter.class)
    public Address address;
    public String first_name;
    public String last_name;
}

已经完成了!

例如,让我们以您的例子为例:

Patient patient = new Patient();
patient.last_name = "Doe";

将解析器设置为序列化空值后,您将获得:

{"address":null,"first_name":null,"last_name":"Doe"}

当您不允许时(默认设置):

{"address":null,"last_name":"Doe"}

通过为患者设置地址:

patient.address = new Address();
...
{"address":{"country":"UK","city":"London"},"last_name":"Doe"}

如果您想在Java端坚持使用命名约定,则可以使用注释@SerializedName,例如:

@SerializedName("first_name") public String firstName;
@SerializedName("last_name")  public String lastName;

希望它有所帮助! : - )