创建仓库实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableJpaRepositories 注解来定义仓库激活的配置。有关基于 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
@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);