跳到主要内容
版本:5.1.1

向 Jackson 的 ObjectMapper 添加自定义序列化器与反序列化器

Doubao 中英对照 Adding Custom Serializers and Deserializers to Jackson’s ObjectMapper Adding Custom Serializers and Deserializers to Jackson’s ObjectMapper

有时,Spring Data REST 的 ObjectMapper(经过专门配置,使用智能序列化器,可将领域对象转换为链接并再转换回来)的行为可能无法正确处理您的领域模型。您组织数据的方式多种多样,可能会发现自己的领域模型无法正确地转换为 JSON。在这些情况下,以通用方式支持复杂的领域模型有时并不现实。有时,根据其复杂程度,甚至不可能提供通用的解决方案。

为了覆盖最大比例的用例,Spring Data REST 会尝试正确渲染您的对象图。它尝试将非受管 bean 作为普通 POJO 序列化,并在必要时尝试为受管 bean 创建链接。但是,如果您的领域模型不易于读写纯 JSON,您可能希望用自己的自定义类型映射以及(反)序列化器来配置 Jackson 的 ObjectMapper。

抽象类注册​

当您在领域模型中使用抽象类(或接口)时,这是一个可能需要介入的关键配置点。默认情况下,Jackson 不知道应为接口创建哪个实现。请考虑以下示例:

@Entity
public class MyEntity {

@OneToMany
private List<MyInterface> interfaces;
}

在默认配置下,当向导出器 POST 新数据时,Jackson 不知道应实例化哪个类。您需要通过注解来告知 Jackson,或者更整洁地,通过使用 Module 注册一个类型映射来告知。

在您的 ApplicationContext 作用域内声明的任何 Module bean 都会被导出器获取,并注册到其 ObjectMapper。要添加这种特殊的抽象类类型映射,您可以创建一个 Module bean,并在 setupModule 方法中添加一个合适的 TypeResolver,如下所示:

public class MyCustomModule extends SimpleModule {

private MyCustomModule() {
super("MyCustomModule", new Version(1, 0, 0, "SNAPSHOT"));
}

@Override
public void setupModule(SetupContext context) {
context.addAbstractTypeResolver(
new SimpleAbstractTypeResolver().addMapping(MyInterface.class,
MyInterfaceImpl.class));
}
}

一旦在您的 Module 中获取了 SetupContext 对象,您就可以做各种有趣的事情来配置 Jackson 的 JSON 映射。您可以在 Jackson 的 wiki 上阅读更多关于 Module 工作方式的信息。

为领域类型添加自定义序列化器​

如果您想以特殊方式序列化或反序列化某个领域类型,可以向 Jackson 的 ObjectMapper 注册您自己的实现。这样,Spring Data REST 导出器就会透明地正确处理这些领域对象。

要从您的 setupModule 方法实现中添加序列化器,您可以像下面这样做:

public class MyCustomModule extends SimpleModule {

…

@Override
public void setupModule(SetupContext context) {

SimpleSerializers serializers = new SimpleSerializers();
SimpleDeserializers deserializers = new SimpleDeserializers();

serializers.addSerializer(MyEntity.class, new MyEntitySerializer());
deserializers.addDeserializer(MyEntity.class, new MyEntityDeserializer());

context.addSerializers(serializers);
context.addDeserializers(deserializers);
}
}

得益于前述示例所示的自定义模块,当您的领域对象对于 Spring Data REST 试图覆盖的 80% 通用用例而言过于复杂时,Spring Data REST 也能正确处理它们。