创建 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 名称会带有其包含类型名称的前缀。基础包属性允许使用通配符，以便你可以定义扫描包的模式。

使用过滤器

默认情况下，基础设施会获取配置的基础包下扩展特定于持久化技术的 `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 库，但通常你也可以以编程方式设置 Repositories。提供 Repository 支持的 Spring Data 模块附带一个特定于持久化技术的 `RepositoryFactory`，你可以按如下方式使用它

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