Spring Data JPA 参考文档三

原标题：Spring认证|Spring Data JPA 参考文档三(内容来源：Spring中国教育管理中心）

Spring Data JPA 参考文档三
手动接线

如果您的自定义实现仅使用基于注解的配置和自动装配，则前面显示的方法效果很好，因为它被视为任何其他 Spring bean。如果您的实现片段 bean 需要特殊连接，您可以根据上一节中描述的约定声明 bean 并为其命名。然后，基础设施通过名称引用手动定义的 bean 定义，而不是自己创建一个。以下示例显示了如何手动连接自定义实现：

示例 38. 自定义实现的手动接线

4.6.2. 自定义基础存储库

当您想要自定义基本存储库行为以便影响所有存储库时，上一节中描述的方法需要自定义每个存储库接口。要改为更改所有存储库的行为，您可以创建一个扩展持久性技术特定存储库基类的实现。然后，此类充当存储库代理的自定义基类，如以下示例所示：

示例 39.自定义存储库基类

class MyRepositoryImpl

extends SimpleJpaRepository {

private final EntityManager entityManager;

MyRepositoryImpl(JpaEntityInformation entityInformation,

EntityManager entityManager) {

super(entityInformation, entityManager);

// Keep the EntityManager around to used from the newly introduced methods.

this.entityManager = entityManager;

}

@Transactional

public S save(S entity) {

// implementation goes here

}

}

Spring Data JPA 参考文档三
该类需要具有特定于商店的存储库工厂实现使用的超类的构造函数。如果存储库基类有多个构造函数，则覆盖一个EntityInformation加上存储特定基础结构对象（例如一个EntityManager或模板类）的构造函数。

最后一步是让 Spring Data 基础设施知道定制的存储库基类。在 Java 配置中，您可以使用注解的repositoryBaseClass属性来实现@Enable${store}Repositories，如下例所示：

示例 40. 使用 JavaConfig 配置自定义存储库基类

@Configuration

@EnableJpaRepositories(repositoryBaseClass = MyRepositoryImpl.class)

class ApplicationConfiguration { … }

XML 命名空间中提供了相应的属性，如以下示例所示：

示例 41. 使用 XML 配置自定义存储库基类

4.7. 从聚合根发布事件

存储库管理的实体是聚合根。在域驱动设计应用程序中，这些聚合根通常发布域事件。Spring Data 提供了一个名为的注释@DomainEvents，您可以在聚合根的方法上使用该注释，以使该发布尽可能简单，如以下示例所示：

示例 42. 从聚合根公开域事件

class AnAggregateRoot {

@DomainEvents

Collection domainEvents() {

// … return events you want to get published here

}

@AfterDomainEventPublication

void callbackMethod() {

// … potentially clean up domain events list

}

}

使用的方法@DomainEvents可以返回单个事件实例或事件集合。它不能接受任何论据。

发布所有事件后，我们就有了一个用@
AfterDomainEventPublication. 您可以使用它潜在地清理要发布的事件列表（以及其他用途）。

该方法被称为一个Spring数据存储库的每一次一个save(…)，saveAll(…)，delete(…)或deleteAll(…)方法被调用。

4.8. Spring 数据扩展

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

4.8.1. Querydsl 扩展

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

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

例
43.QuerydslPredicateExecutor 接口

public interface QuerydslPredicateExecutor {

Optional findById(Predicate predicate);

Iterable findAll(Predicate predicate);

long count(Predicate predicate);

boolean exists(Predicate predicate);

// … more functionality omitted.

}

查找并返回与 匹配的单个实体Predicate。

查找并返回与 匹配的所有实体Predicate。

返回与 匹配的实体数Predicate。

返回匹配的实体是否Predicate存在。

Spring Data JPA 参考文档三
要使用 Querydsl 支持，请扩展QuerydslPredicateExecutor您的存储库界面，如以下示例所示：

示例 44. 存储库上的 Querydsl 集成

interface UserRepository extends CrudRepository, QuerydslPredicateExecutor {

}

前面的示例允许您使用 QuerydslPredicate实例编写类型安全的查询，如以下示例所示：

Predicate predicate = user.firstname.equalsIgnoreCase(“dave”)

.and(user.lastname.startsWithIgnoreCase(“mathews”));

userRepository.findAll(predicate);

4.8.2. 网络支持

支持存储库编程模型的 Spring Data 模块附带了各种 Web 支持。Web 相关组件要求 Spring MVC JAR 位于类路径上。其中一些甚至提供与Spring HATEOAS 的集成。通常，通过使用@
EnableSpringDataWebSupportJavaConfig 配置类中的注释来启用集成支持，如以下示例所示：

示例 45.启用 Spring Data Web 支持

@Configuration

@EnableWebMvc

@EnableSpringDataWebSupport

class WebConfiguration {}

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

或者，如果您使用 XML 配置，请注册
SpringDataWebConfiguration或HateoasAwareSpringDataWebConfiguration作为 Spring bean，如以下示例所示（对于SpringDataWebConfiguration）：

示例 46. 在 XML 中启用 Spring Data Web 支持

基本网络支持

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

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

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

Jackson Modules用于反/序列化Point和 等类型Distance，或存储特定类型，具体取决于所使用的 Spring 数据模块。

使用DomainClassConverter类

本DomainClassConverter类让你在Spring MVC中的控制器方法签名使用域类型直接使您不必手动通过资源库查找的情况下，如下例所示：

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

@Controller

@RequestMapping(“/users”)

class UserController {

@RequestMapping(“/{id}”)

String showUserForm(@PathVariable(“id”) User user, Model model) {

model.addAttribute(“user”, user);

return “userForm”;

}

}

Spring Data JPA 参考文档三
该方法User直接接收实例，不需要进一步查找。可以通过让 Spring MVCid先将路径变量转换为域类的类型，最终通过调用findById(…)为域类型注册的存储库实例来访问实例来解析实例。

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

用于可分页和排序的
HandlerMethodArgumentResolvers

的配置片段中，在示出前一节还注册一个
PageableHandlerMethodArgumentResolver，以及实例SortHandlerMethodArgumentResolver。注册启用Pageable并Sort作为有效的控制器方法参数，如以下示例所示：

示例 48.使用 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 Data JPA 参考文档三
前面的方法签名导致 Spring MVC 尝试Pageable使用以下默认配置从请求参数派生实例：

Spring Data JPA 参考文档三
要自定义此行为，请分别注册一个实现
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传递给方法的默认值等效于 a PageRequest.of(0, 20)，但您可以通过使用参数@PageableDefault上的注释来自定义它Pageable。

对可分页的超媒体支持

Spring HATEOAS 附带了一个表示模型类 ( PagedResources)，它允许Page使用必要的Page元数据和链接来丰富实例的内容，让客户端轻松导航页面。aPage到 a的转换PagedResources是由 Spring HATEOASResourceAssembler接口的实现完成的，称为PagedResourcesAssembler. 以下示例显示了如何使用 aPagedResourcesAssembler作为控制器方法参数：

示例 49.使用 PagedResourcesAssembler 作为控制器方法参数

@Controller

class PersonController {

@Autowired PersonRepository repository;

@RequestMapping(value = “/persons”, method = RequestMethod.GET)

HttpEntity> persons(Pageable pageable,

PagedResourcesAssembler assembler) {

Page persons = repository.findAll(pageable);

return new ResponseEntity<>(assembler.toResources(persons), HttpStatus.OK);

}

}

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

的内容Page成为PagedResources实例的内容。

该PagedResources对象PageMetadata附加了一个实例，并填充了来自Page和底层 的信息PageRequest。

将PagedResources可能会prev和next连接链路，根据页面的状态。链接指向方法映射到的 URI。添加到该方法的分页参数与 的设置相匹配，
PageableHandlerMethodArgumentResolver以确保稍后可以解析链接。

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

{ “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

}

}

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

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.Modules 可供 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.

