跳到主要内容

创建仓库实例

Doubao 中英对照 Creating Repository Instances

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

Java 配置​

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

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

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

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

前述示例使用了 JPA 专用注解，您应根据实际使用的存储模块进行更改。EntityManagerFactory bean 的定义也是如此。请参阅介绍特定存储配置的各节。

属性占位符与 Ant 风格模式​

@EnableJdbcRepositories 中的 basePackages 和 value 属性支持 ${…} 属性占位符（针对 Environment 解析）以及 Ant 风格的包模式，如 "org.example.**"。

以下示例为 @EnableJdbcRepositories 中的隐式 value 属性指定了 app.scan.packages 属性占位符。

@Configuration
@EnableJdbcRepositories("${app.scan.packages}")    1
public class ApplicationConfiguration {
  // …
}
java

  • app.scan.packages property placeholder to be resolved against the Environment

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 名称会加上其外层类型名称作为前缀。基础包属性允许使用通配符，以便您定义要扫描的包的模式。

使用过滤器​

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

例如，要将某些接口排除在实例化为仓库 bean 之外，您可以使用以下配置：

@Configuration
@EnableJdbcRepositories(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 环境中。您的 classpath 中仍然需要一些 Spring 库，但一般来说，您也可以以编程方式设置仓库。提供仓库支持的 Spring Data 模块附带了一个特定持久化技术的 RepositoryFactory，您可以如下使用它：

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