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 的集成,如下例所示
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
,如下例所示
interface UserRepository extends CrudRepository<User, Long>, QuerydslPredicateExecutor<User> {
}
前面的例子允许你使用 Querydsl Predicate
实例编写类型安全的查询,如下例所示
Predicate predicate = user.firstname.equalsIgnoreCase("dave")
.and(user.lastname.startsWithIgnoreCase("mathews"));
userRepository.findAll(predicate);
使用 Querydsl 的类型安全查询方法
LDAP repository 的对应部分集成了 Querydsl 项目,该项目提供了一种执行类型安全查询的方法。
它不是将查询写成内联字符串或外部化到 XML 文件中,而是通过流畅的 API 构建查询。
它提供以下功能
-
IDE 中的代码补全(所有属性、方法和操作都可以在你喜欢的 Java IDE 中展开)。
-
几乎不允许语法无效的查询(在所有级别都是类型安全的)。
-
可以安全地引用域类型和属性——不涉及字符串!
-
更好地适应域类型中的重构更改。
-
增量查询定义更容易。
有关如何使用 Maven 或 Ant 引导你的环境以进行基于 APT 的代码生成的更多信息,请参阅 Querydsl 文档。
Querydsl 允许你编写如下查询
QPerson person = QPerson.person;
List<Person> result = repository.findAll(person.address.zipCode.eq("C0123"));
Page<Person> page = repository.findAll(person.lastname.contains("a"),
PageRequest.of(0, 2, Direction.ASC, "lastname"));
QPerson
是一个由 Java 注解处理器生成的类。有关如何使用你的构建系统设置注解处理,请参阅设置注解处理。它是一个 Predicate
,允许你编写类型安全的查询。请注意,查询中除了 C0123
值外没有其他字符串。
你可以使用生成的 Predicate
类,方法是使用 QuerydslPredicateExecutor
接口,如下列表所示
public interface QuerydslPredicateExecutor<T> {
Optional<T> findOne(Predicate predicate);
List<T> findAll(Predicate predicate);
List<T> findAll(Predicate predicate, Sort sort);
List<T> findAll(Predicate predicate, OrderSpecifier<?>... orders);
Page<T> findAll(Predicate predicate, Pageable pageable);
List<T> findAll(OrderSpecifier<?>... orders);
long count(Predicate predicate);
boolean exists(Predicate predicate);
<S extends T, R> R findBy(Predicate predicate, Function<FluentQuery.FetchableFluentQuery<S>, R> queryFunction);
}
要在你的 repository 实现中使用它,请将其添加到你的接口继承的 repository 接口列表中,如下例所示
interface PersonRepository extends LdapRepository<Person>, QuerydslPredicateExecutor<Person> {
// additional query methods go here
}
设置注解处理
要在 Spring Data LDAP 中使用 Querydsl,你需要在构建系统中设置注解处理来生成 Q
类。虽然你可以手动编写 Q
类,但建议使用 Querydsl 注解处理器为你生成它们,以使你的 Q
类与你的域模型保持同步。
Spring Data LDAP 附带了一个注解处理器 LdapAnnotationProcessor
,默认情况下未注册。通常,注解处理器通过 Java 的服务加载器通过 META-INF/services/javax.annotation.processing.Processor
进行注册,一旦你在类路径上拥有它们,这些处理器也会被激活。大多数 Spring Data 用户不使用 Querydsl,因此对于那些不会从 Querydsl 中受益的项目,要求额外的强制依赖是没有意义的。因此,你需要在构建系统中激活注解处理。
以下示例展示了如何在 Maven 和 Gradle 中通过提及依赖项和编译器配置更改来设置注解处理
-
Maven
-
Gradle
<dependencies>
<dependency>
<groupId>org.springframework.data</groupId>
<artifactId>spring-data-ldap</artifactId>
</dependency>
<dependency>
<groupId>com.querydsl</groupId>
<artifactId>querydsl-core</artifactId>
<version>${querydslVersion}</version>
<classifier>jakarta</classifier>
</dependency>
<dependency>
<groupId>com.querydsl</groupId>
<artifactId>querydsl-apt</artifactId>
<version>${querydslVersion}</version>
<classifier>jakarta</classifier>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<annotationProcessors>
<annotationProcessor>
org.springframework.data.ldap.repository.support.LdapAnnotationProcessor
</annotationProcessor>
</annotationProcessors>
<!-- Recommended: Some IDE's might require this configuration to include generated sources for IDE usage -->
<generatedTestSourcesDirectory>target/generated-test-sources</generatedTestSourcesDirectory>
<generatedSourcesDirectory>target/generated-sources</generatedSourcesDirectory>
</configuration>
</plugin>
</plugins>
</build>
dependencies {
implementation 'com.querydsl:querydsl-core:${querydslVersion}:jakarta'
annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
annotationProcessor 'org.springframework.data:spring-data-ldap'
testAnnotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
testAnnotationProcessor 'org.springframework.data:spring-data-ldap'
}
tasks.withType(JavaCompile).configureEach {
options.compilerArgs += [
"-processor",
"org.springframework.data.ldap.repository.support.LdapAnnotationProcessor"]
}
请注意,上面的设置展示了最简单的用法,省略了你的项目可能需要的任何其他选项或依赖项。
Web 支持
支持 repository 编程模型的 Spring Data 模块提供了各种 Web 支持。与 Web 相关的组件需要在类路径中包含 Spring MVC JAR。其中一些甚至提供了与 Spring HATEOAS 的集成。通常,通过在你的 JavaConfig 配置类中使用 @EnableSpringDataWebSupport
注解来启用集成支持,如下例所示
-
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 支持
上一节中显示的配置注册了一些基本组件
-
一个 使用
DomainClassConverter
类,用于让 Spring MVC 从请求参数或路径变量中解析 repository 管理的域类实例。 -
HandlerMethodArgumentResolver
实现,用于让 Spring MVC 从请求参数中解析Pageable
和Sort
实例。 -
Jackson Modules,用于根据使用的 Spring Data Module 序列化/反序列化诸如
Point
和Distance
之类的类型,或特定于存储的类型。
使用 DomainClassConverter
类
DomainClassConverter
类允许你在 Spring MVC 控制器方法签名中直接使用域类型,这样你就不必手动通过 repository 查找实例,如下例所示
@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
@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
实例
|
您想要检索的页码。从 0 开始索引,默认为 0。 |
|
您想要检索的页面大小。默认为 20。 |
|
应按其排序的属性,格式为 |
要自定义此行为,请分别注册一个实现 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
的用法完全相同
@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" : "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 指向调用它的控制器方法,但你可以通过传递一个自定义的 Link
作为构建分页链接的基础来对其进行自定义,这会重载 PagedResourcesAssembler.toModel(…)
方法。
Spring Data Jackson 模块
核心模块以及一些特定于存储的模块附带了一组 Jackson Modules,用于 Spring Data 域中使用的类型,例如 org.springframework.data.geo.Distance
和 org.springframework.data.geo.Point
。
一旦 Web 支持启用并且 com.fasterxml.jackson.databind.ObjectMapper
可用,这些 Modules 就会被导入。
在初始化期间,诸如 SpringDataJacksonConfiguration
之类的 SpringDataJacksonModules
会被基础设施拾取,以便声明的 com.fasterxml.jackson.databind.Module
可供 Jackson ObjectMapper
使用。
通用基础设施会为以下域类型注册数据绑定 mixin。
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
各个模块可以提供额外的 |
Web 数据绑定支持
您可以使用 Spring Data 投影(在 投影 中描述)通过 JSONPath 表达式(需要 Jayway JsonPath)或 XPath 表达式(需要 XmlBeam)绑定传入的请求载荷,如下例所示
@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 Examples repository 中的 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
方法添加到 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
的支持。在 repository 级别也有类似的抽象,尽管它不使用 SQL 作为数据定义语言,因为它必须是存储无关的。因此,填充器支持 XML(通过 Spring 的 OXM 抽象)和 JSON(通过 Jackson)来定义用于填充 repository 的数据。
假设你有一个名为 data.json
的文件,内容如下
[ { "_class" : "com.acme.Person",
"firstname" : "Dave",
"lastname" : "Matthews" },
{ "_class" : "com.acme.Person",
"firstname" : "Carter",
"lastname" : "Beauford" } ]
您可以使用 Spring Data Commons 中提供的 repository 命名空间的填充器元素来填充您的 repository。要将上述数据填充到您的 PersonRepository
,请声明一个类似于以下的填充器
<?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 填充器
<?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>