Spring Data 扩展

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

Querydsl 扩展

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

Querydsl 的维护已经放缓，社区已在 OpenFeign 下 fork 了该项目，地址为 github.com/OpenFeign/querydsl (groupId io.github.openfeign.querydsl)。Spring Data 在力所能及的范围内支持这个 fork 项目。

一些 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 相关的组件需要 Spring MVC JAR 包位于 classpath 中。其中一些甚至提供了与 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 controller 方法签名中使用领域类型，这样您就不需要手动通过 repository 查找实例，如下例所示

在方法签名中使用领域类型的 Spring MVC controller

@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 的 HandlerMethodArgumentResolvers

上一节中显示的配置片段还注册了一个 PageableHandlerMethodArgumentResolver 以及一个 SortHandlerMethodArgumentResolver 实例。该注册使得 Pageable 和 Sort 可以作为有效的 controller 方法参数，如下例所示

将 Pageable 用作 controller 方法参数

@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 的索引，默认为 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 controllers 通常会尝试最终向客户端呈现 Spring Data page 的表示。虽然可以直接从处理方法返回 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 中的位于 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` 渲染

如果您不想更改所有现有的 controller，添加映射步骤来返回 PagedModel 而不是 Page，您可以通过如下调整 @EnableSpringDataWebSupport 来启用 PageImpl 实例自动翻译为 PagedModel 的功能

@EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO)
class MyConfiguration { }

这将允许您的 controller 仍然返回 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 用作 controller 方法参数，SlicedResourcesAssembler 的用法完全相同

将 PagedResourcesAssembler 用作 controller 方法参数

@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 可以用作 controller 方法参数。在其上调用 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 指向调用它的 controller 方法，但您可以通过传递一个自定义的 Link 作为基础来构建 pagination 链接来定制它，这将重载 PagedResourcesAssembler.toModel(…) 方法。

Spring Data Jackson 模块

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

在初始化期间，基础设施会拾取 SpringDataJacksonModules，例如 SpringDataJacksonConfiguration，从而使声明的 com.fasterxml.jackson.databind.Module 可用于 Jackson ObjectMapper。

通用基础设施为以下领域类型注册了数据绑定 mixins。

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 数据绑定支持

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

使用 JSONPath 或 XPath 表达式绑定 HTTP payload

@ProjectedPayload
public interface UserPayload {

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

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

您可以使用上面示例中所示的类型作为 Spring MVC handler 方法参数，或通过在 RestTemplate 的方法上使用 ParameterizedTypeReference。上述方法声明将尝试在给定文档中的任何位置查找 firstname。对 lastname 的 XML 查找在传入文档的顶层执行。其 JSON 变体首先尝试查找顶层 lastname，如果前者没有返回值，也会尝试查找嵌套在 user 子文档中的 lastname。这样，可以轻松缓解源文档结构的变化，而无需客户端调用暴露的方法（这通常是基于类的 payload 绑定的缺点）。

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

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

更多信息，请参阅规范 Spring Data Examples 仓库中的 web projection 示例。

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` 属性。

您可以在应用来自 repository 或 @QuerydslPredicate 的特定绑定之前，注册一个持有默认 Querydsl 绑定的 QuerydslBinderCustomizerDefaults bean。

Repository 填充器

如果您使用 Spring JDBC 模块，您可能熟悉使用 SQL 脚本填充 DataSource 的支持。在 repositories 级别也有类似的抽象，尽管它不使用 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 填充器

<?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 填充器（使用 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 的 HandlerMethodArgumentResolvers

为 Page 创建 JSON 表示

使用 Spring Data 的 PagedModel

全局启用简化的 Page 渲染

对 Page 和 Slice 的超媒体支持

Spring Data Jackson 模块

Web 数据绑定支持

Querydsl Web 支持

Repository 填充器

使用 `DomainClassConverter` 类

为 `Page` 创建 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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