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);

使用 Querydsl 的型別安全查詢方法

MongoDB Repository 及其響應式對應部分與 Querydsl 專案整合，後者提供了一種執行型別安全查詢的方式。

查詢不是以內聯字串形式編寫或外部化到 XML 檔案中，而是透過流式 API 構建。

— Querydsl 團隊

它提供以下功能

IDE 中的程式碼補全（所有屬性、方法和操作都可以在您喜歡的 Java IDE 中展開）。
幾乎不允許語法無效的查詢（在所有級別上都是型別安全的）。
領域型別和屬性可以安全地引用——不涉及字串！
更好地適應領域型別中的重構更改。
增量式查詢定義更容易。

有關如何使用 Maven 或 Ant 引導基於 APT 的程式碼生成環境的資訊，請參閱Querydsl 文件。

QueryDSL 允許您編寫如下查詢

命令式
響應式

QPerson person = QPerson.person;
List<Person> result = repository.findAll(person.address.zipCode.eq("C0123"));

Page<Person> page = repository.findAll(person.lastname.contains("a"),
                                       PageRequest.of(0, 2, Direction.ASC, "lastname"));

QPerson person = QPerson.person;

Flux<Person> result = repository.findAll(person.address.zipCode.eq("C0123"));

QPerson 是一個由 Java 註解處理器生成的類。有關如何使用構建系統設定註解處理的資訊，請參閱設定註解處理。它是一個 Predicate，可讓您編寫型別安全的查詢。請注意，除了 C0123 值之外，查詢中沒有字串。

您可以透過使用 QuerydslPredicateExecutor / ReactiveQuerydslPredicateExecutor 介面來使用生成的 Predicate 類，如下所示

命令式
響應式

public interface QuerydslPredicateExecutor<T> {

    Optional<T> findOne(Predicate predicate);

    List<T> findAll(Predicate predicate);

    List<T> findAll(Predicate predicate, Sort sort);

    List<T> findAll(Predicate predicate, OrderSpecifier<?>... orders);

    Page<T> findAll(Predicate predicate, Pageable pageable);

    List<T> findAll(OrderSpecifier<?>... orders);

    long count(Predicate predicate);

    boolean exists(Predicate predicate);

    <S extends T, R> R findBy(Predicate predicate, Function<FluentQuery.FetchableFluentQuery<S>, R> queryFunction);
}

interface ReactiveQuerydslPredicateExecutor<T> {

    Mono<T> findOne(Predicate predicate);

    Flux<T> findAll(Predicate predicate);

    Flux<T> findAll(Predicate predicate, Sort sort);

    Flux<T> findAll(Predicate predicate, OrderSpecifier<?>... orders);

    Flux<T> findAll(OrderSpecifier<?>... orders);

    Mono<Long> count(Predicate predicate);

    Mono<Boolean> exists(Predicate predicate);

    <S extends T, R, P extends Publisher<R>> P findBy(Predicate predicate,
            Function<FluentQuery.ReactiveFluentQuery<S>, P> queryFunction);
}

要在您的 Repository 實現中使用它，請將其新增到您的介面繼承的 Repository 介面列表中，如下例所示

命令式
響應式

interface PersonRepository extends MongoRepository<Person, String>, QuerydslPredicateExecutor<Person> {

    // additional query methods go here
}

interface PersonRepository extends ReactiveMongoRepository<Person, String>, ReactiveQuerydslPredicateExecutor<Person> {

    // additional query methods go here
}

請注意，響應式 MongoDB 支援不支援 join（DBRef）。

設定註解處理

要在 Spring Data MongoDB 中使用 Querydsl，您需要在構建系統中設定註解處理，以生成 Q 類。雖然您可以手動編寫 Q 類，但建議使用 Querydsl 註解處理器為您生成它們，以便您的 Q 類與您的領域模型保持同步。

