建立儲存庫例項

本節介紹如何為定義的儲存庫介面建立例項和 bean 定義。

Java 配置

在 Java 配置類上使用特定於儲存的 @EnableLdapRepositories 註解來定義儲存庫啟用的配置。 有關 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 例項進行更細粒度的控制。 為此,請在儲存庫宣告中使用 filter 元素。 語義與 Spring 的元件過濾器中的元素完全等效。 有關詳細資訊,請參閱 Spring 參考文件,瞭解這些元素。

例如,要從例項化為儲存庫 bean 中排除某些介面,您可以使用以下配置

使用過濾器
  • Java

  • XML

@Configuration
@EnableLdapRepositories(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);