建立倉庫例項

本節介紹如何為定義的倉庫介面建立例項和 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 名稱會加上其 enclosing 型別名稱作為字首。基礎包屬性允許使用萬用字元，以便您可以定義掃描包的模式。

使用過濾器

預設情況下，基礎設施會拾取配置的基礎包下位於特定於持久化技術的 Repository 子介面的每個介面，併為其建立一個 bean 例項。但是，您可能希望更精細地控制為哪些介面建立 bean 例項。為此，請在倉庫宣告中使用 filter 元素。其語義與 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 環境中。您的 classpath 中仍然需要一些 Spring 庫，但通常您也可以透過程式設計方式設定倉庫。提供倉庫支援的 Spring Data 模組都附帶一個特定於持久化技術的 RepositoryFactory，您可以按如下方式使用

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