创建存储库实例

本部分介绍如何为定义的存储库接口创建实例和 Bean 定义。

Java 配置

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

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

基于注解的存储库配置示例
@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
前面的示例使用特定于 JPA 的注解，您应该根据实际使用的存储模块对其进行更改。EntityManagerFactory Bean 的定义也适用。请参阅涵盖特定于存储的配置的部分。

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 实例的接口。为此，请在存储库声明中使用过滤器元素。语义与 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);