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 支援，請在你的儲存庫介面上擴充套件 QuerydslPredicateExecutor，如下例所示

儲存庫上的 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 支援

支援儲存庫程式設計模型的 Spring Data 模組附帶了各種 Web 支援。與 Web 相關的元件需要 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 註解註冊了一些元件。我們將在本節後面討論這些元件。它還會檢測類路徑上的 Spring HATEOAS，併為其註冊整合元件（如果存在）。

基本 Web 支援

在 XML 中啟用 Spring Data Web 支援

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

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

使用 `DomainClassConverter` 類

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

一個在方法簽名中使用領域型別的 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 型別，然後透過呼叫註冊到該領域型別的儲存庫例項上的 findById(…) 來訪問該例項。

目前，儲存庫必須實現 CrudRepository 才能被發現並進行轉換。

Pageable 和 Sort 的 HandlerMethodArgumentResolvers

上一節中所示的配置片段還註冊了一個 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 頁面的表示。雖然可以直接從處理程式方法返回 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 的工作方式完全相同

將 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 模組

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

在初始化期間，SpringDataJacksonModules（例如 SpringDataJacksonConfiguration）會被基礎設施獲取，從而使宣告的 com.fasterxml.jackson.databind.Module 可供 Jackson ObjectMapper 使用。

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

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

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

對於 Spring MVC，只要 @EnableSpringDataWebSupport 處於活動狀態並且類路徑上存在所需的依賴項，必要的轉換器就會自動註冊。對於 RestTemplate 的使用，請手動註冊 ProjectingJackson2HttpMessageConverter (JSON) 或 XmlBeamHttpMessageConverter。

有關更多資訊，請參閱規範的 Spring Data 示例倉庫中的 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 方法新增到儲存庫介面來自定義這些繫結，如下所示

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	在儲存庫介面上定義的 `QuerydslBinderCustomizer` 會自動被拾取並快捷 `@QuerydslPredicate(bindings=…)`。
3	定義 `username` 屬性的繫結為簡單的 `contains` 繫結。
4	定義 `String` 屬性的預設繫結為不區分大小寫的 `contains` 匹配。
5	將 `password` 屬性從 `Predicate` 解析中排除。

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

儲存庫填充器

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

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

JSON 中定義的資料

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

您可以使用 Spring Data Commons 中提供的儲存庫名稱空間的填充器元素來填充您的儲存庫。要將上述資料填充到您的 PersonRepository 中，請宣告一個類似於以下內容的填充器

宣告一個 Jackson 儲存庫填充器

<?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 屬性確定。基礎設施最終選擇合適的儲存庫來處理反序列化的物件。

若要改用 XML 定義應填充儲存庫的資料，可以使用 unmarshaller-populator 元素。您可以將其配置為使用 Spring OXM 中可用的 XML 解組器選項之一。有關詳細資訊，請參閱 Spring 參考文件。以下示例展示瞭如何使用 JAXB 解組儲存庫填充器

宣告一個解組儲存庫填充器（使用 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 支援

儲存庫填充器

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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