【问题标题】:Gson deserialization: How to distinguish between fields that are missing and fields that are explicitly set to null?Gson反序列化:如何区分丢失的字段和显式设置为null的字段?
【发布时间】:2015-11-16 14:04:32
【问题描述】:

我正在尝试为我正在构建的 Java (JAX-RS) Web 服务实现 JSON Merge Patch

要点是记录的部分更新是通过将 JSON 文档发送到仅包含应更改的字段的服务器来完成的。

鉴于此记录

{
  "a": "b",
  "c": {
    "d": "e",
    "f": "g"
  }
}

,以下JSON更新文档

{
  "a":"z",
  "c": {
    "f": null
  }
}

应为"a" 设置一个新值并删除"c" 内的"f"

后者才是问题所在。我不知道如何区分缺少 f 的输入和 f 为空的输入。 据我所知,两者都将被反序列化为目标 Java 对象中的null

做什么?

【问题讨论】:

  • 没有好办法,xml世界有xsi:nil="true",在java中如果某物为null,你不知道它是初始化为null还是有人设置为null,你可以定义枚举如果可能并分配空值
  • 我正在考虑为 Java 8 的 Optional<Type> 编写自己的反序列化器。
  • 嗯。我试过了,但由于 Java 的类型擦除,很快就卡住了。我无法为Optional&lt;T&gt; 实现Serializer(或解串器),因为签名不匹配,我无法实现TypeAdapterFactory,因为我无法掌握Optional 的类型参数在运行时。非常非常令人沮丧。
  • 我还尝试将Optional&lt;T&gt; 包装在一个明确记住其原始类型的类中,方法是将其作为构造函数参数。这可能有效,但初始化(或检索)简单字符串的代码会变得非常长且扭曲。

标签: java json serialization gson


【解决方案1】:

我承认 mlk 的回答,但鉴于我已经(并且仍然需要)JSON 对象的 POJO 表示,我觉得自动映射仍然比手动查找更好。

挑战在于,正如我所说,gson.fromJson(...) 将填充的相应 POJO 中,缺失的和显式的 null 值都设置为 null。 (与 R 的 NULLNA 不同,Java 只有一种表示“不存在”。)

但是,通过使用Java 8's Optionals 对我的数据结构进行建模,我可以做到这一点:区分未设置的内容和设置为null 的内容。这是我最终得到的结果:

1) 我用Optional&lt;T&gt; 替换了我的数据对象中的所有字段。

public class BasicObjectOptional {

    private Optional<String> someKey;
    private Optional<Integer> someNumber;
    private Optional<String> mayBeNull;

    public BasicObjectOptional() {
    }

    public BasicObjectOptional(boolean initialize) {
        if (initialize) {
            someKey = Optional.ofNullable("someValue");
            someNumber = Optional.ofNullable(42);
            mayBeNull = Optional.ofNullable(null);
        }
    }

    @Override
    public String toString() {
        return String.format("someKey = %s, someNumber = %s, mayBeNull = %s",
                                            someKey, someNumber, mayBeNull);
    }

}

或嵌套的:

public class ComplexObjectOptional {

    Optional<String> theTitle;  
    Optional<List<Optional<String>>> stringArray;
    Optional<BasicObjectOptional> theObject;

    public ComplexObjectOptional() {
    }

    public ComplexObjectOptional(boolean initialize) {
        if (initialize) {
            theTitle = Optional.ofNullable("Complex Object");   
            stringArray =    Optional.ofNullable(Arrays.asList(Optional.ofNullable("Hello"),Optional.ofNullable("World")));
            theObject = Optional.ofNullable(new BasicObjectOptional(true));
        }
    }

    @Override
    public String toString() {
        return String.format("theTitle = %s, stringArray = %s, theObject = (%s)", theTitle, stringArray, theObject);
    }   
}

2) 实现了序列化器和反序列化器based on this useful SO answer

public class OptionalTypeAdapter<E> extends TypeAdapter<Optional<E>> {

    public static final TypeAdapterFactory FACTORY = new TypeAdapterFactory() {

        //@Override
        public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> type) {
            Class<T> rawType = (Class<T>) type.getRawType();
            if (rawType != Optional.class) {
                return null;
            }
            final ParameterizedType parameterizedType = (ParameterizedType) type.getType();
            final Type actualType = parameterizedType.getActualTypeArguments()[0];
            final TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(actualType));
            return new OptionalTypeAdapter(adapter);
        }
    };
    private final TypeAdapter<E> adapter;

    public OptionalTypeAdapter(TypeAdapter<E> adapter) {
        this.adapter = adapter;
    }

    @Override
    public void write(JsonWriter out, Optional<E> value) throws IOException {
        if(value == null || !value.isPresent()){
            out.nullValue();
        } else {
            adapter.write(out, value.get());
        }
    }

    @Override
    public Optional<E> read(JsonReader in) throws IOException {
        final JsonToken peek = in.peek();
        if(peek != JsonToken.NULL){
            return Optional.ofNullable(adapter.read(in));
        }
        in.nextNull();
        return Optional.empty();
    }

}

