Spring Data 扩展

本节介绍一组 Spring Data 扩展，这些扩展使 Spring Data 能够在各种环境中使用。目前，大多数集成都针对 Spring MVC。

Querydsl 扩展

Querydsl 是一个框架，它通过其流畅的 API 使得构建静态类型 SQL 类查询成为可能。

几个 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 支持，请在您的存储库接口上扩展 QuerydslPredicateExecutor，如下例所示

存储库上的 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 支持

支持存储库编程模型的 Spring Data 模块附带各种 Web 支持。与 Web 相关的组件需要 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 注解注册了一些组件。我们将在本节后面讨论这些组件。它还会检测类路径上的 Spring HATEOAS，并为其注册集成组件（如果存在）。

基本 Web 支持

在 XML 中启用 Spring Data Web 支持

在 上一节 中显示的配置注册了一些基本组件

  • 一个 使用 DomainClassConverter 类，让 Spring MVC 从请求参数或路径变量中解析存储库管理的域类的实例。

  • HandlerMethodArgumentResolver 实现，让 Spring MVC 从请求参数中解析 Pageable 和 Sort 实例。

  • Jackson 模块 用于反序列化/序列化 Point 和 Distance 等类型，或存储特定类型（取决于使用的 Spring Data 模块）。

使用 DomainClassConverter 类

DomainClassConverter 类允许您在 Spring MVC 控制器方法签名中直接使用域类型，因此您无需通过存储库手动查找实例，如下例所示

使用方法签名中域类型的 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 类型，并最终通过调用为域类型注册的存储库实例上的 findById(…) 来解析该实例。

目前，存储库必须实现 CrudRepository 才能有资格被发现以进行转换。

用于 Pageable 和 Sort 的 HandlerMethodArgumentResolvers

在上一节中展示的配置片段还注册了一个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 开始索引，默认值为 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 中位于 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 字段，它公开了基本的分页元数据。

全局启用简化的 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。类似地，Slice 实例可以使用 SlicedResourcesAssembler 转换为 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。添加到方法的分页参数与 PageableHandlerMethodArgumentResolver 的设置匹配，以确保链接稍后可以解析。

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

{ "links" : [
    { "rel" : "next", "href" : "https://127.0.0.1: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 参考文档 中查找更多信息。

组装器生成了正确的 URI，并且还拾取了默认配置以将参数解析为即将到来的请求的 Pageable。这意味着，如果您更改该配置，链接会自动适应更改。默认情况下，组装器指向调用它的控制器方法，但您可以通过传递一个自定义 Link 来定制它，该 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。

通用基础设施会为以下域类型注册数据绑定混入。

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）来绑定传入的请求有效负载，如下例所示

使用 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 处于活动状态并且类路径上存在所需的依赖项，必要的转换器就会自动注册。对于与 RestTemplate 的使用，请手动注册 ProjectingJackson2HttpMessageConverter（JSON）或 XmlBeamHttpMessageConverter。

有关更多信息，请参阅规范 Spring Data 示例存储库 中的 web 投影示例。

Querydsl Web 支持

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

考虑以下查询字符串

?firstname=Dave&lastname=Matthews

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

QUser.user.firstname.eq("Dave").and(QUser.user.lastname.eq("Matthews"))
当在类路径上找到 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方法添加到存储库接口，如下所示

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 在存储库接口上定义的QuerydslBinderCustomizer会自动被拾取，并作为@QuerydslPredicate(bindings=…​)的快捷方式。
3 将username属性的绑定定义为简单的contains绑定。
4 将String属性的默认绑定定义为不区分大小写的contains匹配。
5 从Predicate解析中排除password属性。
您可以在应用存储库或@QuerydslPredicate中的特定绑定之前，注册一个包含默认 Querydsl 绑定的QuerydslBinderCustomizerDefaults bean。

存储库填充器

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

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

以 JSON 定义的数据
[ { "_class" : "com.acme.Person",
 "firstname" : "Dave",
  "lastname" : "Matthews" },
  { "_class" : "com.acme.Person",
 "firstname" : "Carter",
  "lastname" : "Beauford" } ]

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

声明一个 Jackson 存储库填充器
<?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属性来确定的。基础设施最终会选择合适的存储库来处理反序列化的对象。

要改为使用 XML 来定义存储库应该填充的数据，您可以使用unmarshaller-populator元素。您可以将其配置为使用 Spring OXM 中提供的 XML 序列化器选项之一。有关详细信息，请参阅Spring 参考文档。以下示例展示了如何使用 JAXB 反序列化存储库填充器

声明一个反序列化存储库填充器（使用 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>