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 相關元件需要在 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 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 欄位，其中暴露了基本的 paginate 元資料。

全域性啟用簡化的 `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。新增到方法的 paginate 引數與 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）來繫結傳入的請求負載，如下例所示

使用 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。這樣，源文件結構的更改可以輕鬆緩解，而無需客戶端呼叫暴露的方法（這通常是基於類的負載繫結的缺點）。

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

對於 Spring MVC，一旦 @EnableSpringDataWebSupport 處於活動狀態並且 classpath 中存在所需的依賴，就會自動註冊必要的轉換器。要與 RestTemplate 一起使用，需要手動註冊 ProjectingJackson2HttpMessageConverter (JSON) 或 XmlBeamHttpMessageConverter。

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

Querydsl Web 支援

對於那些集成了 Querydsl 的儲存，你可以從請求查詢字串中包含的屬性派生查詢。

考慮以下查詢字串

?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 方法並將 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 的支援。在 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 編組器選項之一。詳細資訊請參閱 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` 類

`Pageable` 和 `Sort` 的 `HandlerMethodArgumentResolver`

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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