Redis使用lua指令碼

摘要： 版本：自2.6.0起可用。 時間複雜度：取決於執行的指令碼。 使用Luam指令碼的好處： 減少網路開銷。可以將多個請求通過指令碼的形式一次傳送，減少網路時延。 原子操作。redis會將整個指令碼作為一個整體執行，中間不會被其他命令插入。因此在編寫指令...

版本：自2.6.0起可用。

時間複雜度：取決於執行的指令碼。

使用Luam指令碼的好處：

• 減少網路開銷。可以將多個請求通過指令碼的形式一次傳送，減少網路時延。
• 原子操作。redis會將整個指令碼作為一個整體執行，中間不會被其他命令插入。因此在編寫指令碼的過程中無需擔心會出現競態條件，無需使用事務。
• 複用。客戶端傳送的腳步會永久存在redis中，這樣，其他客戶端可以複用這一指令碼而不需要使用程式碼完成相同的邏輯。

如何使用

基本使用

命令格式：

EVAL script numkeys key [key ...] arg [arg ...]

說明：

• script 是第一個引數，為Lua 5.1指令碼。該指令碼不需要定義Lua函式（也不應該）。
• 第二個引數numkeys 指定後續引數有幾個key。
• key [key ...] ，是要操作的鍵，可以指定多個，在lua指令碼中通過KEYS[1] ,KEYS[2] 獲取
• arg [arg ...] ，引數，在lua指令碼中通過ARGV[1] ,ARGV[2] 獲取。

簡單例項：

127.0.0.1:6379> eval "return ARGV[1]" 0 100 
"100"
127.0.0.1:6379> eval "return {ARGV[1],ARGV[2]}" 0 100 101
1) "100"
2) "101"
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"

127.0.0.1:6379> eval "redis.call('SET', KEYS[1], ARGV[1]);redis.call('EXPIRE', KEYS[1], ARGV[2]); return 1;" 1 test 10 60
(integer) 1
127.0.0.1:6379> ttl test
(integer) 59
127.0.0.1:6379> get test
"10"

注：

• {} 在lua裡是指資料型別table ，類似陣列。
• redis.call() 可以呼叫redis命令。

命令列裡使用

如果直接使用redis-cli 命令，格式會有點不一樣：

redis-cli --eval lua_file key1 key2 , arg1 arg2 arg3

注意的地方：

• eval 後面引數是lua指令碼檔案,.lua 字尾
• 不用寫numkeys ，而是使用, 隔開。注意, 前後有空格。

示例：

incrbymul.lua

local num = redis.call('GET', KEYS[1]);

if not num then
return 0;
else
local res = num * ARGV[1]; 
redis.call('SET',KEYS[1], res); 
return res;
end

命令列執行：

$ redis-cli --eval incrbymul.lua lua:incrbymul , 8
(integer) 0
$ redis-cli incr lua:incrbymul 
(integer) 1
$ redis-cli --eval incrbymul.lua lua:incrbymul , 8
(integer) 8
$ redis-cli --eval incrbymul.lua lua:incrbymul , 8
(integer) 64
$ redis-cli --eval incrbymul.lua lua:incrbymul , 2
(integer) 128

由於redis沒有提供命令可以實現將一個數原子性的乘以N倍，這裡我們就用Lua指令碼實現了，執行過程中確保不會被其它客戶端打斷。

phpredis裡使用

接著上面的例子：

incrbymul.php

<?php 

$lua = <<<EOF
local num = redis.call('GET', KEYS[1]);

if not num then
return 0;
else
local res = num * ARGV[1]; 
redis.call('SET',KEYS[1], res); 
return res;
end

EOF;

$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
$ret = $redis->eval($lua, array("lua:incrbymul", 2), 1);
echo $ret;

執行：

$ redis-cli set lua:incrbymul 0
OK
$ redis-cli incr lua:incrbymul
(integer) 1
$ php incrbymul.php 
2
$ php incrbymul.php 
4

eval原型：

Redis::eval(string script, [array keys, long num_keys])

eval函式的第3個引數為KEYS個數，phpredis依據此值將KEYS和ARGV做區分。

參考