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 支援，請在您的 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-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 例項以讓 Jackson 按原樣呈現它們，但我們強烈建議不要這樣做，因為底層實現類 PageImpl 是一個領域型別。這意味著我們可能希望或必須出於不相關的原因更改其 API，並且這些更改可能會以破壞性方式改變生成的 JSON 表示。

從 Spring Data 3.1 開始，我們透過發出一個警告日誌來提示這個問題，該日誌描述了問題。我們仍然最終建議利用與 Spring HATEOAS 的整合，以一種完全穩定且支援超媒體的方式呈現頁面，從而輕鬆地允許客戶端導航它們。但從版本 3.3 開始，Spring Data 提供了一種頁面渲染機制，該機制使用方便，但不需要包含 Spring HATEOAS。

使用 Spring Data 的 `PagedModel`

其核心支援包含 Spring HATEOAS 的 PagedModel（Spring Data 的 PagedModel 位於 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 指向呼叫它的控制器方法，但您可以透過傳遞用於構建 pagination 連結的自定義 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 Databinding 支援

您可以使用 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 example。

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` 屬性。

您可以註冊一個包含預設 Querydsl 繫結的 QuerydslBinderCustomizerDefaults bean，然後再應用來自 repository 或 @QuerydslPredicate 的特定繫結。

Repository Populators

如果您使用 Spring JDBC 模組，您可能熟悉使用 SQL 指令碼填充 DataSource 的支援。repository 級別也有類似的抽象，儘管它不使用 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 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

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

為 Page 建立 JSON 表示

使用 Spring Data 的 PagedModel

全域性啟用簡化的 Page 渲染

對 Page 和 Slice 的超媒體支援

Spring Data Jackson 模組

Web Databinding 支援

Querydsl Web 支援

Repository Populators

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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

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