我在当前项目中遇到了 GSON 多态对象的奇怪情况。情况是这样的:我有两个不同的抽象基类,有两个不同的用例:
- 第一个类本身包含在列表中,并且
- 第二个类也包含在列表中,但该列表是更大父对象的一部分
设计类的简化版本(为简洁起见,省略了构造函数和访问器;定义了鉴别器字段,但为了说明而注释掉了):
public abstract class ClassNumeric {
//private String numericType;
}
public class ClassOne extends ClassNumeric {
private String hex;
}
public class ClassTwo extends ClassNumeric {
private Integer whole;
private Integer fraction;
}
public abstract class ClassAlphabetic {
//private String alphabeticType;
}
public class ClassAlpha extends ClassAlphabetic {
private String name;
}
public class ClassBravo extends ClassAlphabetic {
private Integer age;
private Integer numberOfMarbles;
}
public class Container {
private String group;
private List<ClassAlphabetic> alphabetics;
}
适配器工厂及其向 GSON 的注册:
public RuntimeTypeAdapterFactory<ClassNumeric> numericTypeFactory = RuntimeTypeAdapterFactory
.of(ClassNumeric.class, "numericType")
.registerSubtype(ClassOne.class)
.registerSubtype(ClassTwo.class);
public RuntimeTypeAdapterFactory<ClassAlphabetic> alphabeticTypeFactory = RuntimeTypeAdapterFactory
.of(ClassAlphabetic.class, "alphabeticType")
.registerSubtype(ClassAlpha.class)
.registerSubtype(ClassBravo.class);
public final Gson gson = new GsonBuilder()
.setPrettyPrinting()
.disableHtmlEscaping()
.registerTypeAdapterFactory(numericTypeFactory)
.registerTypeAdapterFactory(alphabeticTypeFactory)
.create();
根据我到目前为止所读到的内容,我不必(实际上也不应该)在基类中声明鉴别器字段,因为 GSON 在 JSON 序列化和反序列化时在内部处理这些字段。
以下是如何使用它们的示例:
ClassOne c1 = ClassOne.builder().hex("EF8A").build();
ClassTwo c2 = ClassTwo.builder().whole(1).fraction(3).build();
List<ClassNumeric> numerics = Arrays.asList(c1, c2); // List of child objects
log.debug("Numerics: " + gson.toJson(numerics));
ClassAlpha ca = ClassAlpha.builder().name("Fred").build();
ClassBravo cb = ClassBravo.builder().age(5).numberOfMarbles(42).build();
List<ClassAlphabetic> alphas = Arrays.asList(ca, cb);
Container container = Container.builder().group("Test Group 1").alphabetics(alpha).build(); // List of objects field on larger object
log.debug("Alphas (container): " + gson.toJson(container));
我遇到的问题是 ClassAlphabetic
对象工作正常(鉴别器字段存在于 JSON 中),而 ClassNumeric
对象则不然(鉴别器字段存在)丢失的)。示例输出:
09:12:17.910 [main] DEBUG c.s.s.s.s.GSONPolymorphismTest - Numerics: [
{
"hex": "EF8A"
},
{
"whole": 1,
"fraction": 3
}
]
09:12:17.926 [main] DEBUG c.s.s.s.s.GSONPolymorphismTest - Alphas (container): {
"group": "Test Group 1",
"alphabetics": [
{
"alphabeticType": "ClassAlpha",
"name": "Fred"
},
{
"alphabeticType": "ClassBravo",
"age": 5,
"numberOfMarbles": 42
}
]
}
我在这里缺少什么?这些本质上是用 GSON 以相同的方式定义和设置的,但一个用例可以工作,而另一个则不能。
最佳答案
这是因为泛型在 Java 中的工作方式。简而言之,特定的泛型类实例不具有任何类型参数化信息作为实例的一部分。但是,类型参数可以存储在字段类型、方法返回类型、方法参数、继承的父类(super class)(例如 extends ArrayList<Integer>
)、自定义参数化类型信息实例等中。局部变量,例如 numerics
。是,在编译时保留类型参数并存在于您和编译器的脑海中 - 由于 type erasure 。所以,它就像一个原始的 List
在运行时。类似于 numerics
, alphas
没有任何运行时参数化,但是,与局部变量不同, Container.alphabetics
字段具有在运行时保存的类型信息——字段可以提供完整的类型信息。 Gson 使用它来确定应用哪种(反)序列化策略。同样,当没有提供额外的类型参数信息(例如局部变量)时,Gson 使用默认策略。正如我上面提到的,您还可以创建自定义参数化类型 ParameterizedType
提供原始类型及其类型参数信息。它有何帮助?如果你仔细看看Gson toJson
重载,你可以看到它的重载之一 accepts一个附加参数(我选择了最简单的一个)。这可以被认为是对 Gson 的一种提示,告诉它所传递实例的确切类型(不一定匹配,但在大多数情况下应该匹配)。因此,为了使其正常工作,请告诉 Gson 您的 numerics
List
类型参数化:
// "Canonical" way: TypeToken analyzes its superclass parameterization and returns its via the getType method
private static final Type classNumericListType = new TypeToken<List<ClassNumeric>>() {
}.getType()));
System.out.println("Numerics: " + gson.toJson(numerics, classNumericListType);
或者,如果您可以使用 Gson 2.8.0+,
private static final Type classNumericListType = TypeToken.getParameterized(List.class, ClassNumeric.class);
System.out.println("Numerics: " + gson.toJson(numerics, classNumericListType);
或者直接创建您自己的ParameterizedType
执行。当类型在编译时已知时,我会使用类型标记,并且 TypeToken.getParameterized
如果类型仅在运行时已知。这样,传递类型实例就会触发 RuntimeTypeAdapterFactory
机制(现在是 ClassNumeric
,而不是原始 Object
),因此输出如下:
Numerics: [
{
"numericType": "N1",
"hex": "EF8A"
},
{
"numericType": "N2",
"whole": 1,
"fraction": 3
}
]
关于java - 当基本对象列表时,GSON 不包括鉴别器字段,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/44308814/