对于最新的稳定版本,请使用 Spring Data REST 4.4.0! |
向 Jackson's 添加自定义序列化器和反序列化器ObjectMapper
有时,Spring Data REST 的行为ObjectMapper
(已专门配置为使用智能序列化器,可以将域对象转换为链接并再次返回)可能无法正确处理您的域模型。您可以通过多种方式构建数据,以至于您可能会发现自己的域模型无法正确转换为 JSON。在这些情况下,以通用方式支持复杂的域模型有时也是不切实际的。有时,根据复杂性,甚至无法提供通用解决方案。
为了容纳最大比例的用例,Spring Data REST 会尝试正确呈现对象图。它尝试将非托管 bean 序列化为普通 POJO,并在必要时尝试创建指向托管 bean 的链接。但是,如果您的域模型不容易读取或写入纯 JSON,则可能需要配置 Jackson 的ObjectMapper
使用你自己的自定义类型映射和(反)序列化器。
抽象类注册
您可能需要挂接的一个关键配置点是当您在域模型中使用抽象类(或接口)时。默认情况下,Jackson 不知道要为 interface 创建什么 implementation。请考虑以下示例:
@Entity
public class MyEntity {
@OneToMany
private List<MyInterface> interfaces;
}
在默认配置中,Jackson 不知道在 POST 新数据到导出器时要实例化哪个类。您需要通过注释来告诉 Jackson,或者更清楚地说,通过使用 Module 注册类型映射。
任何Module
bean 的ApplicationContext
由导出器选取并注册到其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));
}
}
一旦您可以访问SetupContext
object 添加到Module
,您可以做各种很酷的事情来配置 Jackon 的 JSON 映射。您可以在 Jackson 的 wiki 上阅读有关模块如何工作的更多信息。
为域类型添加自定义序列化程序
如果你想以特殊方式序列化或反序列化一个域类型,你可以用 Jackson 的ObjectMapper
.然后, Spring Data REST exporter 以透明方式正确处理这些域对象。
要从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 可以在域对象对于 Spring Data REST 尝试涵盖的 80% 通用用例来说过于复杂时正确处理它们。