对于最新的稳定版本,请使用 Spring Data REST 4.5.3! |
域对象表示 (对象映射)
Spring Data REST 返回对应于Accept
HTTP 请求中指定的类型。
目前,仅支持 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 不知道在将新数据发布到导出器时要实例化哪个类。这是你需要通过注释或(更干净地)通过使用Module
.
要将您自己的 Jackson 配置添加到ObjectMapper
Spring Data REST 使用,覆盖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));
}
});
}
一旦您有权访问SetupContext
对象Module
,您可以做各种很酷的事情来配置 Jackson 的 JSON 映射。您可以阅读有关如何作的更多信息Module
实例在Jackson的维基上工作。
为域类型添加自定义序列化程序
如果您想以特殊方式序列化或反序列化域类型,您可以使用 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);
}