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

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);

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 的 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-indexed，預設為 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 的表示。雖然可以直接從 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。類似地，可以使用 SlicedResourcesAssembler 將 Slice 例項轉換為 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 參考文件。

assembler 生成了正確的 URI，並選擇了預設配置來將引數解析為即將到來的請求的 Pageable。這意味著，如果你更改了該配置，連結會自動遵循更改。預設情況下，assembler 指向呼叫它的控制器方法，但你可以透過傳遞一個自定義的 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 使用。

以下領域型別的資料繫結 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。lastname 的 XML 查詢在傳入文件的頂級執行。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 並向 repository 介面新增 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	在 repository 介面上定義的 `QuerydslBinderCustomizer` 會被自動拾取並作為 `@QuerydslPredicate(bindings=…)` 的快捷方式。
3	為 `username` 屬性定義繫結，使其成為簡單的 `contains` 繫結。
4	為 `String` 屬性定義預設繫結，使其為不區分大小寫的 `contains` 匹配。
5	從 `Predicate` 解析中排除 `password` 屬性。

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

Repository Populate

如果你使用 Spring JDBC 模組，你可能熟悉使用 SQL 指令碼填充 DataSource 的支援。在 repository 級別也有類似的抽象，儘管它不使用 SQL 作為資料定義語言，因為它必須是與儲存無關的。因此，populator 支援 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 populator

<?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

宣告一個 unmarshalling repository populator（使用 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 Populate

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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