创建 Repository 实例

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

Java 配置

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

一个用于启用 Spring Data Repository 的示例配置如下所示

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

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
前面的示例使用了 JPA 特定的注解，您需要根据实际使用的存储模块进行更改。EntityManagerFactory Bean 的定义也适用相同的原则。请参阅有关特定于存储的配置部分。

XML 配置

每个 Spring Data 模块都包含一个 repositories 元素，允许您定义 Spring 扫描的基础包，如下例所示

通过 XML 启用 Spring Data Repository
<?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 环境中。您仍然需要在类路径中包含一些 Spring 库，但通常也可以通过编程方式设置 Repository。提供 Repository 支持的 Spring Data 模块附带一个特定于持久化技术的 RepositoryFactory，您可以按如下方式使用

独立使用 Repository 工厂
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);