创建 Repository 实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableJpaRepositories 注解来定义 repository 激活配置。有关 Spring 容器的基于 Java 的配置的介绍，请参阅 Spring 参考文档中的 JavaConfig。

启用 Spring Data repositories 的示例配置如下所示

基于注解的 repository 配置示例
@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
前面的示例使用 JPA 特定注解，您可以根据实际使用的存储模块进行更改。这也适用于 EntityManagerFactory bean 的定义。请参阅介绍特定于存储配置的章节。

XML 配置

每个 Spring Data 模块都包含一个 repositories 元素，允许您定义一个基本包，Spring 会为您扫描该包，示例如下

通过 XML 启用 Spring Data repositories
<?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。嵌套 repository 接口的 bean 名称以其包含类型名称为前缀。基本包属性允许使用通配符，以便您可以定义一个扫描包的模式。

使用过滤器

默认情况下，基础设施会获取配置的基本包下扩展特定于持久化技术的 Repository 子接口的每个接口，并为其创建一个 bean 实例。但是，您可能希望对哪些接口创建 bean 实例有更精细的控制。为此，请在 repository 声明中使用 filter 元素。其语义与 Spring 组件过滤器中的元素完全相同。有关详细信息，请参阅 Spring 参考文档中关于这些元素的介绍。

例如，要从 repository 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 容器之外使用 repository 基础设施，例如在 CDI 环境中。您仍然需要在 classpath 中包含一些 Spring 库，但通常也可以通过编程方式设置 repository。提供 repository 支持的 Spring Data 模块随附特定于持久化技术的 RepositoryFactory，您可以按如下方式使用它

Repository Factory 的独立用法
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);