Spring Data 扩展

本节介绍了一组 Spring Data 扩展，这些扩展使得 Spring Data 可以在各种上下文中使用。目前，大部分集成是针对 Spring MVC 的。

Querydsl 扩展

Querydsl 是一个框架，通过其流畅的 API 可以构建静态类型化的类似 SQL 的查询。

Querydsl 的维护已放缓，社区在 OpenFeign 下分叉了该项目，地址为 github.com/OpenFeign/querydsl (groupId io.github.openfeign.querydsl)。Spring Data 尽力支持此分叉项目。

几个 Spring Data 模块通过 QuerydslPredicateExecutor 提供了与 Querydsl 的集成，示例如下

QuerydslPredicateExecutor 接口

public interface QuerydslPredicateExecutor<T> {

  Optional<T> findById(Predicate predicate);  (1)

  Iterable<T> findAll(Predicate predicate);   (2)

  long count(Predicate predicate);            (3)

  boolean exists(Predicate predicate);        (4)

  // … more functionality omitted.
}

1	查找并返回与 `Predicate` 匹配的单个实体。
2	查找并返回与 `Predicate` 匹配的所有实体。
3	返回与 `Predicate` 匹配的实体数量。
4	返回是否存在与 `Predicate` 匹配的实体。

要使用 Querydsl 支持，请在您的 repository 接口上扩展 QuerydslPredicateExecutor，示例如下

Repository 上的 Querydsl 集成

interface UserRepository extends CrudRepository<User, Long>, QuerydslPredicateExecutor<User> {
}

前面的示例允许您通过使用 Querydsl Predicate 实例来编写类型安全的查询，示例如下

Predicate predicate = user.firstname.equalsIgnoreCase("dave")
	.and(user.lastname.startsWithIgnoreCase("mathews"));

userRepository.findAll(predicate);

Web 支持

支持 repository 编程模型的 Spring Data 模块提供各种 Web 支持。Web 相关组件需要在 classpath 中包含 Spring MVC JAR。其中一些甚至提供了与 Spring HATEOAS 的集成。通常，通过在您的 JavaConfig 配置类中使用 @EnableSpringDataWebSupport 注解来启用集成支持，示例如下

启用 Spring Data Web 支持

Java
XML

@Configuration
@EnableWebMvc
@EnableSpringDataWebSupport
class WebConfiguration {}

<bean class="org.springframework.data.web.config.SpringDataWebConfiguration" />

<!-- If you use Spring HATEOAS, register this one *instead* of the former -->
<bean class="org.springframework.data.web.config.HateoasAwareSpringDataWebConfiguration" />

@EnableSpringDataWebSupport 注解会注册一些组件。我们将在本节稍后讨论这些组件。它还会检测 classpath 中的 Spring HATEOAS，并（如果存在）注册其集成组件。

基本 Web 支持

在 XML 中启用 Spring Data Web 支持

前一节中所示的配置会注册一些基本组件

一个使用 DomainClassConverter 类，允许 Spring MVC 从请求参数或路径变量解析 repository 管理的领域类的实例。
HandlerMethodArgumentResolver 实现，允许 Spring MVC 从请求参数解析 Pageable 和 Sort 实例。
Jackson 模块，用于反序列化/序列化诸如 Point 和 Distance 之类的类型，或特定于存储的类型，具体取决于使用的 Spring Data 模块。

使用 `DomainClassConverter` 类

DomainClassConverter 类允许您在 Spring MVC 控制器方法签名中直接使用领域类型，这样您就不需要通过 repository 手动查找实例，示例如下

使用领域类型作为方法签名的 Spring MVC 控制器

@Controller
@RequestMapping("/users")
class UserController {

  @RequestMapping("/{id}")
  String showUserForm(@PathVariable("id") User user, Model model) {

    model.addAttribute("user", user);
    return "userForm";
  }
}

该方法直接接收 User 实例，无需进一步查找。通过让 Spring MVC 首先将路径变量转换为领域类的 id 类型，然后通过调用为该领域类型注册的 repository 实例上的 findById(…) 方法来访问实例。

目前，repository 必须实现 CrudRepository 才能被发现用于转换。

用于 Pageable 和 Sort 的 HandlerMethodArgumentResolver

