创建 Repository 实例

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

Java 配置

在 Java 配置类上使用特定于存储的 @EnableCassandraRepositories 注解,为 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
@EnableCassandraRepositories(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);