java - 当传递基类类型的引用时，JSON 仅序列化基类字段

Question

我正在使用Gson图书馆。当提供给 Gson 的对象属于基类类型时，要求 Gson 仅序列化基类的字段的干净/惯用方法是什么？请注意，这与类似的问题(例如 this one )不同，后者询问如何始终排除特定字段。在我的用例中，我只希望当 Gson 库通过基类类型引用传递派生类对象时排除继承的类字段。否则，即如果 Gson 库通过派生类类型引用传递派生类对象，那么我希望这些字段出现在序列化中。

SSCCE如下:

import com.google.gson.Gson;
import com.google.gson.GsonBuilder;

class A {
    public int a;
    public A(final int a) {
        this.a = a;
    }
}

class B extends A {
    public int b;

    public B(final int a, final int b) {
        super(a);
        this.b = b;
    }

}

public class Main {

    public static void main(String args[]) {

        final A a = new B(42, 142);
        final Gson gson = new GsonBuilder().serializeNulls().create();

        System.out.printf("%s\n", gson.toJson(a));
    }
}

以上打印:

{"b":142,"a":42}

我正在寻找一种干净的方法来打印它:

{"a":42}

但是如果使用以下代码:

final B b = new B(42, 142);

...然后我希望 gson.toJson(b) 确实返回:

{"b":142,"a":42}

有没有一种干净的方法来实现这一目标？

更新

accepted answer at the time of this writing建议使用 toJson(o, A.class) 在这种情况下确实有效。然而，这种方法似乎不能很好地扩展到泛型。例如:

class A {
    public int a;
    public A(final int a) {
        this.a = a;
    }
}

class B extends A {
    public int b;

    public B(final int a, final int b) {
        super(a);
        this.b = b;
    }
}

class Holder<T> {
    public final T t;

    public Holder(final T t) {
        this.t = t;
    }
}

final A a = new B(42, 142);
final Holder<A> holder = new Holder<A>(a);
final Gson gson = new GsonBuilder().serializeNulls().create();

final Type TYPE= new TypeToken<Holder<A>>() {}.getType();
System.out.printf("%s\n", gson.toJson(holder, TYPE));

遗憾的是，上面的打印结果是:

{"t":{"b":142,"a":42}}

Answer 1

Is there a clean way to achieve that?

是的。

您不需要排除策略，尽管它们足够灵活以涵盖这种情况。数据包类序列化和反序列化由 TypeAdapter 驱动实现发现于 ReflectiveTypeAdapterFactory 。这种类型的适配器需要 the most concrete class fields考虑在内。

话虽如此，您唯一需要的是 specifying从中获取字段的最具体类型:

final Object o = new B(42, 142);
System.out.println(gson.toJson(o, A.class));

它对您不起作用的原因是您的代码指定了最具体的类 implicitly ，就像您使用 gson.toJson(o, o.getClass()) 一样或gson.toJson(o, B.class)对于上面的代码。

泛型类型问题

恐怕ReflectiveTypeAdapterFactory对于这种情况，不能考虑类型参数。不知道什么getRuntimeTypeIfMoreSpecific方法确实做了什么，它的最初目的是什么，但它“转换”了 A具体输入 B类型，因为 type instanceof Class<?>检查允许 overwrite字段类型为 type = value.getClass(); 。看起来您必须针对这种情况实现解决方法:

.registerTypeAdapterFactory(new TypeAdapterFactory() {
    @Override
    public <T> TypeAdapter<T> create(Gson gson, TypeToken<T> typeToken) {
        final Class<? super T> rawType = typeToken.getRawType();
        if ( rawType != Holder.class ) {
            return null;
        }
        final Type valueType = ((ParameterizedType) typeToken.getType()).getActualTypeArguments()[0];
        @SuppressWarnings({"unchecked", "rawtypes"})
        final TypeAdapter<Object> valueTypeAdapter = (TypeAdapter) gson.getDelegateAdapter(this, TypeToken.get(valueType));
        final TypeAdapter<Holder<?>> typeAdapter = new TypeAdapter<Holder<?>>() {
            @Override
            public void write(final JsonWriter out, final Holder<?> value)
                    throws IOException {
                out.beginObject();
                out.name("t");
                valueTypeAdapter.write(out, value.t);
                out.endObject();
            }

            @Override
            public Holder<?> read(final JsonReader in)
                    throws IOException {
                Object t = null;
                in.beginObject();
                while ( in.hasNext() ) {
                    final String name = in.nextName();
                    switch ( name ) {
                    case "t":
                        t = valueTypeAdapter.read(in);
                        break;
                    default:
                        // do nothing;
                        break;
                    }
                }
                in.endObject();
                return new Holder<>(t);
            }
        }.nullSafe();
        @SuppressWarnings("unchecked")
        final TypeAdapter<T> castTypeAdapter = (TypeAdapter<T>) typeAdapter;
        return castTypeAdapter;
    }
})

不幸的是，您的Gson中有这种类型的适配器实例使 @SerializedName , @JsonAdapter和其他很酷的东西不可用，并使其坚持硬编码的字段名称。这可能是一个 Gson 错误。