前一节中所示的配置代码片段还注册了 PageableHandlerMethodArgumentResolver 和 SortHandlerMethodArgumentResolver 的一个实例。该注册使得 Pageable 和 Sort 成为有效的控制器方法参数，示例如下

使用 Pageable 作为控制器方法参数

@Controller
@RequestMapping("/users")
class UserController {

  private final UserRepository repository;

  UserController(UserRepository repository) {
    this.repository = repository;
  }

  @RequestMapping
  String showUsers(Model model, Pageable pageable) {

    model.addAttribute("users", repository.findAll(pageable));
    return "users";
  }
}

前面的方法签名会使 Spring MVC 尝试使用以下默认配置从请求参数中派生一个 Pageable 实例

表 1. 为 `Pageable` 实例评估的请求参数
`page`	您想要检索的页码。0-indexed，默认为 0。
`size`	您想要检索的页大小。默认为 20。
`sort`	应按以下格式排序的属性：`property,property(,ASC\|DESC)(,IgnoreCase)`。默认排序方向是区分大小写的升序。如果您想更改方向或大小写敏感性，请使用多个 `sort` 参数，例如 `?sort=firstname&sort=lastname,asc&sort=city,ignorecase`。

要自定义此行为，请注册一个实现 PageableHandlerMethodArgumentResolverCustomizer 接口或 SortHandlerMethodArgumentResolverCustomizer 接口的 bean。它们的 customize() 方法将被调用，允许您更改设置，示例如下

@Bean SortHandlerMethodArgumentResolverCustomizer sortCustomizer() {
    return s -> s.setPropertyDelimiter("<-->");
}

如果设置现有 MethodArgumentResolver 的属性不足以满足您的目的，请扩展 SpringDataWebConfiguration 或支持 HATEOAS 的等效类，重写 pageableResolver() 或 sortResolver() 方法，并导入您的自定义配置而不是使用 @Enable 注解。

如果您需要从请求中解析多个 Pageable 或 Sort 实例（例如，针对多个表格），您可以使用 Spring 的 @Qualifier 注解来区分它们。请求参数必须以 ${qualifier}_ 为前缀。以下示例显示了结果方法签名

String showUsers(Model model,
      @Qualifier("thing1") Pageable first,
      @Qualifier("thing2") Pageable second) { … }

您必须填充 thing1_page、thing2_page 等。

传递给方法的默认 Pageable 相当于一个 PageRequest.of(0, 20)，但您可以通过在 Pageable 参数上使用 @PageableDefault 注解对其进行自定义。

为 `Page` 创建 JSON 表示

Spring MVC 控制器通常会尝试最终向客户端呈现 Spring Data 页面的表示。虽然可以直接从处理程序方法返回 Page 实例以让 Jackson 按原样呈现它们，但我们强烈建议不要这样做，因为底层实现类 PageImpl 是一个领域类型。这意味着我们可能希望或必须出于不相关的原因更改其 API，并且这些更改可能会以破坏性方式改变生成的 JSON 表示。

从 Spring Data 3.1 开始，我们通过发出一个警告日志来提示这个问题，该日志描述了问题。我们仍然最终建议利用与 Spring HATEOAS 的集成，以一种完全稳定且支持超媒体的方式呈现页面，从而轻松地允许客户端导航它们。但从版本 3.3 开始，Spring Data 提供了一种页面渲染机制，该机制使用方便，但不需要包含 Spring HATEOAS。

使用 Spring Data 的 `PagedModel`

其核心支持包含 Spring HATEOAS 的 PagedModel（Spring Data 的 PagedModel 位于 org.springframework.data.web 包中）的简化版本。它可以用于包装 Page 实例，并生成一个简化的表示，该表示反映了 Spring HATEOAS 建立的结构，但省略了导航链接。

import org.springframework.data.web.PagedModel;

@Controller
class MyController {

  private final MyRepository repository;

  // Constructor ommitted

  @GetMapping("/page")
  PagedModel<?> page(Pageable pageable) {
    return new PagedModel<>(repository.findAll(pageable)); (1)
  }
}

1	将 `Page` 实例包装到 `PagedModel` 中。

这将产生一个看起来像这样的 JSON 结构

