建立倉庫例項

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

Java 配置

在 Java 配置類上使用特定於儲存的 `@EnableElasticsearchRepositories` 註解來定義倉庫啟用配置。有關 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 名稱會加上其封閉型別名稱作為字首。基礎包屬性允許使用萬用字元,以便您可以定義掃描包的模式。

使用過濾器

預設情況下,基礎設施會查詢配置的基礎包下擴充套件特定於持久化技術的 `Repository` 子介面的每個介面,併為其建立一個 Bean 例項。但是,您可能希望更精細地控制為哪些介面建立 Bean 例項。為此,請在倉庫宣告中使用過濾器元素。其語義與 Spring 的元件過濾器中的元素完全等效。有關詳細資訊,請參閱 Spring 參考文件中關於這些元素的說明。

例如,要將某些介面排除在外,不建立倉庫 Bean 例項,您可以使用以下配置

使用過濾器
  • Java

  • XML

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