Spring Data Commons 提供了创建分页仓储的便捷方法,该方法返回一个 Page<T> 对象,其中包含与指定查询匹配的分页记录。这允许开发人员轻松地处理和呈现分页数据,而无需手动构建和管理分页逻辑。本文档提供了一个清晰的分步指南,详细说明如何使用这种便捷方法创建分页仓储实例。

Creating Repository Instances

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

Java Configuration

在 Java 配置类上使用特定于存储的 @Enable{store}Repositories 注释,以定义存储库激活的配置。有关基于 Java 配置 Spring 容器的介绍,请参阅 {spring-framework-docs}/core/beans/java.html[Spring 参考手册中的 JavaConfig]。

用于启用 Spring 数据存储库的示例配置类似于以下内容:

Sample annotation-based repository configuration
@Configuration
@EnableJpaRepositories("com.acme.repositories")
class ApplicationConfiguration {

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

前一个示例使用了 JPA 特定注释,您会根据实际使用的存储模块更改此注释。它同样适用于 EntityManagerFactory bean 的定义。请参阅涵盖存储特定配置的部分。

XML Configuration

每个 Spring 数据模块都包含一个 repositories 元素,它允许您定义一个基本包,以便 Spring 为您扫描,如以下示例所示:

Enabling Spring Data repositories via XML
<?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 名称前缀为其包含类型的名称。基本包属性允许使用通配符,这样您就可以定义已扫描包的模式。

Using Filters

默认情况下,基础设施会选择每个扩展持久性技术特定的位于配置的基本包下的 Repository 子接口的接口,并为其创建一个 bean 实例。但是,您可能希望更精细地控制为哪些接口创建 bean 实例。为此,请在存储库声明中使用 filter 元素。语义与 Spring 组件过滤器中的元素完全相同。有关详细信息,请参阅针对这些元素的 {spring-framework-docs}/core/beans/classpath-scanning.html[Spring 参考手册]。

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

Using filters
  • Java

  • XML

@Configuration
@Enable{store}Repositories(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 结尾的接口进行实例化。

Standalone Usage

您还可以在 Spring 容器外部使用存储库基础设施,例如在 CDI 环境中。您仍然需要在类路径中包含一些 Spring 库,但一般来说,您也可以以编程方式设置存储库。提供存储库支持的 Spring 数据模块附带特定于持久性技术的 RepositoryFactory,您可以使用此工厂,如下所示:

Standalone usage of the repository factory
RepositoryFactorySupport factory = … // Instantiate factory here
UserRepository repository = factory.getRepository(UserRepository.class);