创建 Repository 实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableJdbcRepositories 注解来定义 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 名称会带有其包围类型的名称前缀。base-package 属性允许使用通配符，以便您可以定义扫描包的模式。

使用过滤器

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

例如，要从实例化为 repository bean 中排除某些接口，您可以使用以下配置

使用过滤器

  • Java

  • XML

@Configuration
@EnableJdbcRepositories(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 工厂的独立使用
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);