使用 C# 存取 redis JSON

雖然一直以來持續都在使用 redis，只是用途一直是當做 cache，有訂閱著 redis 的更新消息，但除了 security patch 之外卻沒有額外關注，最近查指令時發現 redis 官網有不少異動，其中一個就是 RedisJSON 的支援，過去剛使用 redis 時，json (這類額外的擴充) 都是由 RedisLabs 提供，所以我個人一直不敢直接使用，擔心日後成為孤兒，現在看到官網直接列入，就可以來試試了

1redisjson

基本環境說明

macOS Sonoma 14.5 (Apple M2 Pro)
OrbStack 1.6.3 (17138)
.NET SDK 8.0.101
JetBrains Rider 2024.1.4
NuGet packages
- Redis.OM 0.7.1
- NRedisStack 0.12.0

docker image

redis/redis-stack-server:7.2.0-v11

使用 pass.123 做為 redis password

docker run -d --name redis-stack-server -p 6379:6379 -e REDIS_ARGS="--requirepass pass.123" redis/redis-stack-server:7.2.0-v11

使用方式

Redis.OM
適用於 redis 與 .NET 間的 object mapping，提供以下功能
1. 聲明式 object mapping
2. 聲明式二級索引
3. 查詢 redis 的 fluent api
4. redis 聚合操作的 fluent api
1. 建立 model
  1. 使用 Document attribute 標記 class，並指定 StorageType 為 StorageType.Json
  2. GitHub:redis/redis-om-dotnet 上有提到要定義 index，雖然沒有定義也可以成功新增，但後續查詢時會出現錯誤
  3. 物件的 id 是 unique 也是 redis primary index key 的一部份，Redis.OM 原生支援的 id 類型是 ulid (想多了解 ulid 可以參考之前筆記 .NET 中的 UUID(GUID) 與 ULID)：預設使用 {model 類別名稱}:{ULID} 做為 redis key；model 類別名稱 可以透過 DocumentAttribute 的 Prefixes 來修改 (只能設定為非空字串的值)；ULID 則可以使用 RedisIdField attribute 來指定特定 property 來當作 id
  - 全未指定
    key 為 User:01J3CKPVQDZRRDJDGSM9KQF8Z8 (ULID 僅為範例)
  - 全指定 (指定 prefix 可能造成查詢異常)
    key 為 userprefix:yowko
  - 指定 prefix 為 "" (效果等同未指定 prefix)
    key 為 User:yowko
  - 未指定 index (查詢時會出現錯誤)
2. 新增資料
3. 查詢資料
  - 查詢時 prefix 失效：只能查詢 {model 類別名稱}:* 的內容
    - 有 CreateIndex
    - 無 CreateIndex
4. 完整程式碼
NRedisStack
基於 StackExchange.Redis 建立，可以為 C# 提供對 Redis Stack 指令的支援 (不止於 JSON，也包含 Search、TimeSeries、Bloom Filter、Cuckoo Filter、T-Digest、Count-min Sketch 和 Top-K 都有對應的指令)
1. 新增資料
2. 建立 index 與查詢資料
3. 完整程式碼

心得

其他 RedisJSON module 的使用方式，可以參考 Enable Redis JSON
redis image 的選擇：
- redis：包含 String、Hash、List、Set、Sorted Set、Bitmaps、HyperLogLog、Geospatial Indexes、Streams 的 key-value pair database
- redis-stack-server：redis 加上 RedisJSON、RedisTimeSeries、RedisBloom、RedisGraph
- redis-stack：redis-stack-server + RedisInsight

使用 redis-cli 存取 json

set

語法
```
JSON.SET {key} $ '{json}'
```

範例

JSON.SET yowko $ '{"Username":"yowko","Email":"[email protected]","Rank":99,"Birthday":428256000000}'

3cliset

get
- 語法
```
JSON.GET {key}
```
- 範例
```
JSON.GET yowko
```

其他錯誤：我只遇到一次 Redis.OM 的錯誤，但是我無法重現，所以無法確認原因
兩者比較
我個人覺得如果只是單純的存取 JSON，Redis.OM 比較簡單，但是如果需要較彈性的設定，NRedisStack 會比較適合
- Redis.OM 在 model mapping 上較為方便，index 也不需自行處理，但建不出沒有 prefix 的 key
- NRedisStack 較為彈性，但需要自行處理 index，語法上也需要同時 JSON 跟 Search，除此之外也包含其他 Redis module 的支援
  不確定是不是我誤會，但依照 GitHub:redis/NRedisStack readme 的說明，使用 NRedisStack 時，無法順利查詢資料，後來在 GitHub:examples folder 找到成功範例

完整程式碼請參考 GitHub:yowko/csharp-redis-json

文章目錄

使用 C# 存取 redis JSON

基本環境說明

使用方式

心得

參考資訊