此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Data Cassandra 5.0.4spring-doc.cadn.net.cn

创建 Repository 实例

本节介绍如何为已定义的仓库接口创建实例和 Bean 定义。spring-doc.cadn.net.cn

Java 配置

在 Java 配置类上使用特定于存储的 @EnableCassandraRepositories 注解,以定义用于激活仓库的配置。 有关 Spring 容器基于 Java 的配置的介绍,请参阅 Spring 参考文档中的 JavaConfigspring-doc.cadn.net.cn

启用 Spring Data 仓库的示例配置如下所示:spring-doc.cadn.net.cn

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

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
上述示例使用了 JPA 特定的注解,您应根据实际使用的存储模块进行相应更改。EntityManagerFactory bean 的定义也是如此。请参阅涵盖特定存储配置的相关章节。

属性占位符和 Ant 风格模式

basePackages 注解中的 value@EnableCassandraRepositories 属性支持 ${…} 形式的属性占位符,这些占位符会根据 Environment 进行解析,同时也支持 Ant 风格的包路径模式,例如 "org.example.**"spring-doc.cadn.net.cn

以下示例为 app.scan.packages 中隐式的 value 属性指定了 @EnableCassandraRepositories 属性占位符。spring-doc.cadn.net.cn

@Configuration
@EnableCassandraRepositories("${app.scan.packages}")    (1)
public class ApplicationConfiguration {
  // …
}
1 app.scan.packages 属性占位符,将根据 Environment 进行解析
@EnableCassandraRepositories(["\${app.scan.packages}"]) (1)
class ApplicationConfiguration {
  // …
}
1 app.scan.packages 属性占位符,将根据 Environment 进行解析

XML 配置

每个 Spring Data 模块都包含一个 repositories 元素,允许你定义一个基础包,Spring 会自动为你扫描该包,如下例所示:spring-doc.cadn.net.cn

通过 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 属性支持通配符,因此您可以定义要扫描的包的模式。spring-doc.cadn.net.cn

使用过滤器

默认情况下,基础设施会扫描配置的基础包下所有继承了特定持久化技术的 Repository 子接口的接口,并为每个这样的接口创建一个 Bean 实例。 然而,你可能希望更精细地控制哪些接口需要为其创建 Bean 实例。 为此,可以在 repository 声明中使用过滤器(filter)元素。 这些过滤器的语义与 Spring 组件扫描中的过滤器元素完全相同。 有关详细信息,请参阅这些元素的Spring 参考文档spring-doc.cadn.net.cn

例如,若要排除某些接口不被实例化为仓库 Bean,您可以使用以下配置:spring-doc.cadn.net.cn

使用过滤器
@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-doc.cadn.net.cn

独立使用

你也可以在 Spring 容器之外使用仓库(repository)基础设施——例如,在 CDI 环境中。你仍然需要在类路径中包含一些 Spring 库,但通常也可以通过编程方式设置仓库。提供仓库支持的 Spring Data 模块都附带了一个特定于持久化技术的 RepositoryFactory,你可以按如下方式使用它:spring-doc.cadn.net.cn

仓库工厂的独立使用
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);