StackExchange.Redis 命令擴展

Intro

在之前的文章中有簡單介紹過 StackExchange.Redis 直接調用 Redis 命令來實現調用 Stream 的根據消息 Id 來控制消息長度，因為 StackExchange.Redis 目前還不支持根據消息 Id 控制 Stream 消息長度，目前有很多 6.2 以后帶來的新特性大多還不支持。

前段時間，給 StackExchange.Redis 提了一個 PR 支持了一個 Redis 6.2 的新命令 GETDEL，給大家分享一下，有想去蹭貢獻的也可以嘗試貢獻一下

GETDEL

GETDEL 是 Redis 6.2 中引入的新功能中的其中一個，是針對 String 類型的數據的命令，如同命令名稱一樣，先 GET 并刪除某一個 key，返回 key 的內容，如下面示例一樣

redis> SET mykey "Hello"

"OK"

redis> GETDEL mykey

"Hello"

redis> GET mykey

(nil)

Implement

命令比較簡單，不會造成產生破壞性的變更，實現起來也是比較簡單，主要是新增下面兩個 API：

RedisValue?StringGetDelete(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None); Task<RedisValue>?StringGetDeleteAsync(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None);

分別定義在 IDatabase/IDatabaseAsync中

對于其實現來說，會增加一個 Redis 命令的枚舉定義，需要在 RedisCommand 中增加一個新命令 GETDEL

enum?RedisCommand: +??GETDEL,

實現需要修改的地方有三個：

RedisDatabase，新增的 API 實現如下

public?RedisValue?StringGetDelete(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None) {var?msg?=?Message.Create(Database,?flags,?RedisCommand.GETDEL,?key);return?ExecuteSync(msg,?ResultProcessor.RedisValue); }public?Task<RedisValue>?StringGetDeleteAsync(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None) {var?msg?=?Message.Create(Database,?flags,?RedisCommand.GETDEL,?key);return?ExecuteAsync(msg,?ResultProcessor.RedisValue); }

DatabaseWrapper:

public?RedisValue?StringGetDelete(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None) {return?Inner.StringGetDelete(ToInner(key),?flags); }

WrapperBase:

public?Task<RedisValue>?StringGetDeleteAsync(RedisKey?key,?CommandFlags?flags?=?CommandFlags.None) {return?Inner.StringGetDeleteAsync(ToInner(key),?flags); }

單元測試的變更如下：

tests/StackExchange.Redis.Tests/DatabaseWrapperTests.cs:

[Fact] public?void?StringGetDelete() {wrapper.StringGetDelete("key",?CommandFlags.None);mock.Verify(_?=>?_.StringGetDelete("prefix:key",?CommandFlags.None)); }

tests/StackExchange.Redis.Tests/WrapperBaseTests.cs:

[Fact] public?void?StringGetDeleteAsync() {wrapper.StringGetDeleteAsync("key",?CommandFlags.None);mock.Verify(_?=>?_.StringGetDeleteAsync("prefix:key",?CommandFlags.None)); }

tests/StackExchange.Redis.Tests/Strings.cs: 實際使用也可以參數這兩個測試用例

[Fact] public?void?GetDelete() {using?(var?muxer?=?Create()){Skip.IfMissingFeature(muxer,?nameof(RedisFeatures.GetDelete),?r?=>?r.GetDelete);var?conn?=?muxer.GetDatabase();var?prefix?=?Me();conn.KeyDelete(prefix?+?"1",?CommandFlags.FireAndForget);conn.KeyDelete(prefix?+?"2",?CommandFlags.FireAndForget);conn.StringSet(prefix?+?"1",?"abc",?flags:?CommandFlags.FireAndForget);Assert.True(conn.KeyExists(prefix?+?"1"));Assert.False(conn.KeyExists(prefix?+?"2"));var?s0?=?conn.StringGetDelete(prefix?+?"1");var?s2?=?conn.StringGetDelete(prefix?+?"2");Assert.False(conn.KeyExists(prefix?+?"1"));Assert.Equal("abc",?s0);Assert.Equal(RedisValue.Null,?s2);} }[Fact] public?async?Task?GetDeleteAsync() {using?(var?muxer?=?Create()){Skip.IfMissingFeature(muxer,?nameof(RedisFeatures.GetDelete),?r?=>?r.GetDelete);var?conn?=?muxer.GetDatabase();var?prefix?=?Me();conn.KeyDelete(prefix?+?"1",?CommandFlags.FireAndForget);conn.KeyDelete(prefix?+?"2",?CommandFlags.FireAndForget);conn.StringSet(prefix?+?"1",?"abc",?flags:?CommandFlags.FireAndForget);Assert.True(conn.KeyExists(prefix?+?"1"));Assert.False(conn.KeyExists(prefix?+?"2"));var?s0?=?conn.StringGetDeleteAsync(prefix?+?"1");var?s2?=?conn.StringGetDeleteAsync(prefix?+?"2");Assert.False(conn.KeyExists(prefix?+?"1"));Assert.Equal("abc",?await?s0);Assert.Equal(RedisValue.Null,?await?s2);} }

More

主要的變更就是這些了，是不是看起來也簡單的，除了上面的基本實現就是要增加一些測試用例以及本地進行一下測試，看是不是可以按預期工作，有一些功能可能會要求集成測試

除了上面還有一個小點，就是如果不是只讀命令需要聲明命令是 MasterOnly 的，在 src/StackExchange.Redis/Message.cs 中的 public static bool IsMasterOnly(RedisCommand command) 聲明即可，除此之外，StackExchange.Redis 會建議增加 ReleaseNote

如果你愿意也可以嘗試去貢獻一下 https://github.com/StackExchange/StackExchange.Redis/issues

References

• https://github.com/StackExchange/StackExchange.Redis/pull/1840

• https://github.com/StackExchange/StackExchange.Redis/issues/1729

• https://redis.io/commands/getdel

• https://github.com/StackExchange/StackExchange.Redis/issues

總結

以上是生活随笔為你收集整理的StackExchange.Redis 命令扩展的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。