建立倉庫例項

本節介紹如何為定義的倉庫介面建立例項和 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 環境中。您仍然需要在類路徑中包含一些 Spring 庫,但通常您也可以透過程式設計方式設定倉庫。提供倉庫支援的 Spring Data 模組附帶一個特定於持久化技術的 RepositoryFactory,您可以按如下方式使用

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