java - 无需编辑 Supertypes java 文件即可使 Jackson 子类型可扩展

Question

在我的公司，我们有一个固定的 JSON 消息结构:

{
    "headerVal1": ""
    "headerVal2": ""
    "customPayload": {
        "payloadType":""
    }
}

我想要某种库，它允许我不关心公司定义的消息结构，而是只发送和接收有效负载。

我的想法是，将公司模板的结构定义为一个对象，并使用 PayloadObject 的子类型。

@JsonTypeInfo(
    use = JsonTypeInfo.Id.NAME,
    include = JsonTypeInfo.As.MINIMAL_CLASS,
    property = "payloadType",
    visible = false)
public abstract class PayloadObject {
}

现在我可以创建 PayloadObject 的子类，并且它可以在这个结构中自动反序列化，只要属性 payloadType 有一个字符串 ".SubTypeName"。

这是有问题的，因为我不能自定义它，甚至不能删除多余的 . 一开始。不幸的是，这不一定与公司中我们需要与之交互的其他现有系统兼容。

另一种方法是添加一个 @JsonSubTypes 注释，我可以在其中添加所有可能的子类型——我在编写库时不想知道这些。所以这个选项对我不起作用。

我想，使用子类型的 @JsonType 注释可能会有所帮助，但我仍然必须添加 @JsonSubTypes，这没有帮助。

---

Is there a way, to add subtypes to a basetype without modifying the basetypes java-file?

---

如果这有帮助:我们正在使用 Java Spring。

Answer 1

ObjectMapper 有一个方法 registerSubtypes(NamedType) 可以用来添加子类型以供使用，而无需在注释中添加它们。

为此我创建了一个新的 Annotation(我可能重用了 @JsonTypeName，但它可能是滥用的)

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface MyJsonSubtype
{
   public String jsonTypeName();
}

然后给我写了一个方法

public static void registerMyJsonSubtypes(ObjectMapper om, Object... reflectionArgs) {
    Reflections reflections = new Reflections(reflectionArgs);
    Set<Class<?>> types = reflections.getTypesAnnotatedWith(MyJsonSubtype.class);
    for (Class type : types) {
        String name = ((MyJsonSubtype) type.getAnnotation(MyJsonSubtype.class)).jsonTypeName();
        om.registerSubtypes(new NamedType(type, name));
    }
}

它使用 Reflections 获取在搜索到的包内声明的所有注释类型，并将它们注册为 ObjectMapper 的子类型。

这仍然需要基类上的 @JsonTypeInfo-annotation 将对象标记为潜在可扩展的，因此映射器知道要使用哪个属性来解析名称，但我认为，这是可提供的。我主要关注的是这个问题，我不想在基类的注释中声明所有 future 的子类型。

I am a Java beginner though, so please share your thoughts, if this is unnecessary or could/should/must be improved.