对于最新的稳定版本,请使用 Spring Data REST 4.4.0! |
域对象表示 (Object Mapping)
Spring Data REST 返回与 HTTP 请求中指定的类型相对应的域对象的表示形式。Accept
目前,仅支持 JSON 表示形式。将来可以通过添加适当的转换器并使用适当的 content-type 更新控制器方法来支持其他表示类型。
有时,Spring Data REST(已专门配置为使用智能序列化器,可以将域对象转换为链接并再次返回)的行为可能无法正确处理您的域模型。构建数据的方法有很多,您可能会发现自己的域模型没有正确转换为 JSON。在这些情况下,尝试以通用方式支持复杂的域模型有时也是不切实际的。有时,根据复杂性,甚至无法提供通用解决方案。ObjectMapper
向 Jackson 的 ObjectMapper 添加自定义序列化器和反序列化器
为了容纳最大比例的用例,Spring Data REST 会非常努力地正确呈现对象图。它尝试将非托管 bean 序列化为普通 POJO,并在必要时尝试创建指向托管 bean 的链接。但是,如果您的域模型不容易读取或写入纯 JSON,则可能需要使用自己的自定义映射、序列化器和反序列化器配置 Jackson 的 ObjectMapper。
抽象类注册
您可能需要挂接的一个关键配置点是当您在域模型中使用抽象类(或接口)时。默认情况下,Jackson 不知道要为 interface 创建什么 implementation。请考虑以下示例:
@Entity
public class MyEntity {
@OneToMany
private List<MyInterface> interfaces;
}
在默认配置中,Jackson 不知道在 POST 新数据到导出器时要实例化哪个类。这是您需要通过注释或(更清楚地)通过使用 .Module
要将您自己的 Jackson 配置添加到 Spring Data REST 使用的配置中,请覆盖该方法。该方法将传递一个实例,该实例具有一个特殊模块来处理序列化和反序列化对象。您也可以注册自己的模块,如下例所示:ObjectMapper
configureJacksonObjectMapper
ObjectMapper
PersistentEntity
@Override
protected void configureJacksonObjectMapper(ObjectMapper objectMapper) {
objectMapper.registerModule(new SimpleModule("MyCustomModule") {
@Override
public void setupModule(SetupContext context) {
context.addAbstractTypeResolver(
new SimpleAbstractTypeResolver()
.addMapping(MyInterface.class, MyInterfaceImpl.class));
}
});
}
一旦您可以访问 中的对象,您就可以做各种很酷的事情来配置 Jackson 的 JSON 映射。您可以在 Jackson 的 wiki 上阅读有关实例工作原理的更多信息。SetupContext
Module
Module
为域类型添加自定义序列化程序
如果要以特殊方式序列化或反序列化域类型,则可以使用 Jackson's 注册自己的实现,并且Spring Data REST导出器会透明地正确处理这些域对象。要从方法实现添加序列化器,可以执行如下操作:ObjectMapper
setupModule
@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);
}