创建 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 名称以其 enclosing type 名称作为前缀。base package 属性允许使用通配符，因此您可以定义扫描包的模式。

使用过滤器

默认情况下，基础设施会选取配置的基础包下所有扩展特定于持久化技术的 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);