使用 lua 脚本操作redis list数据结构，获取指定数量的数据并且删除

edis lua 脚本相关文档

http://redis.cn/commands/eval.html

https://www.runoob.com/lua/lua-tutorial.html

我个人认为学习lua脚本的编写，倒不需要全部将lua语法等熟记于心，掌握常用的命令函数，比如if、for循环等，其他的都到需要用到的时候再查阅文档算是一个很好的办法。

下边我们来编写一个很简单的操作redis的小脚本，这个脚本向redis循环写入一组数据，结构定义为list类型。

add.lua

-- 表示注释
-- KEYS[1] 表示接收传入的第一个key参数
-- 先清空原有的数据集合
redis.call('del', KEYS[1])
-- for循环插入数据
-- i=1表示从1开始，20表示截止，1表示递增值
for i=1, 20, 1 do
    -- 使用lpush向redis写入
    redis.call('lpush', KEYS[1], i)
end
return "success" -- 返回成功

现在执行这个lua脚本

# -h 表示redis地址，-a 表示redis密码，list 表示redis的key值
redis-cli -a 密码 --eval /Users/sun/Documents/add.lua list

执行完成后，看下redis可视化界面里的数据

现在我们已经成功的使用lua脚本插入了数据，我们再写一个lua脚本从redis中获取一组数据，并且把返回的数据删除掉。

get.lua

if redis.call('llen',KEYS[1]) > tonumber(ARGV[1]) then 
    local result_data = redis.call('lrange',KEYS[1], redis.call('llen',KEYS[1])-ARGV[1],'-1')
    redis.call('ltrim',KEYS[1], '0', redis.call('llen',KEYS[1])-ARGV[1]-1)
    return result_data 
else 
    local result_data = redis.call('lrange', KEYS[1], 0,-1)
    redis.call('del',KEYS[1])
    return result_data
end

执行测试

# list 是key, 2 是获取数量。 这两个参数之间有个逗号，并且逗号两边必须是空格，否则报错。
redis-cli -a 密码 --eval /Users/sun/Documents/get.lua list , 2

可以看到这个lua脚本是没有问题的。

现在我们来简写一下这个lua脚本

getNew.lua

if redis.call('llen', KEYS[1]) > tonumber(ARGV[1]) then
    local resultData = redis.call('rpop', KEYS[1], ARGV[1])
    return resultData
else
    local resultData = redis.call('lpop', KEYS[1], redis.call('llen', KEYS[1]))
    return resultData
end

执行测试

redis-cli -a 密码 --eval /Users/sun/Documents/getNew.lua list , 2

获取超出数量的情况来测试一下，目前list中剩余16个元素，我们获取30个

redis-cli -a 密码 --eval /Users/sun/Documents/getNew.lua list , 30

lua脚本其实并不难，理解几个简单的语法就可以了。现在我们来分析一下网络上的redis并发锁的实现方式。

String script = "if redis.call('get', KEYS[1]) == ARGV[1] then return redis.call('del', KEYS[1]) else return 0 end";
jedis.eval(script, Collections.singletonList(lockKey), Collections.singletonList(lockVal));

if redis.call('get', KEYS[1]) == ARGV[1] then 
    return redis.call('del', KEYS[1]) 
else 
    return 0 
end

上边的意思就是：根据redisKey获取到的value值如果能对的上，或者说redis中存在，则删除该redis元素，成功的话，返回删除的数量，返回结果大于0，否则返回0。