跳到主要内容

创建存储库实例

DeepSeek V3 中英对照 Creating Repository Instances

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

Java 配置​

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

一个启用 Spring Data 仓库的示例配置如下：

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

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

前面的示例使用了 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>
xml

在前面的示例中，Spring 被指示扫描 com.acme.repositories 及其所有子包，寻找扩展了 Repository 或其子接口的接口。对于找到的每个接口，基础设施会注册特定持久化技术的 FactoryBean，以创建处理查询方法调用的适当代理。每个 bean 都会根据接口名称派生一个 bean 名称进行注册，因此 UserRepository 接口将被注册为 userRepository。嵌套的存储库接口的 bean 名称会以其封闭类型名称作为前缀。basePackage 属性允许使用通配符，因此你可以定义扫描包的模式。

使用过滤器​

默认情况下，基础设施会扫描配置的基础包下所有扩展了特定持久化技术 Repository 子接口的接口，并为它们创建 Bean 实例。然而，您可能希望对哪些接口创建 Bean 实例进行更细粒度的控制。为此，可以在 repository 声明中使用 filter 元素。其语义与 Spring 组件过滤器中的元素完全相同。有关详细信息，请参阅 Spring 参考文档 中关于这些元素的说明。

例如，要排除某些接口不被实例化为存储库 bean，你可以使用以下配置：

@Configuration
@EnableElasticsearchRepositories(basePackages = "com.acme.repositories",
    includeFilters = { @Filter(type = FilterType.REGEX, pattern = ".*SomeRepository") },
    excludeFilters = { @Filter(type = FilterType.REGEX, pattern = ".*SomeOtherRepository") })
class ApplicationConfiguration {

  @Bean
  EntityManagerFactory entityManagerFactory() {
    // …
  }
}
java

前面的示例包括了所有以 SomeRepository 结尾的接口，并排除了以 SomeOtherRepository 结尾的接口，使其不会被实例化。

独立使用​

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

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