创建存储库实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableLdapRepositories 注解来定义存储库激活的配置。 有关 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 名称以其封闭类型名称作为前缀。 base-package 属性允许使用通配符,因此您可以定义扫描包的模式。

使用过滤器

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

例如,要从实例化为存储库 bean 中排除某些接口,您可以使用以下配置

使用过滤器
  • Java

  • XML

@Configuration
@EnableLdapRepositories(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);