Spring Data Extensions

本節文件說明一組 Spring Data 擴充功能，這些擴充功能可在各種情境中啟用 Spring Data 的使用。目前，大多數的整合都以 Spring MVC 為目標。

Querydsl 擴充功能

Querydsl 是一個框架，可透過其流暢的 API 建立靜態型別的類 SQL 查詢。

多個 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 相關元件需要 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 類別

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 實例，以讓 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 到 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。新增至方法的分頁參數符合 PageableHandlerMethodArgumentResolver 的設定，以確保稍後可以解析連結。

假設我們的資料庫中有 30 個 Person 實例。您現在可以觸發請求 (GET localhost:8080/people)，並查看類似於以下的輸出

{ "links" : [
    { "rel" : "next", "href" : "https://127.0.0.1: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。

常見基礎結構會註冊下列網域類型的資料繫結 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 處理常式方法引數，或透過在 RestTemplate 的方法之一上使用 ParameterizedTypeReference。先前的方法宣告將嘗試在給定文件中任何位置尋找 firstname。lastname XML 查閱是在傳入文件的最上層執行的。JSON 變體會先嘗試最上層的 lastname，但如果前者未傳回值，也會嘗試巢狀於 user 子文件中的 lastname。這樣一來，可以輕鬆地減輕來源文件結構中的變更，而無需讓用戶端呼叫公開的方法（通常是基於類別的酬載繫結的缺點）。

支援巢狀投影，如 投影中所述。如果方法傳回複雜的非介面類型，則會使用 Jackson ObjectMapper 來對應最終值。

對於 Spring MVC，必要的轉換器會在 @EnableSpringDataWebSupport 處於活動狀態且必要的相依性在類別路徑上可用時自動註冊。對於搭配 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"))
當在類別路徑上找到 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 屬性。
您可以在從 repository 或 @QuerydslPredicate 套用特定繫結之前，註冊保留預設 Querydsl 繫結的 QuerydslBinderCustomizerDefaults bean。

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>