跳到主要内容
版本:5.1.1

覆盖 Spring Data REST 响应处理器

Doubao 中英对照 Overriding Spring Data REST Response Handlers

有时,您可能想为某个特定资源编写自定义处理器。为了利用 Spring Data REST 的设置、消息转换器、异常处理等能力,请使用 @RepositoryRestController 注解,而不是标准的 Spring MVC @Controller 或 @RestController。使用 @RepositoryRestController 注解的控制器,其服务路径取自 RepositoryRestConfiguration.setBasePath 中定义的 API 基础路径,该路径也为所有其他 RESTful 端点所用(例如 /api)。以下示例展示了如何使用 @RepositoryRestController 注解:

@RepositoryRestController
class ScannerController {

private final ScannerRepository repository;

ScannerController(ScannerRepository repository) { 1
this.repository = repository;
}

@GetMapping(path = "/scanners/search/producers") 2
ResponseEntity<?> getProducers() {

List<String> producers = repository.listProducers(); 3

// do some intermediate processing, logging, etc. with the producers

CollectionModel<String> resources = CollectionModel.of(producers); 4

resources.add(linkTo(methodOn(ScannerController.class).getProducers()).withSelfRel()); 5

// add other links as needed

return ResponseEntity.ok(resources); 6
}
}
  • 本示例使用构造器注入。

  • 该处理器将一个自定义处理器方法作为查询方法资源接入。

  • 该处理器使用底层仓库获取数据,但在将最终数据集返回给客户端之前先进行某种形式的后处理。

  • 类型 T 的结果需要包装在 Spring HATEOAS 的 CollectionModel<T> 对象中,以返回一个集合。对于单个条目,EntityModel<T> 或 RepresentationModel<T> 分别是合适的包装器。

  • 添加一个指回该方法本身的链接,作为 self 链接。

  • 使用 Spring MVC 的 ResponseEntity 包装器返回集合,可确保集合被正确包装,并以合适的 Accept 类型渲染。

CollectionModel 用于集合,而 EntityModel——或更通用的类 RepresentationModel——用于单个条目。这些类型可以组合使用。如果您知道集合中每个条目的链接,请使用 CollectionModel<EntityModel<String>>(或任何核心领域类型,而非 String)。这样做既可以为整个集合组装链接,也可以为每个条目组装链接。

important

在本示例中,组合后的路径为 RepositoryRestConfiguration.getBasePath() + /scanners/search/producers。

获取聚合引用​

对于接收 PUT 和 POST 请求的自定义控制器,请求体通常包含一个 JSON 文档,其中会使用 URI 来表达对其他资源的引用。对于 GET 请求,这些引用通过请求参数传入。

自 Spring Data REST 4.1 起,我们提供了 AggregateReference<T, ID>,用作处理器方法参数类型,以捕获此类引用并将其解析为被引用聚合的标识符、聚合本身,或一个 jMolecules Association。您只需声明一个该类型的 @RequestParam,然后使用标识符或完全解析后的聚合即可。

@RepositoryRestController
class ScannerController {

private final ScannerRepository repository;

ScannerController(ScannerRepository repository) {
this.repository = repository;
}

@GetMapping(path = "/scanners")
ResponseEntity<?> getProducers(
@RequestParam AggregateReference<Producer, ProducerIdentifier> producer) {

var identifier = producer.resolveRequiredId();
// Alternatively
var aggregate = producer.resolveRequiredAggregate();
}

// Alternatively

@GetMapping(path = "/scanners")
ResponseEntity<?> getProducers(
@RequestParam AssociationAggregateReference<Producer, ProducerIdentifier> producer) {

var association = producer.resolveRequiredAssociation();
}
}

如果您使用 jMolecules,AssociationAggregateReference 还允许您获取一个 Association。虽然这两种抽象都假定参数的值是一个 URI,且其方案与 Spring Data REST 用于暴露项资源的方案相匹配,但可以通过在引用实例上调用 ….withIdSource(…) 来自定义该源值的解析,从而提供一个函数,最终从所接收 URI 得到的 UriComponents 中提取用于聚合解析的标识符值。

@RepositoryRestController 与 @BasePathAwareController 之比较​

如果您对特定于实体的操作不感兴趣,但仍想在 basePath 之下构建自定义操作,例如 Spring MVC 视图、资源等,请使用 @BasePathAwareController。如果您在自定义控制器上使用 @RepositoryRestController,那么只有当您的请求映射融入了仓库所使用的 URI 空间时,它才会处理该请求。它还会对控制器方法应用以下额外功能:

  1. 根据映射到处理器方法请求映射中所用基础路径段的仓库所定义的方式进行 CORS 配置。

  2. 如果使用 JPA,则应用一个 OpenEntityManagerInViewInterceptor,以确保您可以访问被标记为延迟解析的属性。

注意

如果您出于任何目的使用 @Controller 或 @RestController,那段代码就完全处于 Spring Data REST 的作用域之外。这包括请求处理、消息转换器、异常处理及其他用途。