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 相关组件需要在 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 Modules，用于序列化/反序列化诸如 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 controller 尝试最终将 Spring Data 页面的表示渲染给客户端是很常见的。虽然可以直接从 handler 方法返回 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 是通过一个名为 PagedResourcesAssembler 的 Spring HATEOAS RepresentationModelAssembler 接口实现完成的。同样，Slice 实例可以使用 SlicedResourcesAssembler 转换为 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 Modules

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

在初始化期间，基础架构会拾取 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 projections（在 Projections 中描述）通过 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 handler 方法参数，或通过在 RestTemplate 的方法上使用 ParameterizedTypeReference。前面的方法声明会尝试在给定文档中的任意位置查找 firstname。lastname XML 查找在传入文档的顶层执行。其 JSON 变体首先尝试查找顶层 lastname，如果前者没有返回值，则还会尝试查找嵌套在 user 子文档中的 lastname。通过这种方式，可以轻松地减轻源文档结构的变化，而无需客户端调用暴露的方法（通常是基于类的负载绑定的一个缺点）。

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

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

有关更多信息，请参阅规范的 Spring Data Examples repository 中的 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` 属性。

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

Repository Populators

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

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

以 JSON 定义的数据

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

你可以通过使用 Spring Data Commons 中提供的 repository 命名空间的 populator 元素来填充你的 repositories。要将上述数据填充到你的 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>

上述声明会导致 Jackson ObjectMapper 读取并反序列化 data.json 文件。

JSON 对象要反封送的目标类型是通过检查 JSON 文档的 _class 属性来确定的。基础架构最终会选择合适的 repository 来处理反序列化的对象。

如果想改用 XML 来定义应填充 repositories 的数据，可以使用 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 的 HandlerMethodArgumentResolvers

为 Page 创建 JSON 表示

使用 Spring Data 的 PagedModel

全局启用简化的 Page 渲染

Page 和 Slice 的超媒体支持

Spring Data Jackson Modules

Web 数据绑定支持

Querydsl Web 支持

Repository Populators

使用 `DomainClassConverter` 类

为 `Page` 创建 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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