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 的整合，如下例所示

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 模組，用於序列化/反序列化 Point 和 Distance 等型別，或者根據使用的 Spring Data 模組序列化/反序列化特定型別。

使用 `DomainClassConverter` 類

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

在方法簽名中使用領域型別的 Spring MVC controller

@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 方法引數，如下例所示

將 Pageable 用作 controller 方法引數

@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 controllers 通常會嘗試最終向客戶端呈現 Spring Data page 的表示。雖然可以直接從處理方法返回 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` 渲染

如果您不想更改所有現有的 controller，新增對映步驟來返回 PagedModel 而不是 Page，您可以透過如下調整 @EnableSpringDataWebSupport 來啟用 PageImpl 例項自動翻譯為 PagedModel 的功能

@EnableSpringDataWebSupport(pageSerializationMode = VIA_DTO)
class MyConfiguration { }

這將允許您的 controller 仍然返回 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。類似地，可以使用 SlicedResourcesAssembler 將 Slice 例項轉換為 SlicedModel。以下示例展示瞭如何將 PagedResourcesAssembler 用作 controller 方法引數，SlicedResourcesAssembler 的用法完全相同

將 PagedResourcesAssembler 用作 controller 方法引數

@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 可以用作 controller 方法引數。在其上呼叫 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 參考文件。

assembler 生成了正確的 URI，並拾取了預設配置，將引數解析為用於後續請求的 Pageable。這意味著，如果更改該配置，連結會自動遵守更改。預設情況下，assembler 指向呼叫它的 controller 方法，但您可以透過傳遞一個自定義的 Link 作為基礎來構建 pagination 連結來定製它，這將過載 PagedResourcesAssembler.toModel(…) 方法。

Spring Data Jackson 模組

核心模組和一些特定於儲存的模組附帶了一組用於 Spring Data 領域使用的型別的 Jackson Modules，例如 org.springframework.data.geo.Distance 和 org.springframework.data.geo.Point。
一旦啟用 web 支援並且 com.fasterxml.jackson.databind.ObjectMapper 可用，這些 Modules 就會被匯入。

在初始化期間，基礎設施會拾取 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 方法引數，或透過在 RestTemplate 的方法上使用 ParameterizedTypeReference。上述方法宣告將嘗試在給定文件中的任何位置查詢 firstname。對 lastname 的 XML 查詢在傳入文件的頂層執行。其 JSON 變體首先嚐試查詢頂層 lastname，如果前者沒有返回值，也會嘗試查詢巢狀在 user 子文件中的 lastname。這樣，可以輕鬆緩解源文件結構的變化，而無需客戶端呼叫暴露的方法（這通常是基於類的 payload 繫結的缺點）。

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

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

更多資訊，請參閱規範 Spring Data Examples 倉庫中的 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	從 `Predicate` 解析中排除 `password` 屬性。

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

Repository 填充器

如果您使用 Spring JDBC 模組，您可能熟悉使用 SQL 指令碼填充 DataSource 的支援。在 repositories 級別也有類似的抽象，儘管它不使用 SQL 作為資料定義語言，因為它必須是儲存獨立的。因此，populators 支援 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 名稱空間的 populator 元素來填充您的 repository。要將上述資料填充到您的 PersonRepository，請宣告一個類似於以下的 populator

宣告一個 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 populator

宣告一個解組 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 的 HandlerMethodArgumentResolvers

為 Page 建立 JSON 表示

使用 Spring Data 的 PagedModel

全域性啟用簡化的 Page 渲染

對 Page 和 Slice 的超媒體支援

Spring Data Jackson 模組

Web 資料繫結支援

Querydsl Web 支援

Repository 填充器

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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