建立 Repository 例項

本節介紹如何為定義的 Repository 介面建立例項和 Bean 定義。

Java 配置

在 Java 配置類上使用特定於儲存的 @EnableJpaRepositories 註解來定義 Repository 啟用配置。有關 Spring 容器基於 Java 的配置介紹，請參閱 Spring 參考文件中的 JavaConfig。

一個用於啟用 Spring Data Repository 的示例配置如下所示

基於註解的示例 Repository 配置
@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
前面的示例使用了 JPA 特定的註解，您需要根據實際使用的儲存模組進行更改。EntityManagerFactory Bean 的定義也適用相同的原則。請參閱有關特定於儲存的配置部分。

XML 配置

每個 Spring Data 模組都包含一個 repositories 元素，允許您定義 Spring 掃描的基礎包，如下例所示

透過 XML 啟用 Spring Data Repository
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns:beans="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="http://www.springframework.org/schema/data/jpa"
  xsi:schemaLocation="http://www.springframework.org/schema/beans
    https://www.springframework.org/schema/beans/spring-beans.xsd
    http://www.springframework.org/schema/data/jpa
    https://www.springframework.org/schema/data/jpa/spring-jpa.xsd">

  <jpa:repositories base-package="com.acme.repositories" />

</beans:beans>

在前面的示例中，Spring 被指示掃描 com.acme.repositories 及其所有子包，查詢擴充套件了 Repository 或其某個子介面的介面。對於找到的每個介面，基礎設施會註冊特定於持久化技術的 FactoryBean，以建立處理查詢方法呼叫的適當代理。每個 Bean 都以派生自介面名稱的 Bean 名稱註冊，因此 UserRepository 這樣的介面將註冊為 userRepository。巢狀 Repository 介面的 Bean 名稱會加上其包含型別名稱作為字首。基礎包屬性允許使用萬用字元，以便您可以定義掃描包的模式。

使用過濾器

預設情況下，基礎設施會選取配置的基礎包下擴充套件了特定於持久化技術的 Repository 子介面的每個介面，併為其建立一個 Bean 例項。然而，您可能需要更精細地控制為哪些介面建立 Bean 例項。為此，可以在 Repository 宣告中使用 filter 元素。其語義與 Spring 元件過濾器中的元素完全相同。詳情請參閱 Spring 參考文件 中關於這些元素的描述。

例如，要將某些介面排除在 Repository Bean 例項化之外，您可以使用以下配置

使用過濾器

  • Java

  • XML

@Configuration
@EnableJpaRepositories(basePackages = "com.acme.repositories",
    includeFilters = { @Filter(type = FilterType.REGEX, pattern = ".*SomeRepository") },
    excludeFilters = { @Filter(type = FilterType.REGEX, pattern = ".*SomeOtherRepository") })
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
<repositories base-package="com.acme.repositories">
  <context:include-filter type="regex" expression=".*SomeRepository" />
  <context:exclude-filter type="regex" expression=".*SomeOtherRepository" />
</repositories>

前面的示例包括所有以 SomeRepository 結尾的介面，並排除以 SomeOtherRepository 結尾的介面不被例項化。

獨立使用

您也可以在 Spring 容器之外使用 Repository 基礎設施，例如在 CDI 環境中。您仍然需要在類路徑中包含一些 Spring 庫，但通常也可以透過程式設計方式設定 Repository。提供 Repository 支援的 Spring Data 模組附帶一個特定於持久化技術的 RepositoryFactory，您可以按如下方式使用

獨立使用 Repository 工廠
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);