Spring Data Extensions _ Spring Data3.2.7中文文档(官方文档中文翻译)|Spring 教程 —

对于最新的稳定版本，请使用 Spring Data Commons 3.3.1！

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

Querydsl 扩展

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

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

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);

1	查找并返回与匹配的单个实体。`Predicate`
2	查找并返回与匹配的所有实体。`Predicate`
3	返回与匹配的实体数。`Predicate`
4	返回与匹配的实体是否存在。`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" />

注释注册了几个组件。我们将在本节后面讨论这些问题。它还会在类路径上检测 Spring HATEOAS，并为其注册集成组件（如果存在）。@EnableSpringDataWebSupport

基本 Web 支持

在 XML 中启用 Spring Data Web 支持

上一节中所示的配置注册了几个基本组件：

A 使用 DomainClassConverter 类让 Spring MVC 从请求参数或路径变量解析存储库托管域类的实例。
HandlerMethodArgumentResolver 实现，让 Spring MVC 从请求参数解析和实例。PageableSort
Jackson 模块，用于反序列化类型（如和）或存储特定类型，具体取决于使用的 Spring Data 模块。PointDistance

使用类`DomainClassConverter`

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

在方法签名中使用域类型的 Spring MVC 控制器

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

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

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

该方法直接接收实例，无需进一步查找。可以通过让 Spring MVC 首先将路径变量转换为域类的类型，并最终通过调用为域类型注册的存储库实例来访问实例来解析实例。UseridfindById(…)

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

用于分页和排序的 HandlerMethodArgumentResolvers

上一节中显示的配置代码段还注册了的实例。注册启用和作为有效的控制器方法参数，如以下示例所示：PageableHandlerMethodArgumentResolverSortHandlerMethodArgumentResolverPageableSort

使用 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`

要自定义此行为，请分别注册实现接口或接口的 Bean。调用其方法，允许您更改设置，如以下示例所示：PageableHandlerMethodArgumentResolverCustomizerSortHandlerMethodArgumentResolverCustomizercustomize()

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

如果设置现有属性不足以满足您的目的，请扩展任一或启用 HATEOAS 的等效项，重写 or 方法，然后导入自定义配置文件，而不是使用注释。MethodArgumentResolverSpringDataWebConfigurationpageableResolver()sortResolver()@Enable

如果您需要从请求中解析多个或实例（例如，对于多个表），则可以使用 Spring 的注解来区分一个或另一个。然后，请求参数必须以为前缀。以下示例显示了生成的方法签名：PageableSort@Qualifier${qualifier}_

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

您必须填充、等。thing1_pagething2_page

传入该方法的默认值等效于，但您可以使用参数上的注释对其进行自定义。PageablePageRequest.of(0, 20)@PageableDefaultPageable

超媒体支持和`PageSlice`

Spring HATEOAS 附带了一个表示模型类（/），它允许使用必要的 / 元数据以及链接来丰富 or 实例的内容，让客户端轻松浏览页面。 a 到 a 的转换是通过 Spring HATEOAS 接口的实现完成的，称为 . 同样，可以使用将实例转换为。下面的示例演示如何使用 as a 作为控制器方法参数，因为其工作方式完全相同：PagedModelSlicedModelPageSlicePageSlicePagePagedModelRepresentationModelAssemblerPagedResourcesAssemblerSliceSlicedModelSlicedResourcesAssemblerPagedResourcesAssemblerSlicedResourcesAssembler

使用 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));
  }
}

启用配置（如前面的示例所示）可将 be 用作控制器方法参数。调用它具有以下效果：PagedResourcesAssemblertoModel(…)

的内容成为实例的内容。PagePagedModel
该对象附加了一个实例，并且该实例填充了来自和基础 .PagedModelPageMetadataPagePageable
可能会得到和附加的链接，具体取决于页面的状态。链接指向方法映射到的 URI。添加到方法中的分页参数与的设置匹配，以确保以后可以解析链接。PagedModelprevnextPageableHandlerMethodArgumentResolver

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

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

此处显示的 JSON 信封格式不遵循任何正式指定的结构，也不能保证稳定，我们可能随时更改它。强烈建议将渲染启用为支持超媒体的官方媒体类型，并受 Spring HATEOAS 支持，如 HAL。这些可以通过使用其注释来激活。在 Spring HATEOAS 参考文档中查找更多信息。@EnableHypermediaSupport

汇编程序生成了正确的 URI，并选取了默认配置，以将参数解析为即将到来的请求。这意味着，如果更改该配置，链接将自动遵循更改。默认情况下，汇编程序指向调用它的控制器方法，但您可以通过传递要用作构建分页链接的基础的自定义来自定义，这会使该方法重载。PageableLinkPagedResourcesAssembler.toModel(…)

Spring Data Jackson 模块

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

在初始化期间，像一样，被基础设施拾取，以便声明的 s 可供 Jackson 使用。SpringDataJacksonModulesSpringDataJacksonConfigurationcom.fasterxml.jackson.databind.ModuleObjectMapper