{
  "content" : [
     … // Page content rendered here
  ],
  "page" : {
    "size" : 20,
    "totalElements" : 30,
    "totalPages" : 2,
    "number" : 0
  }
}

注意文档如何包含一个 page 字段，公开了必要的 pagination 元数据。

全局启用简化的 `Page` 渲染

如果您不想更改所有现有控制器以添加映射步骤来返回 PagedModel 而不是 Page，您可以通过如下调整 @EnableSpringDataWebSupport 来启用 PageImpl 实例到 PagedModel 的自动转换

@EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO)
class MyConfiguration { }

这将允许您的控制器仍然返回 Page 实例，并且它们将自动渲染为简化的表示形式

@Controller
class MyController {

  private final MyRepository repository;

  // Constructor ommitted

  @GetMapping("/page")
  Page<?> page(Pageable pageable) {
    return repository.findAll(pageable);
  }
}

对 `Page` 和 `Slice` 的超媒体支持

Spring HATEOAS 提供了表示模型类（PagedModel/SlicedModel），它允许使用必要的 Page/Slice 元数据以及链接来丰富 Page 或 Slice 实例的内容，以便客户端轻松导航页面。将 Page 转换为 PagedModel 是由 Spring HATEOAS RepresentationModelAssembler 接口的实现完成的，该实现称为 PagedResourcesAssembler。类似地，可以使用 SlicedResourcesAssembler 将 Slice 实例转换为 SlicedModel。以下示例显示了如何在控制器方法参数中使用 PagedResourcesAssembler，因为 SlicedResourcesAssembler 的工作方式完全相同

使用 PagedResourcesAssembler 作为控制器方法参数

@Controller
class PersonController {

  private final PersonRepository repository;

  // Constructor omitted

  @GetMapping("/people")
  HttpEntity<PagedModel<Person>> people(Pageable pageable,
    PagedResourcesAssembler assembler) {

    Page<Person> people = repository.findAll(pageable);
    return ResponseEntity.ok(assembler.toModel(people));
  }
}

启用配置（如前例所示）后，PagedResourcesAssembler 可以用作控制器方法参数。调用其 toModel(…) 方法会产生以下效果

Page 的内容成为 PagedModel 实例的内容。
PagedModel 对象附加了一个 PageMetadata 实例，并用来自 Page 和底层 Pageable 的信息填充。
PagedModel 可能会附加 prev 和 next 链接，具体取决于页面的状态。这些链接指向方法映射到的 URI。添加到方法的 pagination 参数与 PageableHandlerMethodArgumentResolver 的设置匹配，以确保链接稍后可以解析。

假设我们在数据库中有 30 个 Person 实例。您现在可以触发一个请求（GET localhost:8080/people）并看到类似于以下内容的输出

{ "links" : [
    { "rel" : "next", "href" : "http://localhost:8080/persons?page=1&size=20" }
  ],
  "content" : [
     … // 20 Person instances rendered here
  ],
  "page" : {
    "size" : 20,
    "totalElements" : 30,
    "totalPages" : 2,
    "number" : 0
  }
}

这里显示的 JSON 封套格式不遵循任何正式规范的结构，并且不能保证稳定，我们随时可能更改它。强烈建议启用作为超媒体支持的官方媒体类型的渲染，由 Spring HATEOAS 支持，例如 HAL。这些可以通过使用其 @EnableHypermediaSupport 注解来激活。更多信息请参见 Spring HATEOAS 参考文档。

assembler 生成了正确的 URI，并且还拾取了默认配置，将参数解析为即将到来的请求的 Pageable。这意味着如果您更改该配置，链接会自动遵守更改。默认情况下，assembler 指向调用它的控制器方法，但您可以通过传递用于构建 pagination 链接的自定义 Link 来定制它，这将重载 PagedResourcesAssembler.toModel(…) 方法。

Spring Data Jackson 模块

核心模块和一些特定于存储的模块提供了一组 Jackson 模块，用于 Spring Data 领域使用的类型，例如 org.springframework.data.geo.Distance 和 org.springframework.data.geo.Point。
一旦启用 Web 支持并且 com.fasterxml.jackson.databind.ObjectMapper 可用，这些模块就会被导入。

