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 Modules，用於序列化/反序列化諸如 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 controller 嘗試最終將 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` 渲染

如果你不想更改所有現有 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 是透過一個名為 PagedResourcesAssembler 的 Spring HATEOAS RepresentationModelAssembler 介面實現完成的。同樣，Slice 例項可以使用 SlicedResourcesAssembler 轉換為 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 Modules

核心模組和一些特定於儲存的模組附帶了一組用於 Spring Data 領域使用的型別（如 org.springframework.data.geo.Distance 和 org.springframework.data.geo.Point）的 Jackson Modules。
一旦啟用 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 projections（在 Projections 中描述）透過 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。透過這種方式，可以輕鬆地減輕源文件結構的變化，而無需客戶端呼叫暴露的方法（通常是基於類的負載繫結的一個缺點）。

支援巢狀 projections，如 Projections 中所述。如果方法返回一個複雜的、非介面型別，則使用 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	從 `Predicate` 解析中排除 `password` 屬性。

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

Repository Populators

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

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

以 JSON 定義的資料

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

你可以透過使用 Spring Data Commons 中提供的 repository 名稱空間的 populator 元素來填充你的 repositories。要將上述資料填充到你的 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>

上述宣告會導致 Jackson ObjectMapper 讀取並反序列化 data.json 檔案。

JSON 物件要反封送的目標型別是透過檢查 JSON 文件的 _class 屬性來確定的。基礎架構最終會選擇合適的 repository 來處理反序列化的物件。

如果想改用 XML 來定義應填充 repositories 的資料，可以使用 unmarshaller-populator 元素。你將其配置為使用 Spring OXM 中可用的 XML marshaller 選項之一。有關詳細資訊，請參閱 Spring 參考文件。下例顯示瞭如何使用 JAXB 反封送 repository populator

宣告一個反封送 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 Modules

Web 資料繫結支援

Querydsl Web 支援

Repository Populators

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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