Spring Data MongoDB 附帶一個註解處理器 MongoAnnotationProcessor，預設情況下未註冊。通常，註解處理器透過 Java 的服務載入器，透過 META-INF/services/javax.annotation.processing.Processor 進行註冊，一旦它們在類路徑上，也會被啟用。大多數 Spring Data 使用者不使用 Querydsl，因此對於無法從 Querydsl 中受益的專案來說，要求額外的強制依賴項是沒有意義的。因此，您需要在構建系統中啟用註解處理。

以下示例展示瞭如何在 Maven 和 Gradle 中透過提及依賴項和編譯器配置更改來設定註解處理

Maven
Gradle

<dependencies>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-mongodb</artifactId>
    </dependency>

    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-mongodb</artifactId>
        <version>${querydslVersion}</version>

        <!-- Recommended: Exclude the mongo-java-driver to avoid version conflicts -->
        <exclusions>
            <exclusion>
                <groupId>org.mongodb</groupId>
                <artifactId>mongo-java-driver</artifactId>
            </exclusion>
        </exclusions>
    </dependency>

    <dependency>
        <groupId>com.querydsl</groupId>
        <artifactId>querydsl-apt</artifactId>
        <version>${querydslVersion}</version>
        <classifier>jakarta</classifier>
        <scope>provided</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <annotationProcessors>
                    <annotationProcessor>
                        org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor
                    </annotationProcessor>
                </annotationProcessors>

                <!-- Recommended: Some IDE's might require this configuration to include generated sources for IDE usage -->
                <generatedTestSourcesDirectory>target/generated-test-sources</generatedTestSourcesDirectory>
                <generatedSourcesDirectory>target/generated-sources</generatedSourcesDirectory>
            </configuration>
        </plugin>
    </plugins>
</build>

dependencies {
    implementation 'com.querydsl:querydsl-mongodb:${querydslVersion}'

    annotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
    annotationProcessor 'org.springframework.data:spring-data-mongodb'

    testAnnotationProcessor 'com.querydsl:querydsl-apt:${querydslVersion}:jakarta'
    testAnnotationProcessor 'org.springframework.data:spring-data-mongodb'
}

tasks.withType(JavaCompile).configureEach {
    options.compilerArgs += [
            "-processor",
            "org.springframework.data.mongodb.repository.support.MongoAnnotationProcessor"]
}

請注意，上述設定僅顯示了最簡單的用法，省略了您的專案可能需要的任何其他選項或依賴項。這種配置註解處理的方式會停用 Java 的註解處理器掃描，因為 MongoDB 需要按類名指定 -processor。如果您正在使用其他註解處理器，您也需要將它們新增到 -processor/annotationProcessors 列表中。

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 Modules 用於序列化/反序列化 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 開始索引，預設為 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 欄位，暴露了必要的 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。類似地，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://: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 Modules

核心模組以及一些特定儲存模組附帶了一組 Jackson Modules，用於 Spring Data 領域使用的型別，如 org.springframework.data.geo.Distance 和 org.springframework.data.geo.Point。
一旦啟用 web 支援並且 com.fasterxml.jackson.databind.ObjectMapper 可用，就會匯入這些 Modules。

在初始化期間，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 處理程式方法的引數，或者透過在 RestTemplate 的某個方法上使用 ParameterizedTypeReference。前面的方法宣告會嘗試在給定文件的任何位置查詢 firstname。lastname XML 查詢是在傳入文件的頂層執行的。其 JSON 變體首先嚐試頂層的 lastname，如果前者沒有返回值，也會嘗試巢狀在 user 子文件中的 lastname。這樣，可以輕鬆應對源文件結構的變化，而無需客戶端呼叫公開的方法（這通常是基於類的負載繫結的缺點）。

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

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

更多資訊請參見標準 Spring Data 示例 Repository 中的 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`。
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）來定義用於填充 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

宣告一個解組 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 擴充套件

使用 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` 的超媒體支援