注意事項

數據管理服務DMS控制臺目前暫不支持使用Lua腳本等相關命令，請通過客戶端或Redis-cli連接Redis實例使用Lua腳本。

基本語法

更多關于Redis命令的介紹，請參見Redis官網。

優化內存、網絡開銷

現象：

EVAL "return redis.call('set', 'k1', 'v1')" 0
EVAL "return redis.call('set', 'k2', 'v2')" 0

清理Lua腳本的內存占用

現象：

-OOM command not allowed when used memory > 'maxmemory'.

解決方案：

同時，請避免編寫過大的Lua腳本，防止占用過多的內存；避免在Lua腳本中大批量寫入數據，否則會導致內存使用急劇升高，甚至造成實例OOM。在業務允許的情況下，建議開啟數據逐出（Tair默認開啟，模式為volatile-lru）節省內存空間。但無論是否開啟數據逐出，Tair均不會逐出Lua腳本緩存。

處理NOSCRIPT錯誤

現象：

(error) NOSCRIPT No matching script. Please use EVAL.

解決方案：

請通過EVAL命令或SCRIPT LOAD命令將目標腳本緩存至Redis中后進行重試。但由于Redis不保證Lua腳本的持久化、復制能力，Redis在部分場景下仍會清除Lua腳本緩存（例如實例遷移、變配等），這要求您的客戶端需具備處理該錯誤的能力，詳情請參見腳本緩存、持久化與復制。

import redis
import hashlib

# strin是一個Lua腳本的字符串，函數以字符串的格式返回strin的sha1值。
def calcSha1(strin):
    sha1_obj = hashlib.sha1()
    sha1_obj.update(strin.encode('utf-8'))
    sha1_val = sha1_obj.hexdigest()
    return sha1_val

class MyRedis(redis.Redis):

    def __init__(self, host="localhost", port=6379, password=None, decode_responses=False):
        redis.Redis.__init__(self, host=host, port=port, password=password, decode_responses=decode_responses)

    def prepend_inLua(self, key, value):
        script_content = """\
        local suffix = redis.call("get", KEYS[1])
        local prefix = ARGV[1]
        local new_value = prefix..suffix
        return redis.call("set", KEYS[1], new_value)
        """
        script_sha1 = calcSha1(script_content)
        if self.script_exists(script_sha1)[0] == True:      # 檢查Redis是否已緩存該腳本。
            return self.evalsha(script_sha1, 1, key, value) # 如果已緩存，則用EVALSHA執行腳本
        else:
            return self.eval(script_content, 1, key, value) # 否則用EVAL執行腳本，注意EVAL有將腳本緩存到Redis的作用。這里也可以考慮采用SCRIPT LOAD與EVALSHA的方式。

r = MyRedis(host="r-******.redis.rds.aliyuncs.com", password="***:***", port=6379, decode_responses=True)

print(r.prepend_inLua("k", "v"))
print(r.get("k"))
            

處理Lua腳本超時

• 現象：

  由于Lua腳本在Tair中是原子執行的，Lua慢請求可能會導致Tair阻塞。單個Lua腳本阻塞Tair最多5秒，5秒后Tair會給所有其他命令返回如下BUSY error報錯，直到腳本執行結束。

  BUSY Redis is busy running a script. You can only call SCRIPT KILL or SHUTDOWN NOSAVE.

  解決方案：

  您可以通過SCRIPT KILL命令終止Lua腳本或等待Lua腳本執行結束。

  說明

  • SCRIPT KILL命令在執行慢Lua腳本的前5秒不會生效（Tair阻塞中）。

  • 建議您編寫Lua腳本時預估腳本的執行時間，同時檢查死循環等問題，避免過長時間阻塞Tair導致服務不可用，必要時請拆分Lua腳本。

• 現象：

  若當前Lua腳本已執行寫命令，則SCRIPT KILL命令將無法生效，報錯示例如下。

  (error) UNKILLABLE Sorry the script already executed write commands against the dataset. You can either wait the script termination or kill the server in a hard way using the SHUTDOWN NOSAVE command.

  解決方案：

  請在控制臺的實例列表中單擊對應實例重啟。

腳本緩存、持久化與復制

現象：

在不重啟、不調用SCRIPT FLUSH命令的情況下，Redis會一直緩存執行過的Lua腳本。但在部分情況下（例如實例遷移、變配、版本升級、切換等等），Redis無法保證Lua腳本的持久化，也無法保證Lua腳本能夠被同步至其他節點。

解決方案：

