建立 Repository 例項

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

Java 配置

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

啟用 Spring Data repositories 的示例配置如下所示

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

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
前面的示例使用 JPA 特定註解，您可以根據實際使用的儲存模組進行更改。這也適用於 EntityManagerFactory bean 的定義。請參閱介紹特定於儲存配置的章節。

XML 配置

每個 Spring Data 模組都包含一個 repositories 元素，允許您定義一個基本包，Spring 會為您掃描該包，示例如下

透過 XML 啟用 Spring Data repositories
<?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 環境中。您仍然需要在 classpath 中包含一些 Spring 庫，但通常也可以透過程式設計方式設定 repository。提供 repository 支援的 Spring Data 模組隨附特定於持久化技術的 RepositoryFactory，您可以按如下方式使用它

Repository Factory 的獨立用法
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);