建立 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 名稱會加上其封閉類型名稱的前綴。base-package 屬性允許使用萬用字元，以便您可以定義掃描套件的模式。

使用篩選器

預設情況下，基礎架構會選取每個擴充特定於持久化技術的 Repository 子介面，且位於已組態的基本套件下的介面，並為其建立 Bean 實例。但是，您可能希望更精細地控制為哪些介面建立 Bean 實例。若要執行此操作，請在 repository 宣告內使用篩選器元素。語意與 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 程式庫，但通常您也可以以程式設計方式設定 repositories。提供 repository 支援的 Spring Data 模組隨附特定於持久化技術的 RepositoryFactory，您可以如下使用它

Repository factory 的獨立使用

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