StackExchange.Redis中的Lua脚本支持详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00200/article/details/148488008

StackExchange.Redis中的Lua脚本支持详解

StackExchange.Redis General purpose redis client 项目地址: https://gitcode.com/gh_mirrors/st/StackExchange.Redis

引言

在现代Redis应用中，Lua脚本是一个强大的功能，它允许开发者将多个Redis命令组合成一个原子操作。StackExchange.Redis作为.NET平台下优秀的Redis客户端，提供了完整的Lua脚本支持。本文将深入解析StackExchange.Redis中的Lua脚本功能，帮助开发者更好地利用这一特性。

基础脚本支持

StackExchange.Redis通过一组核心方法提供了基本的Lua脚本支持：

IServer.ScriptLoad(Async) - 加载脚本到Redis服务器
IServer.ScriptExists(Async) - 检查脚本是否存在
IServer.ScriptFlush(Async) - 清除所有脚本
IDatabase.ScriptEvaluate/IDatabaseAsync.ScriptEvaluateAsync - 执行脚本

这些方法对应Redis原生的EVAL、SCRIPT LOAD等命令，为开发者提供了直接操作脚本的能力。

LuaScript类：更优雅的脚本处理

为了简化脚本参数传递和提高代码可读性，StackExchange.Redis提供了LuaScript类。这个类的主要优势在于：

参数化脚本：使用@变量名的形式在脚本中声明参数
自动类型转换：将.NET对象属性自动映射到脚本参数
RedisKey自动处理：识别RedisKey类型参数并正确处理

基本用法示例

const string Script = "redis.call('set', @key, @value)";

using (var conn = ConnectionMultiplexer.Connect("localhost"))
{
    var db = conn.GetDatabase();
    
    // 准备脚本
    var prepared = LuaScript.Prepare(Script);
    
    // 执行脚本，传递参数
    db.ScriptEvaluate(prepared, new { 
        key = (RedisKey)"mykey", 
        value = 123 
    });
}

在这个例子中，@key和@value会被自动转换为Redis脚本所需的ARGV数组元素，而RedisKey类型的参数会被正确处理为KEYS集合的一部分。

支持的参数类型

StackExchange.Redis支持以下类型的参数映射到Lua脚本：

整型：int, int?, long, long?
浮点型：double, double?
字符串：string
字节数组：byte[]
布尔型：bool, bool?
Redis专用类型：RedisKey, RedisValue

脚本缓存机制

StackExchange.Redis内部实现了智能的脚本缓存机制：

首次执行脚本时，会使用EVAL命令完整传输脚本
后续执行相同脚本时，会自动使用EVALSHA命令只传递脚本哈希值
如果EVALSHA失败（如脚本不存在），会自动回退到EVAL

这种机制既减少了网络传输，又保证了可靠性。

LoadedLuaScript：更精细的控制

对于需要更精细控制脚本加载的场景，可以将LuaScript转换为LoadedLuaScript：

const string Script = "redis.call('set', @key, @value)";

using (var conn = ConnectionMultiplexer.Connect("localhost"))
{
    var db = conn.GetDatabase();
    var server = conn.GetServer("localhost:6379");
    
    var prepared = LuaScript.Prepare(Script);
    var loaded = prepared.Load(server);  // 显式加载脚本
    
    // 使用EVALSHA执行
    loaded.Evaluate(db, new { 
        key = (RedisKey)"mykey", 
        value = 123 
    });
}

LoadedLuaScript的特点：