在初始化期间，SpringDataJacksonModules（如 SpringDataJacksonConfiguration）会被基础架构拾取，从而使得声明的 com.fasterxml.jackson.databind.Module 可供 Jackson ObjectMapper 使用。

核心基础架构会注册以下领域类型的数据绑定 mixin。

org.springframework.data.geo.Distance
org.springframework.data.geo.Point
org.springframework.data.geo.Box
org.springframework.data.geo.Circle
org.springframework.data.geo.Polygon

各个模块可能提供额外的 SpringDataJacksonModules。
有关更多详细信息，请参阅特定于存储的部分。

Web Databinding 支持

您可以使用 Spring Data 投影（在投影中描述）通过使用 JSONPath 表达式（需要 Jayway JsonPath）或 XPath 表达式（需要 XmlBeam）来绑定传入的请求载荷，示例如下

使用 JSONPath 或 XPath 表达式的 HTTP 载荷绑定

@ProjectedPayload
public interface UserPayload {

  @XBRead("//firstname")
  @JsonPath("$..firstname")
  String getFirstname();

  @XBRead("/lastname")
  @JsonPath({ "$.lastname", "$.user.lastname" })
  String getLastname();
}

您可以在 Spring MVC 处理器方法签名中使用前面示例所示的类型，或者通过在 RestTemplate 的方法之一上使用 ParameterizedTypeReference。前面的方法声明将尝试在给定文档中的任何位置查找 firstname。lastname 的 XML 查找是在传入文档的顶层执行的。其 JSON 变体首先尝试顶层的 lastname，但如果前者没有返回值，也会尝试嵌套在 user 子文档中的 lastname。这样，可以轻松减轻源文档结构的变化，而无需客户端调用公开的方法（这通常是基于类的载荷绑定的缺点）。

支持嵌套投影，如投影中所述。如果方法返回一个复杂的、非接口类型，则使用 Jackson ObjectMapper 来映射最终值。

对于 Spring MVC，一旦激活 @EnableSpringDataWebSupport 并且所需的依赖项在 classpath 中可用，就会自动注册必要的转换器。对于与 RestTemplate 一起使用，请手动注册 ProjectingJackson2HttpMessageConverter (JSON) 或 XmlBeamHttpMessageConverter。

有关更多信息，请参阅规范 Spring Data Examples repository 中的 web projection example。

Querydsl Web 支持

对于那些具有 Querydsl 集成的存储，您可以从 Request 查询字符串中包含的属性派生查询。

考虑以下查询字符串

?firstname=Dave&lastname=Matthews

给定前面示例中的 User 对象，您可以使用 QuerydslPredicateArgumentResolver 将查询字符串解析为以下值，如下所示

QUser.user.firstname.eq("Dave").and(QUser.user.lastname.eq("Matthews"))

当在 classpath 中找到 Querydsl 时，此功能会与 @EnableSpringDataWebSupport 一起自动启用。

在方法签名中添加 @QuerydslPredicate 提供了一个即用型的 Predicate，您可以使用 QuerydslPredicateExecutor 来运行它。

类型信息通常从方法的返回类型解析。由于该信息不一定与领域类型匹配，因此最好使用 QuerydslPredicate 的 root 属性。

以下示例显示了如何在方法签名中使用 @QuerydslPredicate

@Controller
class UserController {

  @Autowired UserRepository repository;

  @RequestMapping(value = "/", method = RequestMethod.GET)
  String index(Model model, @QuerydslPredicate(root = User.class) Predicate predicate,    (1)
          Pageable pageable, @RequestParam MultiValueMap<String, String> parameters) {

    model.addAttribute("users", repository.findAll(predicate, pageable));

    return "index";
  }
}

1	将查询字符串参数解析为与 `User` 匹配的 `Predicate`。

默认绑定如下：

简单属性上的 Object 作为 eq。
类似集合属性上的 Object 作为 contains。
简单属性上的 Collection 作为 in。

您可以通过 @QuerydslPredicate 的 bindings 属性或利用 Java 8 的 default methods 并将 QuerydslBinderCustomizer 方法添加到 repository 接口来定制这些绑定，如下所示