以下域类型的数据绑定混合由公共基础结构注册。

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 中描述）通过使用 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 处理程序方法参数，也可以通过在 . 前面的方法声明将尝试在给定文档中查找任何位置。 XML 查找在传入文档的顶层执行。它的 JSON 变体首先尝试顶级，但如果前者不返回值，也会尝试嵌套在子文档中。这样，可以轻松缓解源文档结构中的更改，而无需客户端调用公开的方法（通常是基于类的有效负载绑定的缺点）。ParameterizedTypeReferenceRestTemplatefirstnamelastnamelastnamelastnameuser

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

对于 Spring MVC，一旦激活，就会自动注册必要的转换器，并且所需的依赖项在类路径上可用。要与一起使用，请注册（JSON）或手动。@EnableSpringDataWebSupportRestTemplateProjectingJackson2HttpMessageConverterXmlBeamHttpMessageConverter

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

Querydsl Web 支持

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

请考虑以下查询字符串：

?firstname=Dave&lastname=Matthews

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

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

当在类路径上找到 Querydsl 时，该功能将自动启用。@EnableSpringDataWebSupport

将添加到方法签名可提供即用型签名，您可以使用 .@QuerydslPredicatePredicateQuerydslPredicateExecutor

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

下面的示例演示如何在方法签名中使用：@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	将查询字符串参数解析为匹配。`PredicateUser`

默认绑定如下：

Object在简单属性上为 .eq
Object在集合上，如属性。contains
Collection在简单属性上为 .in

您可以通过的属性或使用 Java 8 并将该方法添加到存储库接口来定制这些绑定，如下所示：bindings@QuerydslPredicatedefault methodsQuerydslBinderCustomizer

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`提供对的特定 Finder 方法的访问。`Predicate`
2	`QuerydslBinderCustomizer`在存储库界面上定义的界面会自动拾取和快捷方式。`@QuerydslPredicate(bindings=…)`
3	将属性的绑定定义为简单绑定。`usernamecontains`
4	将属性的默认绑定定义为不区分大小写的匹配项。`Stringcontains`
5	从解析中排除该属性。`passwordPredicate`

您可以在应用存储库中的特定绑定之前注册一个包含默认 Querydsl 绑定的 Bean，或者 .QuerydslBinderCustomizerDefaults@QuerydslPredicate

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

表 1.为实例计算的请求参数`Pageable`
`page`	要检索的页面。0-indexed，默认为 0。
`size`	要检索的页面的大小。默认值为 20。
`sort`	应按格式排序的属性。默认排序方向区分大小写升序。如果要切换方向或区分大小写，请使用多个参数，例如 .`property,property(,ASC\|DESC)(,IgnoreCase)sort?sort=firstname&sort=lastname,asc&sort=city,ignorecase`

单个模块可以提供额外的 .
有关详细信息，请参阅商店特定部分。SpringDataJacksonModules

当在类路径上找到 Querydsl 时，该功能将自动启用。@EnableSpringDataWebSupport

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

1	将查询字符串参数解析为匹配。`PredicateUser`

1	`QuerydslPredicateExecutor`提供对的特定 Finder 方法的访问。`Predicate`
2	`QuerydslBinderCustomizer`在存储库界面上定义的界面会自动拾取和快捷方式。`@QuerydslPredicate(bindings=…)`
3	将属性的绑定定义为简单绑定。`usernamecontains`
4	将属性的默认绑定定义为不区分大小写的匹配项。`Stringcontains`
5	从解析中排除该属性。`passwordPredicate`

您可以在应用存储库中的特定绑定之前注册一个包含默认 Querydsl 绑定的 Bean，或者 .QuerydslBinderCustomizerDefaults@QuerydslPredicate

存储库填充器

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

假设您有一个调用了以下内容的文件：data.json

JSON 中定义的数据

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

您可以使用 Spring Data Commons 中提供的存储库命名空间的 populator 元素填充存储库。要将上述数据填充到，请声明类似于以下内容的填充器：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>

前面的声明会导致 Jackson 读取和反序列化文件。data.jsonObjectMapper

通过检查 JSON 文档的属性来确定 JSON 对象取消编组的类型。基础结构最终会选择适当的存储库来处理反序列化的对象。_class

若要改用 XML 来定义存储库应填充的数据，可以使用该元素。您可以将其配置为使用 Spring OXM 中可用的 XML 编组器选项之一。有关详细信息，请参阅 Spring 参考文档。以下示例显示了如何使用 JAXB 取消编组存储库填充器：unmarshaller-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>

Querydsl 扩展

Web 支持

基本 Web 支持

使用类DomainClassConverter

用于分页和排序的 HandlerMethodArgumentResolvers

超媒体支持和PageSlice

Spring Data Jackson 模块

Web 数据绑定支持

Querydsl Web 支持

存储库填充器

使用类`DomainClassConverter`

超媒体支持和`PageSlice`