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

Repositories 上的 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 相關的元件需要 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 從請求引數或路徑變數解析 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 欄位，公開了基本的分頁元資料。

全域性啟用簡化的 `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 的資訊填充它。
根據 page 的狀態，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.Modules 可供 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 中所述。如果方法返回複雜的非介面型別，則使用 Jackson ObjectMapper 對映最終值。

對於 Spring MVC，一旦啟用 @EnableSpringDataWebSupport 並且所需的依賴項可在類路徑上獲得，必要的轉換器將自動註冊。對於 RestTemplate 的使用，需要手動註冊一個 ProjectingJackson2HttpMessageConverter (JSON) 或 XmlBeamHttpMessageConverter。

有關更多資訊，請參閱標準 Spring Data 示例倉庫中的 web projection 示例。

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 方法新增到 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` finder 方法的功能。
2	在 repository 介面上定義的 `QuerydslBinderCustomizer` 會自動被獲取並簡化 `@QuerydslPredicate(bindings=…)`。
3	定義 `username` 屬性的繫結為簡單的 `contains` 繫結。
4	定義 `String` 屬性的預設繫結為不區分大小寫的 `contains` 匹配。
5	從 `Predicate` 解析中排除 `password` 屬性。

您可以在應用 repository 或 @QuerydslPredicate 的特定繫結之前，註冊一個包含預設 Querydsl 繫結的 QuerydslBinderCustomizerDefaults bean。

Repository Populaters

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

前面的宣告會導致 data.json 檔案被 Jackson ObjectMapper 讀取和反序列化。

要將 JSON 物件解組為的型別由檢查 JSON 文件的 _class 屬性來確定。基礎設施最終會選擇適當的 repository 來處理反序列化的物件。

如果要使用 XML 定義要填充到 repositories 中的資料，可以使用 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 Populaters

使用 `DomainClassConverter` 類

為 `Page` 建立 JSON 表示

使用 Spring Data 的 `PagedModel`

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