Redis Lua腳本中學教程（上）

時間 2019-11-30

標籤 redis lua 腳本中學教程欄目 Redis 简体版

原文原文鏈接

失蹤人口回來啦！git

有讀者問我爲何這麼久都沒有出Redis Lua中學教程，表示村頭廁所已經很久沒有紙了。其實我早就要寫這篇中學教程了，奈何最近太忙了，就一拖再拖，直到今天我終於又開始動筆了。忘記Lua相關概念的同窗能夠先回顧一下小學教程。github

中學教程主要分爲兩部分：Redis Lua的相關命令詳解和Lua的語法介紹。redis

前面咱們簡單介紹了EVAL和EVALSHA命令。可是隻有那點只是是沒辦法從中學畢業的，所以咱們須要進行更深刻的學習。json

EVAL

最先可用版本：2.6.0數組

用法：EVAL script numkeys key [key ...] arg [arg ...]緩存

關於用法咱們已經演示過了，其中第一個參數是要執行的Lua腳本，第二個參數是傳入腳本的參數個數。後面則是參數的key數組和value數組。bash

在Lua中執行Redis命令的方法咱們也介紹過，就是使用redis.call()和redis.pcall()兩個函數。它們之間惟一的不一樣就是當Redis命令執行錯誤時，redis.call()會拋出這個錯誤，使EVAL命令拋出錯誤，而redis.pcall()會捕獲這個錯誤，並返回Lua的錯誤表。服務器

一般咱們約定執行命令的key都須要由參數傳入，命令必須在執行以前進行分析，以肯定它做用於哪一個key。這樣作的目的是爲了在必定程度上保證EVAL執行的Lua腳本的正確性。dom

Lua和Redis之間數據類型的轉換

在Redis執行EVAL命令時，若是腳本中有call()或者pcall()命令，就會涉及到Redis和Lua之間數據類型轉換的問題。轉換規則要求，一個Redis的返回值轉換成Lua數據類型後，再轉換成Redis數據類型，其結果必須和初始值相同。因此每種類型是一一對應的。轉換規則以下：異步

Redis與Lua互相轉換

Redis	Lua
integer	number
bulk	string
multi bulk	table
status	table with a single `ok` field
error	table with a single `err` field
Nil bulk &Nil multi bulk	false boolean type

除此以外，Lua到Redis的轉換還有一些其餘的規則：

Lua boolean true -> Redis integer reply with value of 1
Lua只有一種數字類型，不會區分整數和浮點數。而數字類型只能轉換成Redis的integer類型，若是要返回浮點數，那麼在Lua中就須要返回一個字符串。
Lua數組在轉換成Redis類型時，遇到nil就中止轉換

來個栗子驗證一下：

EVAL "return {1,2,3.3333,'foo',nil,'bar'}" 0
1) (integer) 1
2) (integer) 2
3) (integer) 3
4) "foo"
複製代碼

能夠看到bar沒有返回，而且3.333返回了3。

腳本的原子性

Redis運行全部的Lua命令都使用相同的Lua解釋器。當一個腳本正在執行時，其餘的腳本或Redis命令都不能執行。這很像Redis的事務multi/exec。這意味着咱們要儘可能避免腳本的執行時間過長。

腳本總體複製

當腳本進行傳播或者寫入AOF文件時，Redis一般會將腳本自己進行傳播或寫入AOF，而不是使用它產生的若干命令。緣由很簡單，傳播整個腳本要比傳播一大堆生成的命令的速度要快。

從Redis3.2開始，能夠只複製影響腳本執行結果的語句，而不用複製整個腳本。這個複製整個腳本的方法有如下屬性：

若是輸入相同，腳本必須輸出相同的結果。即執行結果不能依賴於隱式的變量，或依賴於I/O輸入
Lua不會導出訪問系統時間或其餘外部狀態的命令
若是先執行了「隨機命令」（如RANDOMKEY，SRANDMEMBER，TIME），並改變了數據集，接着執行腳本時會被阻塞。
在Redis4中，Lua腳本調用返回隨機順序的元素的命令時，會在返回以前進行排序，也就是說，調用redis.call("smembers",KEYS[1])，每次返回的順序都相同。從Redis5開始就不須要排序了，由於Redis5複製的是產生影響的命令。
Lua修改了僞隨機函數math.random和math.randomseed，使每次執行腳本時seed都相同，而若是不執行math.randomseed，只執行math.random時，每次的結果也都相同。

複製命令隊列

在這種模式下，Redis在執行腳本時會收集全部影響數據集的命令，當腳本執行完畢時，命令隊列會被放在事務中，發送給AOF文件。

Lua能夠經過執行redis.replicate_commands()函數來檢查複製模式，若是返回true表示當前是複製命令模式，若是返回false，則是複製整個腳本模式。

可選擇的複製命令

腳本複製模式選擇好之後，就能夠對複製到副本和AOF的方式進行更多的控制。這是一種高級特性，由於濫用會切斷主從備份，和AOF持久化。若是咱們只須要在master上執行某些命令時，這一特性就變得頗有用。例如咱們須要計算一些中間值時，只須要在master上計算就好，那麼這些命令就沒必要進行復制。

從Redis3.2開始，有一個新的命令叫作redis.set_repl()，它能夠用來控制複製方式，有以下選項（默認是REPL_ALL）：

redis.set_repl(redis.REPL_ALL) -- Replicate to AOF and replicas.
redis.set_repl(redis.REPL_AOF) -- Replicate only to AOF.
redis.set_repl(redis.REPL_REPLICA) -- Replicate only to replicas (Redis >= 5)
redis.set_repl(redis.REPL_SLAVE) -- Used for backward compatibility, the same as REPL_REPLICA.
redis.set_repl(redis.REPL_NONE) -- Don't replicate at all. 複製代碼

全局變量

爲了不數據泄露，Redis腳本不容許建立全局變量。若是必須有一個公共變量，可使用Redis的key來代替。在EVAL命令中建立一個全局變量會引發一個異常。

> eval 'a=10' 0
(error) ERR Error running script (call to f_933044db579a2f8fd45d8065f04a8d0249383e57): user_script:1: Script attempted to create global variable 'a 複製代碼

關於SELECT的使用

在Lua腳本中使用SELECT就像在正常客戶端中使用同樣。值得一提的是，在Redis2.8.12以前，Lua腳本中執行SELECT是會影響到客戶端的，而從2.8.12開始，Lua腳本中的SELECT只會在腳本執行過程當中生效。這點在Redis版本升級時須要注意，由於升級先後，命令的語義會改變。

可用的庫

Lua腳本中有許多庫，但並非都能在Redis中使用，其中可使用的有：

base lib.
table lib.
string lib.
math lib.
struct lib.
cjson lib.
cmsgpack lib.
bitop lib.
redis.sha1hex function.
redis.breakpoint and redis.debug function in the context of the Redis Lua debugger.