redis om 的 redisconnection 初始化必须指定 schema,否则无法生成索引导致 findasync 返回空;schema 注册是查询前提,需调用 getcollections() 触发类型发现;类需加 [document]、字段加 [redisfield] 才可被索引和查询。

Redis OM 的 RedisConnection 初始化必须指定 Schema
不显式注册类型,RedisConnection 无法自动生成索引,后续 FindAsync 会始终返回空结果。Schema 注册不是可选步骤,而是查询功能的前提。
- 必须在创建
RedisConnection后立即调用GetCollections<t>()</t>或GetKeys<t>()</t>触发类型发现,否则字段不会被索引 - 若使用
RedisConnection单例,建议在应用启动时统一调用一次connection.GetCollections<user>()</user>等,避免运行时首次查询延迟 - 类上不加
[Document]特性,或字段没加[RedisField](尤其是需要搜索的字段),对应字段不会写入 Redis Hash,也无法被查询
RedisCollection<t></t> 的增删改查与原生命令差异明显
它不等价于 List 或 Set 操作,而是基于 Redis Search 构建的文档集合 —— 所有数据实际以 Hash 存储,索引由 RedisSearch 引擎维护。这意味着:
-
AddAsync()写入的是完整对象,自动生成唯一 ID(如user:123),不能手动指定键名;如需自定义键,请改用IDatabase.StringSet()+ 序列化 -
UpdateAsync()要求对象含[RedisId]字段且已存在,否则抛RedisServerException:”No such document“ -
DeleteAsync()删除的是整个文档(即整个 Hash),不是某个字段;删除后索引自动同步更新 - 不支持事务内混合使用
RedisCollection和原生命令(如StringSet),可能造成索引不一致
查询条件必须走 Where() 链式表达式,不能拼接字符串
Redis OM 不接受原始 FT.SEARCH 命令字符串,所有查询都经由 LINQ 表达式树翻译。写错语法会导致运行时报 NotSupportedException 或静默返回空。
- 只支持部分 LINQ 方法:
Where、OrderBy、Take、Skip,不支持GroupBy、Join、Any() - 字符串匹配必须用
.Contains()(对应 RedisSearch 的*通配)、.StartsWith()(前缀索引需字段声明为[Text(TextFieldOptions.NoStem)]) - 数值范围用
>=、,但不能写成 <code>field > min && field —— 必须拆成两个 <code>Where()调用或用Between()扩展方法 - 复合条件默认是 AND;OR 需用
Expression.OrElse构造,或借助第三方扩展如Redis.OM.Linq
序列化行为不可控,复杂类型要谨慎处理
Redis OM 默认用 System.Text.Json 序列化整个对象到 Hash 的 __value 字段(仅当启用 JsonStorage 时),但多数场景下它走的是字段级映射 —— 每个属性单独存为 Hash 的一个 field。这意味着:
- 不支持嵌套对象自动展开,
public Address Address { get; set; }会被序列化为 JSON 字符串存进单个 field,无法对其内部字段建立索引或查询 - 集合类型(
List<string></string>、Dictionary<string int></string>)同样被整体 JSON 化,不能按元素筛选 - DateTime 默认转为 ISO8601 字符串,若需数值比较(如按时间戳排序),应额外添加
[RedisField(typeof(long))]并存DateTimeOffset.UtcNow.ToUnixTimeMilliseconds() - 自定义 Converter(如
JsonConverter<myenum></myenum>)不会被 Redis OM 使用,枚举仍按整数存储,除非显式设[JsonConverter]且启用 JSON 模式
字段级映射是默认且推荐的方式,JSON 模式(new RedisConnection(..., new RedisOptions { StorageType = StorageType.Json }))只适合读多写少、结构不固定、且不需要字段级查询的场景。










