跳到主要内容
版本:4.4.3

创建存储库实例

ChatGPT-4o-mini 中英对照 Creating Repository Instances

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

Java 配置​

在 Java 配置类中使用特定于存储的 @EnableCassandraRepositories 注解来定义仓库激活的配置。有关基于 Java 的 Spring 容器配置的介绍,请参见 Spring 文档中的 JavaConfig。

启用 Spring Data 仓库的示例配置如下所示:

@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

@Bean
EntityManagerFactory entityManagerFactory() {
// …
}
}
备注

前面的示例使用了 JPA 特定的注解,你需要根据实际使用的存储模块进行更改。EntityManagerFactory bean 的定义也适用相同的原则。请参阅有关存储特定配置的章节。

XML 配置​

每个 Spring Data 模块都包含一个 repositories 元素,允许您定义一个 Spring 为您扫描的基础包,如下例所示:

<?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 实例。为此,请在仓库声明中使用过滤器元素。这些语义与 Spring 的组件过滤器中的元素完全相同。有关这些元素的详细信息,请参阅 Spring参考文档。

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

@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() {
// …
}
}

前面的例子包括所有以 SomeRepository 结尾的接口,并排除了那些以 SomeOtherRepository 结尾的接口不被实例化。

独立使用​

您还可以在 Spring 容器之外使用存储库基础设施 — 例如,在 CDI 环境中。您仍然需要在类路径中包含一些 Spring 库,但通常,您也可以以编程方式设置存储库。提供存储库支持的 Spring Data 模块附带特定于持久性技术的 RepositoryFactory,您可以按如下方式使用它:

RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);