创建 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 名称以其封闭类型名称为前缀。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 结尾的接口被实例化。

独立使用

您还可以将 Repository 基础结构用于 Spring 容器之外 - 例如，在 CDI 环境中。您仍然需要类路径中的一些 Spring 库，但通常也可以以编程方式设置 Repository。提供 Repository 支持的 Spring Data 模块附带了一个特定于持久化技术的 RepositoryFactory，您可以按如下方式使用它

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