使用Lua编写redis脚本

redis从2.6版本开始内置支持Lua解释器,解释器提供了3个函数来处理redis的命令 redis.call() redis.pcall() 和 redis.log()

为什么使用redis执行Lua脚本

redis执行命令是单线程执行,6.x支持多线程,redis的多线程部分只是用来处理网络数据的读写和协议解析,执行命令仍然是单线程顺序执行。

redis保证脚本会以原子性的方式执行。这是一个很重要的因素。

因为reids的单线程执行特性,lua脚本可以作为一个单元被redis执行,这个执行的过程不会被其他客户端的其他命令打断,简单来说lua脚本对于redis来讲具有原子性。在实际开发过程中,往往借助lua脚本原子性的特点,实现无锁化的线程安全。

示例:

<?php

$luaScript = <<<LUA
-- 50行lua代码逻辑
local a = 3;

redis.call('set', 'name', 3)

return a

LUA;

// 上面的50行lua代码放到redis中,相当于一条原子命令执行,实现了无锁化保障高并发下线程(进程)数据安全

$result = (new predis())->eval($luaScript);

?>
命令及系统方法详解
  1. EVAL 命令
    EVAL script numkeys key [key …] arg [arg …]
  • script lua脚本内容 注意的是脚本不应该是Lua函数。
  • numkeys 表示指定键名参数的个数(key的个数)。
  • key [key ...] 表示脚本对应的key值列表 在脚本中可以使用KEYS[1] KEYS[2] KEYS[3]KEYS[n] n从1开始 。
  • arg [arg ...] 命名行中传递的参数列表 在脚本中可以使用ARGV[1] ARGV[2] ARGV[3]ARGV[n] n从1开始。

传入的key,v值并不是k,v对应,而是所有的key放到了名为KEYS的table中,所有的v放入到了名为ARGV的table中,EVAL命令只对key的数量做了限制(numkeys)

示例

numkeys=2时,key1,key2为传入的两个key,first,second为传入的两个v
127.0.0.1:6>eval "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}" 2 key1 key2 first second
 1)  "key1"
 2)  "key2"
 3)  "first"
 4)  "second"
numkeys=1时,key1为传入的一个key,key2,first,second为传入的三个v
127.0.0.1:6>eval "return {KEYS[1],ARGV[1],ARGV[2],ARGV[3]}" 1 key1 key2 first second
 1)  "key1"
 2)  "key2"
 3)  "first"
 4)  "second"
获取KEYS、ARGV两个系统table的元素个数
127.0.0.1:6>eval "return {#KEYS,#ARGV}" 1 key1 key2 first second
 1)  "1"
 2)  "3"

redis-cli 运行lua 脚本
redis-cli -h host -p port -a password -n db --eval demo.lua k1,k2,a1,a2
连接远程redis 并运行当前文件夹下的test.lua脚本。其中,-n 后接的参数为选择的redis的第几个数据库。 后面"k1,k2,a1,a2"的在lua脚本中获取的方式是使用全局变量 KEYS 和 ARGV。
如果连接本地的redis运行脚本则可省略几个参数。
redis-cli -n db --eval demo.lua k1,k2,a1,a2

BucketT.lua

local key = KEYS[1]
local intervalPerTokens = tonumber(ARGV[1])
local curTime = tonumber(ARGV[2])
local initTokens = tonumber(ARGV[3])

return {key,intervalPerTokens,curTime,initTokens}

执行:
redis-cli.exe -n 13 --eval BucketT.lua k1,k2,a1,a2
  1. EVALSHA 命令

2.1 EVALSHA sha1 numkeys key [key …] arg [arg …]
此命令和EVAL的区别是EVAL每次都需要传入脚本的主体内容,对网络带宽不是很友好,而EVALSHA命令正好可以解决这个问题

  • sha1 缓存中的sha值 这个值可以利用SCRIPT LOAD生成。
  • numkeys 表示指定键名参数的个数。
  • key [key ...] 表示脚本对应的key值列表 在脚本中可以使用KEYS[1] KEYS[2] KEYS[3]KEYS[n] n从1开始。
  • arg [arg ...] 命名行中传递的参数列表 在脚本中可以使用ARGV[1] ARGV[2] ARGV[3]ARGV[n] n从1开始。
    示例
// 首先利用SCRIPT LOAD把脚本的主体缓存在redis中,会返回一个sha的key
127.0.0.1:6>SCRIPT LOAD "return {KEYS[1],KEYS[2],ARGV[1],ARGV[2]}"
"a42059b356c875f0717db19a51f6aaca9ae659ea"
// EVALSHA执行命令把sha带上,其他的和eval没有区别
127.0.0.1:6>EVALSHA a42059b356c875f0717db19a51f6aaca9ae659ea 2 id name 2 mytest
 1)  "id"
 2)  "name"
 3)  "2"
 4)  "mytest"

2.2 解释一下SCRIPT相关的命令
redis保证了所有运行过的脚本都能缓存起来,上面也提到过使用SCRIPT LOAD也能将脚本缓存并返回sha值,那么也能使用SCRIPT FLUSH清空脚本缓存

  • SCRIPT LOAD 加载脚本到缓存中,返回sha值
  • SCRIPT FLUSH 清除所有 Lua 脚本缓存
  • SCRIPT EXISTS 判断sha值是否已经缓存好了,返回值为0和1,后者表示存在于缓存中,在程序开发中非常有用,比如 redis出现了什么异常情况后,脚本缓存被清空了,或者被人为执行了SCRIPT FLUSH命令,这个时候就可以优先尝试一下SCRIPT EXISTS命令如果返回0表示不存在,就需要先执行SCRIPT LOAD先把脚本加载到缓存中之后再执行
  • SCRIPT KILL 杀死当前正在运行的Lua脚本,当且仅当这个脚本没有执行过任何写操作时,这个命令才生效,执行成功返回OK,其他情况返回错误信息
  1. redis.call(),redis.pcall()函数
    区别就是处理错误异常的情况不同,其他的功能一样
  • redis.call() 执行命令的过程中发生错误时,脚本会停止执行,并返回一个脚本错误
  • redis.pcall() 执行命令的过程中发生错误时,脚本会继续执行,但是会记录错误信息返回一个带err域的Lua表(table)
  1. redis.log(loglevel, message) 函数
    触发redis记录日志,日志级别有redis.LOG_DEBUG redis.LOG_VERBOSE redis.LOG_NOTICE redis.LOG_WARNING
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,616评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,020评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,078评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,040评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,154评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,265评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,298评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,072评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,491评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,795评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,970评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,654评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,272评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,985评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,815评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,852评论 2 351

推荐阅读更多精彩内容