有关更多详细信息，请参阅商店特定部分。

网页数据绑定支持

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

示例 50.使用 JSONPath 或 XPath 表达式的 HTTP 负载绑定

@ProjectedPayload

public interface UserPayload {

@XBRead(“//firstname”)

@JsonPath(“$..firstname”)

String getFirstname();

@XBRead(“/lastname”)

@JsonPath({ “$.lastname”, “$.user.lastname” })

String getLastname();

}

可以使用在前面的例子中为一个Spring MVC处理程序方法参数或通过使用所示类型
ParameterizedTypeReference上的方法之一RestTemplate。前面的方法声明将尝试查找firstname给定文档中的任何位置。该lastnameXML查询是对输入文档的顶层进行。其 JSON 变体lastname首先尝试顶级，但如果前者不返回值，也会尝试lastname嵌套在user子文档中。这样，无需客户端调用公开的方法（通常是基于类的有效负载绑定的缺点）即可轻松减轻源文档结构的更改。

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

对于 Spring MVC，必要的转换器一旦@
EnableSpringDataWebSupport处于活动状态就会自动注册，并且所需的依赖项在类路径上可用。对于使用RestTemplate，注册ProjectingJackson2HttpMessageConverter（JSON）或XmlBeamHttpMessageConverter手动。

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

Querydsl 网络支持

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

考虑以下查询字符串：

?firstname=Dave&lastname=Matthews

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

QUser.user.firstname.eq(“Dave”).and(QUser.user.lastname.eq(“Matthews”))

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

将 a 添加@QuerydslPredicate到方法签名提供了一个随时可用的Predicate，您可以使用
QuerydslPredicateExecutor.

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

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

@Controller

class UserController {

@Autowired UserRepository repository;

@RequestMapping(value = “/“, method = RequestMethod.GET)

String index(Model model, @QuerydslPredicate(root = User.class) Predicate predicate,

Pageable pageable, @RequestParam MultiValueMap parameters) {

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

return “index”;

}

}

将查询字符串参数解析为匹配Predicatefor User。

Spring Data JPA 参考文档三
默认绑定如下：

Object在简单的属性上eq。

Object在像属性一样的集合上contains。

Collection在简单的属性上in。

您可以通过Java 8的bindings属性@QuerydslPredicate或通过使用 Java 8default methods并将QuerydslBinderCustomizer方法添加到存储库接口来自定义这些绑定，如下所示：

interface UserRepository extends CrudRepository,

QuerydslPredicateExecutor,

QuerydslBinderCustomizer {

@Override

default void customize(QuerydslBindings bindings, QUser user) {

bindings.bind(user.username).first((path, value) -> path.contains(value))

bindings.bind(String.class)

.first((StringPath path, String value) -> path.containsIgnoreCase(value));

bindings.excluding(user.password);

}

}

QuerydslPredicateExecutor提供对特定 finder 方法的访问Predicate。

QuerydslBinderCustomizer存储库界面上定义的自动拾取和快捷方式@QuerydslPredicate(bindings=…)。

将username属性的绑定定义为简单contains绑定。

将String属性的默认绑定定义为不区分大小写的contains匹配。

password从Predicate解析中排除该属性。

Spring Data JPA 参考文档三
你可以注册一个
QuerydslBinderCustomizerDefaults从资源库或应用特定的绑定之前豆保持默认Querydsl绑定@QuerydslPredicate。