Redis 使用 Lua 腳本進行原子操作

Intro

之前寫過一篇文章也是 Redis 使用 LUA 腳本實現分布式的 CAS 操作，可以參考：基于 Redis 實現 CAS 操作

最近使用 Redis 的時候有一個需求，只有值發生變化的時候才更新，如果要更新的值和現在的值是一樣的就不用更新，有點類似于 SET NX，只是 SET NX 只有值不存在的時候才會 SET，我的需求則是要檢查要 SET 的值和 Redis 里的值，如果不一樣就 SET，一樣就直接返回

Implement

我實現了針對 String 和 Hash 的 SET 檢查，核心就是我們的 Lua 腳本

實現代碼如下：

對于 Hash 會多一個參數 —— hash field name,?對于 string?則直接是 value 了，就會比 hash?少一個參數

private?const?string?HashSetWhenValueChangedLuaScript?=?@" if?redis.call(""HGET"",?KEYS[1],?ARGV[1])?==?ARGV[2]?thenreturn?0 elseredis.call(""HSET"",?KEYS[1],?ARGV[1],?ARGV[2])return?1 end ";private?const?string?StringSetWhenValueChangedLuaScript?=?@" if?redis.call(""GET"",?KEYS[1])?==?ARGV[1]?thenreturn?0 elseredis.call(""SET"",?KEYS[1],?ARGV[1])return?1 end ";

實現起來也比較簡單，就是先取一下 Redis 中的數據，如果和輸入的值是一樣就返回 0，不一樣則更新值，然后返回 1

StackExchange.Redis 使用 API

在 StackExchange.Redis 中可以使用 ScriptEvaluate/ScriptEvaluateAsync 來執行 Lua 腳本，為了方便使用我把他們封裝成了擴展方法，實現如下：

public?static?bool?StringSetWhenValueChanged(this?IDatabase?db,?RedisKey?key,?RedisValue?value) {return?(int)db.ScriptEvaluate(StringSetWhenValueChangedLuaScript,?new[]?{?key?},?new[]?{?value?})?==?1; }public?static?async?Task<bool>?StringSetWhenValueChangedAsync(this?IDatabase?db,?RedisKey?key,?RedisValue?value) {return?await?db.ScriptEvaluateAsync(StringSetWhenValueChangedLuaScript,?new[]?{?key?},?new[]?{?value?}).ContinueWith(r?=>?(int)r.Result?==?1); }public?static?bool?HashSetWhenValueChanged(this?IDatabase?db,?RedisKey?key,?RedisValue?field,?RedisValue?value) {return?(int)db.ScriptEvaluate(HashSetWhenValueChangedLuaScript,?new[]?{?key?},?new[]?{?field,?value?})?==?1; }public?static?async?Task<bool>?HashSetWhenValueChangedAsync(this?IDatabase?db,?RedisKey?key,?RedisValue?field,?RedisValue?value) {return?await?db.ScriptEvaluateAsync(HashSetWhenValueChangedLuaScript,?new[]?{?key?},?new[]?{?field,?value?}).ContinueWith(r?=>?(int)r.Result?==?1); }

Sample

使用示例可以參考下面的測試用例：

[Fact] public?void?StringSetWhenValueChangedTest() {var?key?=?$"{nameof(StringSetWhenValueChangedTest)}";var?redis?=?DependencyResolver.Current.GetRequiredService<IConnectionMultiplexer>().GetDatabase();redis.StringSet(key,?1);//?update?to?1?if?now?is?not?1Assert.False(redis.StringSetWhenValueChanged(key,?1));Assert.Equal(1,?redis.StringGet(key));//?update?to?2?if?now?is?not?2Assert.True(redis.StringSetWhenValueChanged(key,?2));Assert.Equal(2,?redis.StringGet(key)); }[Fact] public?void?HashSetWhenValueChangedTest() {var?key?=?$"{nameof(HashSetWhenValueChangedTest)}";var?field?=?"testField";var?redis?=?DependencyResolver.Current.GetRequiredService<IConnectionMultiplexer>().GetDatabase();redis.HashSet(key,?field,?1);Assert.False(redis.HashSetWhenValueChanged(key,?field,?1));Assert.Equal(1,?redis.HashGet(key,?field));Assert.True(redis.HashSetWhenValueChanged(key,?field,?2));Assert.Equal(2,?redis.HashGet(key,?field)); }

More

在使用 Lua 腳本的時候，如果要使用不等于的邏輯需要小心一些，和其他語言不同，需要使用 ~= 而非 != 來表示不等

References

• https://github.com/WeihanLi/WeihanLi.Redis/blob/dev/src/WeihanLi.Redis/RedisExtensions.cs

• https://github.com/WeihanLi/WeihanLi.Redis/blob/dev/test/WeihanLi.Redis.UnitTest/RedisExtensionsTest.cs

• 基于 Redis 實現 CAS 操作
  

總結

以上是生活随笔為你收集整理的Redis 使用 Lua 脚本进行原子操作的全部內容，希望文章能夠幫你解決所遇到的問題。

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