Redis的Lua脚本总结

Redis的Lua脚本总结

在redis操作中有时我们需要多条命令在执行时保证原子性，例如：使用redis做分布式锁时的加锁(判断key是否存在，不存在就set)和解锁(判断key是否存在并等于指定值，符合条件就del)中的查询key和set/del就是两条命令，只是单纯的调用redisTimplate的对应方法，会出现ABA问题，不能保证原性。此时使用Lua脚本就比较合适。

//先判断kye是否等于某个值，一般是加锁的客户id，符合就删除key来解锁，不符合就返回0表示删除key失败。可以使用StringBuilder拼接，提高代码的优雅性。
String str = "if(redis.call(\"get\",KEYS[1])==ARGV[1]) " +
        "then " +
        "   return redis.call(\"del\",key[1]) " +
        "else " +
        "   return 0 " +
        "end";

redisTimplate.execute((con)->{return con.eval(str.getByte(),ReturnType.BOOLEAN,1,new byte[][]{key.getByte(StandardCharsets.UTF_8),value.getByte(StandardCharsets.UTF_8)});});

Redis脚本使用

redis中使用Lua脚本的方法有两种：EVAL和EVALSHA

EVAL命令

语法

redis 127.0.0.1:6379> EVAL script numkeys key [key ...] arg [arg ...] 

参数

• script： 参数是一段 Lua 5.1 脚本程序。脚本不必(也不应该)定义为一个 Lua 函数。
• numkeys： 用于指定键名参数的个数。
• key [key …]： 从 EVAL 的第三个参数开始算起，表示在脚本中所用到的那些 Redis 键(key)，这些键名参数可以在 Lua 中通过全局变量 KEYS 数组，用 1 为基址的形式访问( KEYS[1] ， KEYS[2] ，以此类推)。
• arg [arg …]： 附加参数，在 Lua 中通过全局变量 ARGV 数组访问，访问的形式和 KEYS 变量类似( ARGV[1] 、 ARGV[2] ，诸如此类)。

实例

redis 127.0.0.1:6379> eval "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 key1 key2 first second
1) "key1"
2) "key2"
3) "first"
4) "second"

EVALSHA命令

Redis Evalsha 命令根据给定的 sha1 校验码，执行缓存在服务器中的脚本。

将脚本缓存到服务器的操作可以通过 SCRIPT LOAD 命令进行。

这个命令的其他地方，比如参数的传入方式，都和 EVAL 命令一样。

语法

redis 127.0.0.1:6379> EVALSHA sha1 numkeys key [key ...] arg [arg ...] 

参数

• sha1 ： 通过 SCRIPT LOAD 生成的 sha1 校验码。
• numkeys： 用于指定键名参数的个数。
• key [key …]： 从 EVAL 的第三个参数开始算起，表示在脚本中所用到的那些 Redis 键(key)，这些键名参数可以在 Lua 中通过全局变量 KEYS 数组，用 1 为基址的形式访问( KEYS[1] ， KEYS[2] ，以此类推)。
• arg [arg …]： 附加参数，在 Lua 中通过全局变量 ARGV 数组访问，访问的形式和 KEYS 变量类似( ARGV[1] 、 ARGV[2] ，诸如此类)。

实例

redis 127.0.0.1:6379> SCRIPT LOAD "return 'hello moto'"
"232fd51614574cf0867b83d384a5e898cfd24e5a"

redis 127.0.0.1:6379> EVALSHA "232fd51614574cf0867b83d384a5e898cfd24e5a" 0
"hello moto"

使用区别

EVAL 命令要求你在每次执行脚本的时候都发送一次脚本主体(script body)。Redis 有一个内部的缓存机制，因此它不会每次都重新编译脚本，不过在很多场合，付出无谓的带宽来传送脚本主体并不是最佳选择。

为了减少带宽的消耗， Redis 实现了 EVALSHA命令，它的作用和 EVAL 一样，都用于对脚本求值，但它接受的第一个参数不是脚本，而是脚本的 SHA1 校验和(sum)。

redis脚本定义

参考官方文档：http://www.redis.cn/commands/eval.html

Lua脚本语法：https://www.runoob.com/lua/lua-environment.html

常用方法

redis.call和redis.pcall

redis.call() 和 redis.pcall() 两个函数的参数可以是任意的 Redis 命令

redis.call() 在执行命令的过程中发生错误时，脚本会停止执行，并返回一个脚本错误，错误的输出信息会说明错误造成的原因。

redis.pcall() 出错时并不引发(raise)错误，而是返回一个带 err 域的 Lua 表(table)，用于表示错误。

> eval "return redis.call('set','foo','bar')" 0
OK

> eval "return redis.call('set',KEYS[1],'bar')" 1 foo
OK

注意：以上两种写法的作用一样，但是建议使用第二种写法：脚本里使用的所有键都应该由 KEYS 数组来传递。

要求使用正确的形式来传递键(key)是有原因的，因为不仅仅是 EVAL 这个命令，所有的 Redis 命令，在执行之前都会被分析，籍此来确定命令会对哪些键进行操作。

因此，对于 EVAL 命令来说，必须使用正确的形式来传递键，才能确保分析工作正确地执行。 除此之外，使用正确的形式来传递键还有很多其他好处，它的一个特别重要的用途就是确保 Redis 集群可以将你的请求发送到正确的集群节点。 (对 Redis 集群的工作还在进行当中，但是脚本功能被设计成可以与集群功能保持兼容。)不过，这条规矩并不是强制性的， 从而使得用户有机会滥用(abuse) Redis 单实例配置(single instance configuration)，代价是这样写出的脚本不能被 Redis 集群所兼容。