建立儲存庫實例

本節介紹如何為已定義的儲存庫介面建立實例和 Bean 定義。

Java 配置

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

啟用 Spring Data 儲存庫的範例配置如下所示

基於註解的儲存庫配置範例

@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}

前面的範例使用了特定於 JPA 的註解，您需要根據您實際使用的儲存庫模組進行更改。 EntityManagerFactory Bean 的定義也是如此。請參閱涵蓋特定於儲存庫的配置章節。

XML 配置

每個 Spring Data 模組都包含一個 repositories 元素，可讓您定義一個基礎套件，Spring 會為您掃描，如下例所示

通過 XML 啟用 Spring Data 儲存庫

<?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 註冊。巢狀儲存庫介面的 Bean 名稱以其封閉類型名稱作為前綴。 base-package 屬性允許使用萬用字元，以便您可以定義掃描套件的模式。

使用篩選器

預設情況下，基礎架構會選取每個擴展特定於持久化技術的 Repository 子介面，且位於配置的基礎套件下的介面，並為其建立 Bean 實例。但是，您可能希望更精細地控制為哪些介面建立 Bean 實例。為此，請在儲存庫宣告內使用篩選器元素。其語義與 Spring 組件篩選器中的元素完全相同。有關詳細信息，請參閱 Spring 參考文檔中關於這些元素的說明。

例如，要從實例化為儲存庫 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 容器之外使用儲存庫基礎架構，例如在 CDI 環境中。您仍然需要在類路徑中包含一些 Spring 庫，但通常您也可以以程式設計方式設定儲存庫。提供儲存庫支援的 Spring Data 模組附帶一個特定於持久化技術的 RepositoryFactory，您可以按如下方式使用它

儲存庫工廠的獨立使用

RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);