interface UserRepository extends CrudRepository<User, String>,
                                 QuerydslPredicateExecutor<User>,                (1)
                                 QuerydslBinderCustomizer<QUser> {               (2)

  @Override
  default void customize(QuerydslBindings bindings, QUser user) {

    bindings.bind(user.username).first((path, value) -> path.contains(value))    (3)
    bindings.bind(String.class)
      .first((StringPath path, String value) -> path.containsIgnoreCase(value)); (4)
    bindings.excluding(user.password);                                           (5)
  }
}

1	`QuerydslPredicateExecutor` 提供对特定查找方法的访问，用于 `Predicate`。
2	在 repository 接口上定义的 `QuerydslBinderCustomizer` 会自动拾取，并简化 `@QuerydslPredicate(bindings=…)`。
3	定义 `username` 属性的绑定为一个简单的 `contains` 绑定。
4	将 `String` 属性的默认绑定定义为不区分大小写的 `contains` 匹配。
5	从 `Predicate` 解析中排除 `password` 属性。

您可以注册一个包含默认 Querydsl 绑定的 QuerydslBinderCustomizerDefaults bean，然后再应用来自 repository 或 @QuerydslPredicate 的特定绑定。

Repository Populators

如果您使用 Spring JDBC 模块，您可能熟悉使用 SQL 脚本填充 DataSource 的支持。repository 级别也有类似的抽象，尽管它不使用 SQL 作为数据定义语言，因为它必须与存储无关。因此，populators 支持 XML（通过 Spring 的 OXM 抽象）和 JSON（通过 Jackson）来定义用于填充 repository 的数据。

假设您有一个名为 data.json 的文件，其内容如下

JSON 中定义的数据

[ { "_class" : "com.acme.Person",
 "firstname" : "Dave",
  "lastname" : "Matthews" },
  { "_class" : "com.acme.Person",
 "firstname" : "Carter",
  "lastname" : "Beauford" } ]

您可以使用 Spring Data Commons 中提供的 repository 命名空间的 populator 元素来填充您的 repository。要将前面的数据填充到您的 PersonRepository，请声明一个类似于以下的 populator

声明 Jackson repository populator

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:repository="http://www.springframework.org/schema/data/repository"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/data/repository
    https://www.springframework.org/schema/data/repository/spring-repository.xsd">

  <repository:jackson2-populator locations="classpath:data.json" />

</beans>

前面的声明会使 data.json 文件被 Jackson ObjectMapper 读取和反序列化。

用于反序列化 JSON 对象的类型由检查 JSON 文档的 _class 属性来确定。基础架构最终选择适当的 repository 来处理已反序列化的对象。

如果您想改为使用 XML 定义要填充 repository 的数据，可以使用 unmarshaller-populator 元素。您将其配置为使用 Spring OXM 中可用的 XML marshaller 选项之一。详细信息请参阅 Spring 参考文档。以下示例显示了如何使用 JAXB 解组 repository populator

声明一个解组 repository populator（使用 JAXB）

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:repository="http://www.springframework.org/schema/data/repository"
  xmlns:oxm="http://www.springframework.org/schema/oxm"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/data/repository
    https://www.springframework.org/schema/data/repository/spring-repository.xsd
    http://www.springframework.org/schema/oxm
    https://www.springframework.org/schema/oxm/spring-oxm.xsd">

  <repository:unmarshaller-populator locations="classpath:data.json"
    unmarshaller-ref="unmarshaller" />

  <oxm:jaxb2-marshaller contextPath="com.acme" />

</beans>

Spring Data 扩展

Querydsl 扩展

Web 支持

基本 Web 支持

使用 DomainClassConverter 类

用于 Pageable 和 Sort 的 HandlerMethodArgumentResolver

为 Page 创建 JSON 表示

使用 Spring Data 的 PagedModel

全局启用简化的 Page 渲染

对 Page 和 Slice 的超媒体支持

Spring Data Jackson 模块

Web Databinding 支持

Querydsl Web 支持

Repository Populators

使用 `DomainClassConverter` 类

为 `Page` 创建 JSON 表示

使用 Spring Data 的 `PagedModel`

全局启用简化的 `Page` 渲染

对 `Page` 和 `Slice` 的超媒体支持