创建存储库实例

本节介绍如何为定义的存储库接口创建实例和 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);