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

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