跳到主要内容
版本:5.1.1

定制 JSON 输出

Doubao 中英对照 Customizing the JSON Output

有时,在您的应用中,您需要从某个特定实体提供指向其他资源的链接。例如,Customer 响应可能会被丰富为包含指向当前购物车的链接,或用于管理与该实体相关资源的链接。Spring Data REST 提供了与 Spring HATEOAS 的集成,并提供了一个扩展钩子,让您可以改变发往客户端的资源表示。

RepresentationModelProcessor 接口​

Spring HATEOAS 定义了一个 RepresentationModelProcessor<> 接口用于处理实体。所有类型为 RepresentationModelProcessor<EntityModel<T>> 的 bean 都会被 Spring Data REST 导出器自动获取,并在序列化类型为 T 的实体时触发。

例如,要为 Person 实体定义一个处理器,请向您的 ApplicationContext 添加一个类似于下面这样的 @Bean(取自 Spring Data REST 测试):

@Bean
public RepresentationModelProcessor<EntityModel<Person>> personProcessor() {

return new RepresentationModelProcessor<EntityModel<Person>>() {

@Override
public EntityModel<Person> process(EntityModel<Person> model) {

model.add(new Link("http://localhost:8080/people", "added-link"));
return model;
}
};
}
important

前述示例硬编码了指向 [localhost:8080/people](http://localhost:8080/people) 的链接。如果您的应用内部有一个希望链接到的 Spring MVC 端点,请考虑使用 Spring HATEOAS 的 linkTo(…) 方法,以避免手动管理 URL。

您可以通过调用 model.add(Link) 向实体的默认表示添加链接,如前述示例所示。您添加到 EntityModel 的任何链接都会被加入最终输出。

定制表示​

Spring Data REST 导出器在创建输出表示之前,会运行所有已发现的 RepresentationModelProcessor 实例。它通过向内部的 ConversionService 注册一个 Converter<Entity, EntityModel> 实例来实现这一点。该组件负责创建指向被引用实体的链接(例如对象 JSON 表示中 _links 属性下的那些对象)。它接收一个 @Entity,遍历其属性,为那些由 Repository 管理的属性创建链接,并复制任何嵌入属性或简单属性。

但是,如果您的项目需要以不同的格式输出,您可以用自己的实现完全替换默认的对外 JSON 表示。如果您在 ApplicationContext 中注册自己的 ConversionService,并注册自己的 Converter<Entity, EntityModel>,您就可以返回自己选择的 EntityModel 实现。