3) 在初始化 Gson 时注册了这个适配器。

Gson gsonOptFact = new GsonBuilder()
    .serializeNulls() // matter of taste, just for output anyway
    .registerTypeAdapterFactory(OptionalTypeAdapter.FACTORY)
    .create();

这使我可以编写 JSON,以便将 null 和空 Optional 序列化为 null(或简单地从输出中删除),同时将 JSON 读入 Optional 字段,这样 如果字段是 null 我知道它在 JSON 输入中丢失了,如果字段是 Optional.empty 我知道它在输入中设置为 null


例子:

System.out.println(gsonOptFact.toJson(new BasicObjectOptional(true)));
// {"someKey":"someValue","someNumber":42,"mayBeNull":null}

System.out.println(gsonOptFact.toJson(new ComplexObjectOptional(true)));
// {"theTitle":"Complex Object","stringArray":["Hello","World"],"theObject":{"someKey":"someValue","someNumber":42,"mayBeNull":null}}

// Now read back in:
String basic = "{\"someKey\":\"someValue\",\"someNumber\":42,\"mayBeNull\":null}";
String complex = "{\"theTitle\":\"Complex Object\",\"stringArray\":[\"Hello\",\"world\"],\"theObject\":{\"someKey\":\"someValue\",\"someNumber\":42,\"mayBeNull\":null}}";
String complexMissing = "{\"theTitle\":\"Complex Object\",\"theObject\":{\"someKey\":\"someValue\",\"mayBeNull\":null}}";

BasicObjectOptional boo = gsonOptFact.fromJson(basic, BasicObjectOptional.class);
System.out.println(boo);
// someKey = Optional[someValue], someNumber = Optional[42], mayBeNull = Optional.empty

ComplexObjectOptional coo = gsonOptFact.fromJson(complex, ComplexObjectOptional.class);
System.out.println(coo);
// theTitle = Optional[Complex Object], stringArray = Optional[[Optional[Hello], Optional[world]]], theObject = (Optional[someKey = Optional[someValue], someNumber = Optional[42], mayBeNull = Optional.empty])

ComplexObjectOptional coom = gsonOptFact.fromJson(complexMissing, ComplexObjectOptional.class);
System.out.println(coom);
// theTitle = Optional[Complex Object], stringArray = null, theObject = (Optional[someKey = Optional[someValue], someNumber = null, mayBeNull = Optional.empty])

我认为这将使我能够很好地将 JSON Merge Patch 与我现有的数据对象集成。

【讨论】:

  • 一段时间过去后的一些看法:我们已经相当成功地使用了这个解决方案大约半年了,但是出于不相关的原因,我们将迁移到 Jackson 而不是 Gson。好处:杰克逊开箱即用,区分null和“未发送”。
【解决方案2】:

我认为您将不得不使用JsonObject 并查看返回的 Json 对象。

您可以使用JsonParser.parse(java.io.Reader) 来获取JsonObject。

【讨论】:

  • 我会在哪里或如何做到这一点?目前,我正在使用 MyObject bla = gson.fromJson(someStream, MyObject.class); 之类的方式将输入直接解析为域对象
  • 好的,所以你说的是不是将 JSON 映射到域对象,而是我可以在解析器中“打开”它并遍历它并查找我感兴趣的元素。
  • 是的。我认为您可以使用自定义反序列化器来做一些事情。我不认为您可以使用Optional&lt;T&gt;,因为您需要具有三种状态-已发送和null,已发送和已发送且未发送。
  • 看看我刚刚提交的答案。我想我可以使用Optional.emptynull(在 Optional 内部或代替它,后者是 Gson 的默认行为)来模拟三种状态。我必须对此进行更多测试,但我认为它可以工作。
【解决方案3】:

对于原始类型,使用可为空的版本。

例如,在通常使用 long 的地方使用 Long。整数替换int等

您也可以在要检测缺失值的地方使用字符串类型,但您还需要将字符串解析为您需要的类型。

【讨论】:

  • 我不确定这是否能解决问题。我需要区分三种情况,即使只针对原语: 1:客户端发送了一个值,可能是“0”(要求我替换之前的值)。 2:客户端主动发送“null”(即要求我删除之前的内容)。 3:客户端没有发送新值(即我不应该触摸我已经拥有的)。
  • 啊,就我而言,我只需要检测缺失值。对于上述基元和自定义类型。未提供时它们为空。你是对的;这将无法检测到缺少的值与 JSON 中包含的值为 null 的值。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2022-12-11
  • 1970-01-01
  • 2014-07-30
  • 2016-05-30
  • 1970-01-01
相关资源
最近更新 更多