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" : "https://: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>