创建仓库实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableJpaRepositories 注解来定义仓库激活配置。有关 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 类型名称作为前缀。基础包属性允许使用通配符,因此您可以定义一个扫描包的模式。

使用过滤器

默认情况下,基础设施会拾取配置的基础包下扩展特定于持久化技术的 Repository 子接口的每个接口,并为其创建 bean 实例。但是,您可能希望对哪些接口创建 bean 实例进行更精细的控制。为此,请在仓库声明内部使用 filter 元素。其语义与 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);