覆盖 Spring Data REST 响应处理程序

有时，您可能希望为特定资源编写自定义处理程序。要利用 Spring Data REST 的设置、消息转换器、异常处理等，请使用注释而不是标准的 Spring MVC 或 . 带注释的控制器从中定义的 API 基本路径提供，该路径由所有其他 RESTful 端点（例如）使用。以下示例演示如何使用注释：@RepositoryRestController@Controller@RestController@RepositoryRestControllerRepositoryRestConfiguration.setBasePath/api@RepositoryRestControllerspring-doc.cn

@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)
  }
}

1	此示例使用构造函数注入。
2	此处理程序将自定义处理程序方法作为查询方法资源插入
3	此处理程序使用底层存储库来获取数据，但在将最终数据集返回给客户端之前，会进行某种形式的后处理。
4	类型 T 的结果需要包装在 Spring HATEOAS 对象中以返回集合。或分别是单个项目的合适包装器。`CollectionModel<T>EntityModel<T>RepresentationModel<T>`
5	将链接添加回此确切方法的链接作为链接。`self`
6	使用 Spring MVC 的包装器返回集合可确保集合被正确包装并以正确的 accept 类型呈现。`ResponseEntity`

CollectionModel用于集合，而 — 或更通用的类 — 用于单个项目。这些类型可以组合使用。如果您知道集合中每个项目的链接，请使用（或任何核心域类型，而不是）。这样做可以为每个项目以及整个集合组合链接。EntityModelRepresentationModelCollectionModel<EntityModel<String>>Stringspring-doc.cn

在此示例中，组合路径为 + 。RepositoryRestConfiguration.getBasePath()/scanners/search/producers

获取聚合引用

对于接收和请求的自定义控制器，请求正文通常包含一个 JSON 文档，该文档将使用 URI 来表示对其他资源的引用。对于请求，这些引用通过 request 参数提交。PUTPOSTGETspring-doc.cn

从 Spring Data REST 4.1 开始，我们提供用作处理程序方法参数类型来捕获此类引用并将其解析为引用的聚合的标识符、聚合本身或 jMolecules。您需要做的就是声明该类型的 an，然后使用标识符或完全解析的聚合。AggregateReference<T, ID>Association@RequestParamspring-doc.cn

@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，还允许您获得 . 虽然这两个抽象都假定参数的值是与 Spring Data REST 用于公开项目资源的方案匹配的 URI，但可以通过调用引用实例来自定义该源值解析，以提供一个函数来提取标识符值，以最终从收到的 URI 中获取用于聚合解析。AssociationAggregateReferenceAssociation….withIdSource(…)UriComponentsspring-doc.cn

`@RepositoryRestController`与。`@BasePathAwareController`

如果您对特定于实体的操作不感兴趣，但仍希望在下构建自定义操作，例如 Spring MVC 视图、资源等，请使用 . 如果你在自定义控制器上使用，则仅当你的请求映射混合到存储库使用的 URI 空间时，它才会处理请求。它还会将以下额外功能应用于控制器方法：basePath@BasePathAwareController@RepositoryRestControllerspring-doc.cn

根据存储库的定义进行 CORS 配置，该存储库映射到处理程序方法的请求映射中使用的基本路径段。spring-doc.cn
如果 JPA 用于确保您可以访问标记为延迟解析的属性，则应用 JPA。OpenEntityManagerInViewInterceptorspring-doc.cn

如果您使用或用于任何内容，则该代码完全超出 Spring Data REST 的范围。这扩展到请求处理、消息转换器、异常处理和其他用途。@Controller@RestController

覆盖 Spring Data REST 响应处理程序

获取聚合引用

@RepositoryRestController与。@BasePathAwareController

`@RepositoryRestController`与。`@BasePathAwareController`