创建 Repository 实例

本节介绍如何为已定义的存储库接口创建实例和 bean 定义。

Java 配置

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

启用 Spring Data 存储库的示例配置如下所示

基于注解的存储库配置示例

@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}

前面的示例使用 JPA 特定的注解，您应该根据实际使用的存储模块进行更改。这同样适用于 EntityManagerFactory bean 的定义。请参阅涵盖特定于存储的配置的章节。

属性占位符和 Ant 风格模式

@EnableJpaRepositories 中的 basePackages 和 value 属性支持 ${…} 属性占位符，这些占位符将针对 Environment 进行解析，也支持 Ant 风格的包模式，例如 "org.example.**"。

以下示例为 @EnableJpaRepositories 中的隐式 value 属性指定了 app.scan.packages 属性占位符。

Java
Kotlin

@Configuration
@EnableJpaRepositories("${app.scan.packages}")    (1)
public class ApplicationConfiguration {
  // …
}

1	`app.scan.packages` 属性占位符将针对 `Environment` 进行解析

@EnableJpaRepositories(["\${app.scan.packages}"]) (1)
class ApplicationConfiguration {
  // …
}

1	`app.scan.packages` 属性占位符将针对 `Environment` 进行解析

XML 配置

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

通过 XML 启用 Spring Data 存储库

<?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。嵌套存储库接口的 bean 名称以其封闭类型名称为前缀。基包属性允许使用通配符，以便您可以定义扫描包的模式。

使用过滤器

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

例如，要将某些接口从实例化为存储库 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 容器之外使用存储库基础设施，例如在 CDI 环境中。您仍然需要在类路径中包含一些 Spring 库，但通常您也可以以编程方式设置存储库。提供存储库支持的 Spring Data 模块附带了一个持久性技术特定的 RepositoryFactory，您可以按如下方式使用它

存储库工厂的独立使用

RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);