建立倉庫例項

本節介紹如何為定義的倉庫介面建立例項和 Bean 定義。

Java 配置

在 Java 配置類上使用特定於儲存的 `@EnableCouchbaseRepositories` 註解來定義倉庫啟用配置。有關 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 型別名稱作為字首。base package 屬性允許使用萬用字元，這樣你就可以定義掃描包的模式。

使用過濾器

預設情況下，基礎設施會選取位於配置的基礎包下、擴充套件持久化技術特定的 Repository 子介面的每個介面，併為其建立一個 Bean 例項。但是，你可能希望對哪些介面建立 Bean 例項擁有更精細的控制。為此，可以在倉庫宣告內部使用 filter 元素。其語義與 Spring 元件過濾器中的元素完全等價。詳情請參閱這些元素的 Spring 參考文件。

例如，要將某些介面排除在作為倉庫 Bean 例項化之外，可以使用以下配置

使用過濾器

  • Java

  • XML

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