建立儲存庫實例

本節介紹如何為已定義的儲存庫介面建立實例和 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，以建立適當的 Proxy 來處理查詢方法的調用。每個 Bean 都以從介面名稱衍生的 Bean 名稱註冊，因此 UserRepository 的介面將在 userRepository 下註冊。巢狀儲存庫介面的 Bean 名稱會加上其封閉型別名稱作為前綴。基礎套件屬性允許使用萬用字元，以便您可以定義掃描套件的模式。

使用篩選器

預設情況下，基礎架構會選取每個擴充位於已配置基礎套件下的特定於持久化技術的 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，您可以按如下方式使用

儲存庫 Factory 的獨立使用
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);