域对象表示(对象映射)
Spring Data REST 返回域对象的表示形式,该表示形式对应于 HTTP 请求中指定的 Accept
类型。
目前,仅支持 JSON 表示形式。将来可以通过添加适当的转换器并使用适当的内容类型更新控制器方法来支持其他表示类型。
有时,Spring Data REST ObjectMapper
(已专门配置为使用能够将域对象转换为链接并再次转换回域对象的智能序列化器)的行为可能无法正确处理您的域模型。您可以以多种方式构建数据,因此您可能会发现自己的域模型未正确转换为 JSON。在这些情况下,尝试以通用方式支持复杂的域模型有时也不切实际。有时,根据复杂性,甚至不可能提供通用的解决方案。
向 Jackson 的 ObjectMapper 添加自定义序列化器和反序列化器
为了适应最大比例的使用案例,Spring Data REST 非常努力地正确呈现您的对象图。它尝试将非托管 Bean 作为普通 POJO 进行序列化,并在必要时尝试创建指向托管 Bean 的链接。但是,如果您的域模型不容易转换为读取或写入纯 JSON,则可能需要使用您自己的自定义映射、序列化器和反序列化器来配置 Jackson 的 ObjectMapper。
抽象类注册
您可能需要挂钩的一个关键配置点是当您在域模型中使用抽象类(或接口)时。默认情况下,Jackson 不知道为接口创建哪个实现。请考虑以下示例
@Entity
public class MyEntity {
@OneToMany
private List<MyInterface> interfaces;
}
在默认配置中,Jackson 不知道在将新数据 POST 到导出器时要实例化哪个类。这是您需要通过注释或(更清晰地)通过使用 Module
注册类型映射来告知 Jackson 的内容。
要将您自己的 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));
}
});
}
一旦您在 Module
中访问了 SetupContext
对象,就可以执行各种操作来配置 Jackson 的 JSON 映射。您可以在 Jackson 的 wiki 上阅读有关 Module
实例如何工作的更多信息。
为域类型添加自定义序列化器
如果要以特殊方式序列化或反序列化域类型,可以将您自己的实现注册到 Jackson 的 ObjectMapper
中,并且 Spring Data REST 导出器会透明地正确处理这些域对象。要从 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);
}