跳到主要内容
版本:5.1.1

定制 Spring Data REST

Doubao 中英对照 Customizing Spring Data REST

有很多选项可以对 Spring Data REST 进行定制。以下各小节将展示具体做法。

定制项资源 URI​

默认情况下,项资源的 URI 由集合资源所使用的路径段附加数据库标识符构成。这让您可以使用仓库的 findOne(…) 方法来查找实体实例。自 Spring Data REST 2.5 起,可以通过 RepositoryRestConfiguration 上的配置 API(在 Java 8 上首选),或通过在应用中将 EntityLookup 的实现注册为 Spring bean 来对此进行定制。Spring Data REST 会自动获取这些实现,并根据其实现调整 URI 的生成。

假设有一个 User,其 username 属性可唯一标识该用户。再假设对应的仓库上有一个 Optional<User> findByUsername(String username) 方法。

在 Java 8 上,我们可以将映射方法注册为方法引用来调整 URI 的创建,如下所示:

@Component
public class SpringDataRestCustomization implements RepositoryRestConfigurer {

@Override
public void configureRepositoryRestConfiguration(RepositoryRestConfiguration config) {
config.withEntityLookup()
.forRepository(UserRepository.class)
.withIdMapping(User::getUsername)
.withLookup(UserRepository::findByUsername);
}
}

forRepository(…) 以仓库类型作为第一个参数,以将仓库领域类型映射为某个目标类型的方法引用作为第二个参数,并以另一个方法引用作为参数,通过第一个参数所指定的仓库将该值映射回来。

如果您运行的不是 Java 8 或更高版本,也可以使用该方法,但这会需要若干相当冗长的匿名内部类。在较旧的 Java 版本上,您或许更应选择实现一个类似于下面这样的 UserEntityLookup:

@Component
public class UserEntityLookup extends EntityLookupSupport<User> {

private final UserRepository repository;

public UserEntityLookup(UserRepository repository) {
this.repository = repository;
}

@Override
public Serializable getResourceIdentifier(User entity) {
return entity.getUsername();
}

@Override
public Object lookupEntity(Serializable id) {
return repository.findByUsername(id.toString());
}
}

请注意 getResourceIdentifier(…) 如何返回供 URI 创建使用的用户名。为了按该方法返回的值加载实体实例,我们现在使用 UserRepository 上可用的查询方法来实现 lookupEntity(…)。

定制仓库暴露​

默认情况下,所有 public 的 Spring Data 仓库都会像 仓库资源 中所述那样用于暴露 HTTP 资源。包级私有(package protected)的仓库接口不在此列,因为这表明其功能仅对包内部可见。可以通过在 RepositoryRestConfiguration 上显式设置 RepositoryDetectionStrategy(通常通过枚举 RepositoryDetectionStrategies)来对此进行定制。可以配置以下值:

  • ALL —— 暴露所有 Spring Data 仓库,无论其 Java 可见性或注解配置如何。

  • DEFAULT —— 暴露 public 的 Spring Data 仓库,或显式标注了 @RepositoryRestResource 且其 exported 属性未设为 false 的仓库。

  • VISIBILITY —— 仅暴露 public 的 Spring Data 仓库,无论注解配置如何。

  • ANNOTATED —— 仅暴露显式标注了 @RepositoryRestResource 且其 exported 属性未设为 false 的 Spring Data 仓库。

如果您需要应用自定义规则,只需手动实现 RepositoryDetectionStrategy。

定制支持的 HTTP 方法​

定制默认暴露​

默认情况下,Spring Data REST 会根据仓库所暴露的 CRUD 方法,像 仓库资源 中所述那样暴露 HTTP 资源与方法。仓库无需扩展 CrudRepository,也可以选择性地声明上述小节中描述的方法,资源暴露会随之进行。例如,如果某个仓库不暴露 delete(…) 方法,那么项资源将不支持 HTTP DELETE。

如果您需要声明一个仅供内部使用的方法,但又不希望它触发 HTTP 方法的暴露,可以为该仓库方法标注 @RestResource(exported = false)。应像这样标注哪些方法以移除对哪些 HTTP 方法的支持,已在 仓库资源 中描述。

有时在方法级别上管理暴露还不够精细。例如,save(…) 方法既用于支撑集合资源上的 POST,也用于支撑项资源上的 PUT 和 PATCH。要选择性地定义应暴露哪些 HTTP 方法,您可以使用 RepositoryRestConfiguration.getExposureConfiguration()。

该类暴露了一个基于 Lambda 的 API,用于定义全局规则和基于类型的规则:

ExposureConfiguration config = repositoryRestConfiguration.getExposureConfiguration();

config.forDomainType(User.class).disablePutForCreation(); 1
config.withItemExposure((metadata, httpMethods) -> httpMethods.disable(HttpMethod.PATCH)); 2
  • 禁用通过 HTTP PUT 直接创建项资源的支持。

  • 禁用对所有项资源的 HTTP PATCH 支持。

本节小结​

📄️覆盖 Spring Data REST 响应处理器

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

📄️向 Jackson 的 ObjectMapper 添加自定义序列化器与反序列化器

有时, Spring Data REST 的 ObjectMapper (经过专门配置,使用智能序列化器,可将领域对象转换为链接并再转换回来)的行为可能无法正确处理您的领域模型。您组织数据的方式多种多样,可能会发现自己的领域模型无法正确地转换为 JSON 。在这些情况下,以通用方式支持复杂的领域模型有时并不现实。有时,根据其复杂程度,甚至不可能提供通用的解决方案。