创建仓库实例

本节介绍如何为已定义的仓库接口创建实例和 Bean 定义。

Java 配置

在 Java 配置类上使用特定于存储的@EnableElasticsearchRepositories注解来定义仓库激活的配置。有关基于 Java 的 Spring 容器配置的介绍,请参见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);