【问题标题】:Make Jackson Subtypes extensible without editing the Supertypes java-file无需编辑 Supertypes java 文件即可使 Jackson Subtypes 可扩展
【发布时间】:2019-09-17 20:46:09
【问题描述】:

在我的公司,我们有一个固定的 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-annotation,我可以在其中添加所有可能的子类型——我在编写库时不想知道这些子类型。所以这个选项对我不起作用。

我想,将@JsonType-annoation 与子类型一起使用可能会有所帮助,但我仍然必须添加@JsonSubTypes,这没有帮助。


有没有办法在不修改基本类型 java 文件的情况下向基本类型添加子类型?


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

【问题讨论】:

标签: java spring-boot jackson jackson-databind


【解决方案1】:

ObjectMapper 有一个方法registerSubtypes(NamedType) 可用于添加子类型以供使用,而无需将它们放在注解中。

为此我创建了一个新的注释(我可能重复使用了@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));
    }
}

它使用反射来获取在搜索包中声明的所有带注释的类型,并将它们注册为 ObjectMapper 的子类型。

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

不过,我是 Java 初学者,所以请分享您的想法,如果这是不必要的或可以/应该/必须改进。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2015-06-28
    • 1970-01-01
    相关资源
    最近更新 更多