Redis 仓库
本章解释 Spring Data 仓库的基本基础以及 Redis 的特有内容。在继续了解 Redis 的特有内容之前,请确保你已牢固掌握基本概念。
Spring Data 仓库抽象的目标是显著减少为各种持久化存储实现数据访问层所需的样板代码量。
使用 Redis 仓库可以让你无缝地在 Redis Hash 中转换和存储领域对象、应用自定义映射策略,并使用二级索引。
Redis 仓库至少需要 Redis Server 2.8.0 版本,并且不能与事务一起工作。请确保使用一个禁用了事务支持的 RedisTemplate。
章节摘要
核心概念
Spring Data 仓库抽象中的核心接口是 Repository。它以要管理的领域类以及该领域类的标识符类型作为类型参数。该接口主要充当一个标记接口,用于捕获要处理的类型,并帮助你发现扩展了该接口的接口。
定义仓库接口
要定义仓库接口,你首先需要定义一个特定于领域类的仓库接口。该接口必须扩展 Repository,并以领域类和 ID 类型作为类型参数。如果你想为该领域类型暴露 CRUD 方法,可以扩展 CrudRepository 或其变体之一,而不是扩展 Repository。
创建仓库实例
本节介绍如何为已定义的仓库接口创建实例和 bean 定义。
用法
Spring Data Redis 让你可以轻松实现领域实体,如下例所示:
对象映射基础
本节介绍 Spring Data 对象映射、对象创建、字段和属性访问、可变性和不可变性的基础。请注意,本节仅适用于不使用底层数据存储(如 JPA)对象映射的 Spring Data 模块。还请务必参阅特定于存储的各节,了解特定于存储的对象映射,例如索引、自定义列或字段名等。
定义查询方法
仓库代理有两种方式从方法名派生特定于存储的查询:
对象到 Hash 的映射
Redis 仓库支持将对象持久化到 Hash。这需要对象到 Hash 的转换,该转换由 RedisConverter 完成。默认实现使用 Converter 在属性值与 Redis 原生 byte[] 之间进行映射。
键空间
键空间定义用于创建 Redis Hash 实际键的前缀。默认情况下,前缀设置为 getClass().getName()。你可以通过在聚合根级别设置 @RedisHash 或建立编程式配置来更改此默认值。不过,注解指定的键空间优先于任何其他配置。
二级索引
二级索引用于支持基于原生 Redis 结构的查找操作。每次保存时会将值写入相应的索引,并在对象被删除或过期时移除。
存活时间
存储在 Redis 中的对象可能仅在一定时间内有效。这对于在 Redis 中持久化短生命周期对象特别有用,无需在对象到达生命终点时手动删除。过期时间(秒)可以通过 @RedisHash(timeToLive=…) 设置,也可以通过 KeyspaceConfiguration.KeyspaceSettings 设置(参见 Keyspaces)。
Redis 专属查询方法
查询方法允许从方法名自动派生简单的查找查询,如下例所示:
示例查询
本章介绍示例查询(Query by Example)并说明如何使用它。
在集群上运行 Redis 仓库
你可以在集群化的 Redis 环境中使用 Redis 仓库支持。有关 ConnectionFactory 配置的详细信息,请参阅"Redis Cluster"一节。尽管如此,仍需进行一些额外配置,因为默认的键分布会将实体和二级索引分散到整个集群及其槽位中。
Redis 仓库剖析
Redis 作为存储本身仅提供非常狭窄的底层 API,将二级索引和查询操作等更高级别的功能留给用户自行实现。
投影
Spring Data 查询方法通常返回由仓库管理的聚合根的一个或多个实例。然而,有时可能希望基于这些类型的某些属性创建投影。Spring Data 允许建模专用的返回类型,以更有选择地检索所管理聚合的部分视图。
自定义仓库实现
Spring Data 提供了多种选项来以极少的代码创建查询方法。但是当这些选项不能满足你的需求时,你也可以为仓库方法提供自己的自定义实现。本节介绍如何做到这一点。
从聚合根发布事件
由仓库管理的实体是聚合根。在领域驱动设计(DDD)应用程序中,这些聚合根通常会发布领域事件。Spring Data 提供了一个名为 @DomainEvents 的注解,你可以在聚合根的方法上使用它,以尽可能简单地完成该发布,如下例所示:
仓库方法的空值处理
返回单个聚合实例的仓库 CRUD 方法可以使用 Optional 来指示值可能不存在。除此之外,Spring Data 还支持在查询方法上返回以下包装类型:
CDI 集成
仓库接口的实例通常由容器创建;在使用 Spring Data 时,Spring 是最自然的选择。Spring 提供了创建 bean 实例的成熟机制。Spring Data Redis 附带一个自定义 CDI 扩展,使你能够在 CDI 环境中使用仓库抽象。该扩展是 JAR 的一部分,因此要激活它,只需将 Spring Data Redis JAR 放入你的 classpath 即可。
仓库查询关键字
下表列出了 Spring Data 仓库查询派生机制通常支持的、用于表达谓词的主语关键字。请参阅特定于存储的文档以获取支持的关键字的确切列表,因为这里列出的某些关键字在特定存储中可能不受支持。
仓库查询返回类型
下表列出了 Spring Data 仓库通常支持的返回类型。但是,请参阅特定于存储的文档以获取支持的返回类型的确切列表,因为这里列出的某些类型在特定存储中可能不受支持。