在 Jackson 的 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;
}

在默认配置中,Jackson 不知道在将新数据 POST 到导出器时要实例化哪个类。您需要通过注解或更简洁地通过使用 模块 注册类型映射来告诉 Jackson。

在您的 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 上模块的工作原理

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

如果您想以特殊方式序列化或反序列化领域类型,您可以将您自己的实现与 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 在您的领域对象过于复杂以至于 Spring Data REST 尝试涵盖的 80% 通用用例无法处理时,可以正确处理它们。