杰克逊:在序列化时抑制JsonTypeinfo吗?

时间:2019-02-15 11:52:36

标签: java json serialization jackson

我的超类型带有注释

@JsonTypeInfo(use = Id.NAME, include = As.PROPERTY, property = "_typeid")

-以便序列化的子类型包括包含子类型名称的额外字段_typeid。这是我的应用程序有意且必要的。

但是在特定情况下,我想将它们导出为“纯” JSON,即不带_typeid元数据字段。

在序列化过程中是否有任何方法可以使ObjectMapper忽略@JsonTypeinfo注释?我找不到任何相关的配置或功能设置。我将不得不求助于后置过滤器或替代的串行器吗?

我知道可以删除或更改批注,但这在这种情况下不是一种选择。

ObjectMapper().configure(MapperFeature.USE_ANNOTATIONS, false);

-将关闭所有注释。这确实删除了有问题的字段,但同时也杀死了我想使用的其他注释。

2 个答案:

答案 0 :(得分:2)

您可以在运行时使用JsonView批注添加/删除批注。假设我们有一个抽象类Base和一个实现Base1。与其直接向Base添加注释,不如通过添加带有这些注释的新接口来做到这一点。参见以下示例:

abstract class Base {
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "_typeid")
@JsonSubTypes({
        @JsonSubTypes.Type(name = "base1", value = Base1.class)
})
interface BaseTypeView {
}

class Base1 extends Base {
    private String value = "Base 1";

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }
}

现在,我们需要创建两个ObjectMapper:其中一个使用此视图,另一个不使用。

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;

public class JsonApp {

    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = createObjectMapper();
        ObjectMapper mapperWithView = createObjectMapper();
        mapperWithView.addMixIn(Base.class, BaseTypeView.class);

        System.out.println(mapper.writeValueAsString(new Base1()));
        System.out.println(mapperWithView.writeValueAsString(new Base1()));
    }

    private static ObjectMapper createObjectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        return mapper;
    }
}

上面的代码显示:

{
  "value" : "Base 1"
}
{
  "_typeid" : "base1",
  "value" : "Base 1"
}

答案 1 :(得分:0)

根据Michal的回答,此简化版本与我正在寻找的版本非常接近:

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.ObjectMapper;

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)
@JsonSubTypes({
    @JsonSubTypes.Type(value = Cat.class)
})
class Animal { }

class Cat extends Animal {
    public final String genus = "felis";
}

public class Example {
    public static void main(String[] args) throws Exception {
        Cat bill = new Cat();

        ObjectMapper typed = new ObjectMapper();
        System.out.println(typed.writeValueAsString(bill));

        @JsonTypeInfo(use = JsonTypeInfo.Id.NONE)
        class NoTypes { }

        ObjectMapper untyped = new ObjectMapper().addMixIn(Animal.class, NoTypes.class);
        System.out.println(untyped.writeValueAsString(bill));
    }
}

这将输出

{"@type":"Cat","genus":"felis"}
{"genus":"felis"}

这种方法的优点是它不需要控制数据类-可以在配置映射器时在本地完成所有操作-并且mixin是通用的并且可以应用于任何基类。

尽管如此,它仍然需要为每个目标基类进行显式配置,因此它不是一个通用的解决方案。