由于Redis不保證Lua腳本的持久化、復制能力，請您在本地存儲所有Lua腳本，在必要時通過EVAL或SCRIPT LOAD命令將Lua腳本重新緩存至Redis中，避免實例重啟、HA切換等操作時Redis中Lua腳本被清空而帶來的NOSCRIPT錯誤。

集群中Lua腳本的限制

Redis Cluster對使用Lua腳本增加了一些限制，在此基礎上，Tair集群版對使用Lua腳本存在如下額外限制：

• 小版本限制，若無法執行EVAL的相關命令，并報錯ERR command eval not support for normal user時，請升級小版本后重試，具體操作請參見升級小版本與代理版本。

• 所有Key必須在一個slot上，否則報錯-ERR eval/evalsha command keys must be in same slot\r\n。

  您可以通過CLUSTER KEYSLOT命令獲取目標Key的哈希槽（Hash Slot）進行確認。

• 對單個節點執行SCRIPT LOAD命令時，不保證將該Lua腳本存入至其他節點中。

• 不支持發布訂閱命令，包括PSUBSCRIBE、PUBSUB、PUBLISH、PUNSUBSCRIBE、SUBSCRIBE和UNSUBSCRIBE。

• 不支持UNPACK函數。

代理模式（Proxy）對Lua的額外檢測項

您也可以通過script_check_enable參數關閉以下檢查項（不推薦）。

• 所有key都應該由KEYS數組來傳遞，redis.call/pcall中調用的Tair命令，key的位置必須是KEYS array，且不能使用Lua變量替換KEYS，否則返回錯誤信息：-ERR bad lua script for redis cluster, all the keys that the script uses should be passed using the KEYS array\r\n。

  說明

  僅Redis 5.0版本（小版本5.0.8以下）、4.0及以下版本實例存在該限制。

  正確與錯誤命令示例如下：

  # 本示例的準備工作需執行如下命令。
  SET foo foo_value
  SET {foo}bar bar_value
  
  # 正確示例：
  EVAL "return redis.call('mget', KEYS[1], KEYS[2])" 2 foo {foo}bar
  
  # 錯誤示例：
  EVAL "return redis.call('mget', KEYS[1], '{foo}bar')" 1 foo                      # '{foo}bar'作為Key，應該使用KEYS數組進行傳遞。
  EVAL "local i = 2 return redis.call('mget', KEYS[1], KEYS[i])" 2 foo {foo}bar    # 在代理模式（Proxy）不允許執行此腳本，因為KEYS數據的索引是變量，但在直連模式中無此限制。
  EVAL "return redis.call('mget', KEYS[1], ARGV[1])" 1 foo {foo}bar                # 不應該使用ARGV[1]數據元素作為Key。

• redis.call/pcall中調用的Tair命令必須是字符串常量，否則返回錯誤信息：-ERR bad lua script for redis cluster, first parameter of redis.call/redis.pcall must be a single literal string。

  正確與錯誤命令示例如下：

  # 正確示例
  eval "redis.call('GET', KEYS[1])" 1 foo
  
  # 錯誤示例
  eval "local cmd = 'GET'; redis.call(cmd, KEYS[1])" 1 foo

• 調用必須要帶有Key，否則返回錯誤信息：-ERR for redis cluster, eval/evalsha number of keys can't be negative or zero\r\n。

  說明

  僅Redis 5.0版本（小版本5.0.8以下）、4.0及以下版本實例存在該限制。

  正確與錯誤命令示例如下：

  # 正確示例
  EVAL "return redis.call('get', KEYS[1])" 1 fooeval
  
  # 錯誤示例
  EVAL "return redis.call('get', 'foo')" 0

• 不支持Redis嵌套方式調用，否則直接返回錯誤信息：-ERR bad lua script for redis cluster, nested redis.call/redis.pcall。

  您可以使用局部變量的方式進行調用，正確與錯誤命令示例如下：

  # 正確示例
  EVAL "local value = redis.call('GET', KEYS[1]); redis.call('SET', KEYS[2], value)" 2 foo bar
  
  # 錯誤示例
  EVAL "redis.call('SET', KEYS[1], redis.call('GET', KEYS[2]))" 2 foo bar

• 不支持在MULTI、EXEC事務中使用EVAL、EVALSHA、SCRIPT系列命令。

• 不支持在Lua中執行跨Tair節點的命令，例如KEYS、SCAN等。

  為了保證Lua執行的原子性，Proxy會根據KEYS參數將Lua發送到一個Tair節點執行并獲取結果，從而導致該結果與全局結果不一致。