Spring Data 擴充套件

本節介紹了 Spring Data 的一組擴充套件，它們使得 Spring Data 可以在多種上下文中使用。目前，大多數整合是針對 Spring MVC 的。

Querydsl 擴充套件

Querydsl 是一個框架，它透過其流式 API 實現靜態型別化 SQL 式查詢的構建。

Querydsl 的維護已放緩，社群已在 OpenFeign 下分叉了該專案：github.com/OpenFeign/querydsl (groupId io.github.openfeign.querydsl)。Spring Data 會盡力支援該分叉。

多個 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 支援，請在您的 repository 介面上擴充套件 QuerydslPredicateExecutor，如下例所示

Querydsl 在 Repository 上的整合

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 與 Spring Data JPA 一起使用，您需要在構建系統中設定註解處理來生成 Q 類。雖然您可以手動編寫 Q 類，但建議使用 Querydsl 註解處理器為您生成它們，以使您的 Q 類與您的領域模型保持同步。

大多數 Spring Data 使用者不使用 Querydsl，因此對於那些不會受益於 Querydsl 的專案，要求強制增加額外的依賴項是沒有意義的。因此，您需要在構建系統中啟用註解處理。

以下示例展示瞭如何在 Maven 和 Gradle 中透過提及依賴項和編譯器配置更改來設定註解處理

Maven
Gradle

<dependencies>
    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-jpa</artifactId>
        <version>${querydslVersion}</version>
        <classifier>jakarta</classifier>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
            <annotationProcessorPaths>
                <!-- Explicit opt-in required via annotationProcessors or
                        annotationProcessorPaths on Java 22+, see https://bugs.openjdk.org/browse/JDK-8306819 -->
                <annotationProcessorPath>
                    <groupId>com.querydsl</groupId>
                    <artifactId>querydsl-apt</artifactId>
                    <version>${querydslVersion}</version>
                    <classifier>jakarta</classifier>
                </annotationProcessorPath>
                <annotationProcessorPath>
                    <groupId>jakarta.persistence</groupId>
                    <artifactId>jakarta.persistence-api</artifactId>
                </annotationProcessorPath>
              </annotationProcessorPaths>

                <!-- 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-jpa:${querydslVersion}:jakarta'
    annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
    annotationProcessor 'jakarta.persistence:jakarta.persistence-api'

    testAnnotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
    testAnnotationProcessor 'jakarta.persistence:jakarta.persistence-api'
}

請注意，上述設定僅展示了最簡單的用法，省略了您的專案可能需要的任何其他選項或依賴項。

Web 支援

支援 Repository 程式設計模型的 Spring Data 模組提供了各種 Web 支援。與 Web 相關的元件需要 classpath 中包含 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 註解會註冊一些元件。我們將在本節後面討論這些元件。它還會檢測 classpath 中是否存在 Spring HATEOAS，如果存在，也會為其註冊整合元件。

基本 Web 支援

在 XML 中啟用 Spring Data Web 支援

上一節所示的配置註冊了一些基本元件

一個使用 DomainClassConverter 類，用於讓 Spring MVC 從請求引數或路徑變數解析 repository 管理的領域類例項。
HandlerMethodArgumentResolver 實現，用於讓 Spring MVC 從請求引數解析 Pageable 和 Sort 例項。
Jackson 模組，用於反序列化/序列化諸如 Point 和 Distance 等型別，或特定於儲存的型別，具體取決於使用的 Spring Data 模組。

使用 `DomainClassConverter` 類

DomainClassConverter 類允許您直接在 Spring MVC 控制器方法的簽名中使用領域型別，這樣您就不需要透過 repository 手動查詢例項，如下例所示

一個在方法簽名中使用領域型別的 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 型別，然後最終透過呼叫為該領域型別註冊的 repository 例項上的 findById(…) 來訪問該例項，即可解析該例項。

目前，repository 必須實現 CrudRepository 才能被發現用於轉換。

Pageable 和 Sort 的 HandlerMethodArgumentResolver

上一節所示的配置程式碼片段也註冊了一個 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 頁面的表示是很常見的。雖然可以直接從 handler 方法返回 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 欄位，暴露了必要的 pagination 元資料。

全域性啟用簡化的 `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。新增到方法的 pagination 引數與 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 參考文件中查詢更多資訊。

彙編器生成了正確的 URI，並自動採用了預設配置將引數解析為用於後續請求的 Pageable。這意味著，如果您更改該配置，連結也會自動遵循該更改。預設情況下，彙編器指向其被呼叫的控制器方法，但您可以透過傳遞一個自定義的 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 可用，這些模組就會被匯入。

在初始化期間，基礎設施會拾取諸如 SpringDataJacksonConfiguration 之類的 SpringDataJacksonModules，以便宣告的 com.fasterxml.jackson.databind.Modules 可供 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

各個模組可能會提供額外的 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 handler 方法引數，或者透過在 RestTemplate 的某個方法上使用 ParameterizedTypeReference。前面的方法宣告會嘗試在給定文件的任何位置查詢 firstname。XML 的 lastname 查詢在傳入文件的頂層執行。JSON 變體則首先嚐試頂層 lastname，如果前者未返回值，也會嘗試巢狀在 user 子文件中的 lastname。這樣，就可以輕鬆緩解源文件結構的變化，而無需客戶端呼叫公開的方法（通常是基於類的負載繫結的一個缺點）。

支援巢狀投影，如投影中所述。如果方法返回複雜的非介面型別，則使用 Jackson ObjectMapper 來對映最終值。

對於 Spring MVC，一旦 @EnableSpringDataWebSupport 啟用且所需的依賴項在 classpath 中可用，必要的轉換器就會自動註冊。與 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"))

當 classpath 中找到 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 的支援。在 repositories 級別也有類似的抽象，儘管它不使用 SQL 作為資料定義語言，因為它必須與儲存無關。因此，填充器支援 XML（透過 Spring 的 OXM 抽象）和 JSON（透過 Jackson）來定義用於填充 repositories 的資料。

假設您有一個名為 data.json 的檔案，其內容如下

在 JSON 中定義的資料

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

您可以使用 Spring Data Commons 提供的 repository 名稱空間的填充器元素來填充您的 repositories。要將前面的資料填充到您的 PersonRepository 中，請宣告一個類似於以下的填充器

宣告一個 Jackson 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"
  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 定義應填充到 repositories 中的資料，您可以使用 unmarshaller-populator 元素。您將其配置為使用 Spring OXM 中可用的 XML marshaller 選項之一。有關詳細資訊，請參閱Spring 參考文件。以下示例展示瞭如何使用 JAXB 解組 repository 填充器

宣告一個解組 repository 填充器 (使用 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>

Spring Data 擴充套件

Querydsl 擴充套件

設定註解處理

Web 支援

基本 Web 支援

使用 DomainClassConverter 類

Pageable 和 Sort 的 HandlerMethodArgumentResolver

為 Page 建立 JSON 表示

使用 Spring Data 的 PagedModel

全域性啟用簡化的 Page 渲染

Page 和 Slice 的超媒體支援

Spring Data Jackson 模組

Web 資料繫結支援

Querydsl Web 支援

Repository 填充器

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

全域性啟用簡化的 `Page` 渲染

`Page` 和 `Slice` 的超媒體支援