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，示例如下

Repository 上的 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);

Web 支援

支援 repository 程式設計模型的 Spring Data 模組提供了多種 Web 支援。這些 Web 相關元件需要 Spring MVC JAR 包在 classpath 中。其中一些甚至提供了與 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 Modules 用於序列化/反序列化 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` 渲染

如果您不想更改所有現有控制器以新增將 Page 對映到返回 PagedModel 的步驟，您可以透過如下調整 @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。新增到方法的分頁引數與 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 可用，這些模組就會被匯入。

在初始化期間，諸如 SpringDataJacksonModules 之類的 SpringDataJacksonConfiguration 會被基礎設施拾取，以便宣告的 com.fasterxml.jackson.databind.Module 們可供 Jackson ObjectMapper 使用。

通用基礎設施註冊了以下域型別的資料繫結 mixins。

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）來繫結傳入的請求 payload，示例如下

使用 JSONPath 或 XPath 表示式的 HTTP payload 繫結

@ProjectedPayload
public interface UserPayload {

  @XBRead("//firstname")
  @JsonPath("$..firstname")
  String getFirstname();

  @XBRead("/lastname")
  @JsonPath({ "$.lastname", "$.user.lastname" })
  String getLastname();
}

您可以使用前面示例中顯示的型別作為 Spring MVC handler 方法引數，或使用 ParameterizedTypeReference 在 RestTemplate 的方法上。前面的方法宣告會嘗試在給定文件的任何位置查詢 firstname。lastname 的 XML 查詢在傳入文件的頂層執行。其 JSON 變體首先嚐試頂層的 lastname，如果前者沒有返回值，則也會嘗試巢狀在 user 子文件中的 lastname。透過這種方式，可以輕鬆地緩解源文件結構的變化，而無需客戶端呼叫暴露的方法（這通常是基於類的 payload 繫結的缺點）。

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

對於 Spring MVC，一旦 @EnableSpringDataWebSupport 啟用並且 classpath 中有必需的依賴項，所需的轉換器就會自動註冊。對於與 RestTemplate 一起使用，請手動註冊一個 ProjectingJackson2HttpMessageConverter (JSON) 或 XmlBeamHttpMessageConverter。

更多資訊請參閱規範的 Spring Data Examples repository 中的 web projection 示例。

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	將 `password` 屬性從 `Predicate` 解析中排除。

您可以註冊一個 QuerydslBinderCustomizerDefaults bean，該 bean 在應用 repository 或 @QuerydslPredicate 的特定繫結之前持有預設的 Querydsl 繫結。

Repository 資料填充器

如果您使用 Spring JDBC 模組，您可能熟悉用 SQL 指令碼填充 DataSource 的支援。repository 級別也有類似的抽象，儘管它不使用 SQL 作為資料定義語言，因為它必須是儲存無關的。因此，資料填充器支援 XML（透過 Spring 的 OXM 抽象）和 JSON（透過 Jackson）來定義用於填充 repository 的資料。

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

JSON 中定義的資料

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

您可以使用 Spring Data Commons 提供的 repository 名稱空間的資料填充器元素來填充您的 repository。要將前面資料填充到您的 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 來定義應填充 repository 的資料，您可以使用 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` 的超媒體支援