Lua 5.2/5.3 熱更新小結

Lua熱更新實現

用途

在生產環境上，總有可能出現不可預知的Bug，而一般修改好Bug僅僅又修改幾句，停機維護的成本又過高，對於遊戲來講，一般每一個服就是單獨的進程，也作不到像分佈式環境下，關掉一部分機器，先升級一部分，再升級另外一部分的無縫升級。這時候若是有熱更就能夠迅速的把Bug修復方案經過熱更新進行修復，不會對用戶任何的影響。例如：

1. 業務邏輯有Bug
2. 配置的數據有誤
3. 需求發生變動

熱更新的原則

一、熱更新不破壞原有數據

熱更新更新的基本內容就是更新服務的邏輯，一般只是邏輯發生變化，但原有的值並不能被改變，例如：

local a = 1
function get_a()
    return a
end

此時，咱們調用get_a()返回是的1，咱們將熱更成

local a = 2
function get_a()
    print("get_a function")
    return a
end

此時咱們改變了a的初始值，但咱們並不知道以前服務a的值是否是被從新賦過值，假設熱更前a的值仍然爲1，那麼咱們熱更後調用get_a()返回的應該是1，而不該受新的初始值影響，並且同能打印出了"get_a function"，這時候則認爲熱更正常。

二、不爲熱更新寫更多的代碼

熱更新能夠經過不少種方法實現，好比說模塊爲了支持數據不變的特性，須要在模塊裏額外寫一些代碼來記錄舊值，熱更新以後再把舊值copy過來，或者用一些特殊的語法來支撐。這種方法將會對項目增長不少的負擔，並且一旦發生意料以外的Bug，熱更系統幾乎處於半癱瘓狀態。應該來講，代碼本來該怎麼實現就怎麼實現，對於99%的lua代碼都是支持的，不須要修改來迎合熱更新。一般熱更新不改變原有變量值的類型。

熱更新的實現，代碼適用於5.2以上

原理

利用_ENV環境，在加載的時候把數據加載到_ENV下，而後再經過對比的方式修改_G底下的值，從而實現熱更新，函數

function hotfix(chunk, check_name)

定義env的table，併爲env設置_G訪問權限，而後調用load實現把數據從新加載進來

local env = {}
setmetatable(env, { __index = _G })
local _ENV = env
local f, err = load(chunk, check_name,  't', env)
assert(f,err)
local ok, err = pcall(f)
assert(ok,err)

此時env咱們能夠獲得新函數有變動的部分，咱們替換的爲可見變量，也就是可直接訪問的變量

for name,value in pairs(env) do
    local g_value = _G[name]
    if type(g_value) ~= type(value) then
        _G[name] = value
    elseif type(value) == 'function' then
        update_func(value, g_value, name, 'G'..'  ')
        _G[name] = value
    elseif type(value) == 'table' then
        update_table(value, g_value, name, 'G'..'  ')
    end
end

經過env當前的值和_G當前的值進行對比

1. 若是類型不一樣咱們直接覆蓋原值，此時value不爲nil，不會出現原則被覆蓋成nil的狀況
2. 若是當前值爲函數，咱們進行函數的upvalue值比對

function update_func(env_f, g_f, name, deep)
    --取得原值全部的upvalue，保存起來
    local old_upvalue_map = {}
    for i = 1, math.huge do
        local name, value = debug.getupvalue(g_f, i)
        if not name then break end
        old_upvalue_map[name] = value
    end
    --遍歷全部新的upvalue，根據名字和原值對比，若是原值不存在則進行跳過，若是爲其它值則進行遍歷env相似的步驟
    for i = 1, math.huge do
        local name, value = debug.getupvalue(env_f, i)
        if not name then break end
        local old_value = old_upvalue_map[name]
        if old_value then
            if type(old_value) ~= type(value) then
                debug.setupvalue(env_f, i, old_value)
            elseif type(old_value) == 'function' then
                update_func(value, old_value, name, deep..'  '..name..'  ')
            elseif type(old_value) == 'table' then
                update_table(value, old_value, name, deep..'  '..name..'  ')
                debug.setupvalue(env_f, i, old_value)
            else
                debug.setupvalue(env_f, i, old_value)
            end
        end
    end
end

1. 若是當前值爲table，咱們遍歷table值進行對比

local protection = {
    setmetatable = true,
    pairs = true,
    ipairs = true,
    next = true,
    require = true,
    _ENV = true,
}
--防止重複的table替換，形成死循環
local visited_sig = {}
function update_table(env_t, g_t, name, deep)
    --對某些關鍵函數不進行比對
    if protection[env_t] or protection[g_t] then return end
    --若是原值與當前值內存一致，值同樣不進行對比
    if env_t == g_t then return end
    local signature = tostring(g_t)..tostring(env_t)
    if visited_sig[signature] then return end
    visited_sig[signature] = true
    --遍歷對比值，如進行遍歷env相似的步驟
    for name, value in pairs(env_t) do
        local old_value = g_t[name]
        if type(value) == type(old_value) then
            if type(value) == 'function' then
                update_func(value, old_value, name, deep..'  '..name..'  ')
                g_t[name] = value
            elseif type(value) == 'table' then
                update_table(value, old_value, name, deep..'  '..name..'  ')
            end
        else
            g_t[name] = value
        end
    end
    --遍歷table的元表，進行對比
    local old_meta = debug.getmetatable(g_t)
    local new_meta = debug.getmetatable(env_t)
    if type(old_meta) == 'table' and type(new_meta) == 'table' then
        update_table(new_meta, old_meta, name..'s Meta', deep..'  '..name..'s Meta'..'  ' )
    end
end

更新

一、能夠調用hotfix_file對整個文件進行熱更

function hotfix_file(name)
    local file_str
    local fp = io.open(name)
    if fp then
        io.input(name)
        file_str = io.read('*all')
        io.close(fp)
    end

    if not file_str then
        return -1
    end
    return hotfix(file_str, name)
end

二、能夠經過hotfix進行代碼的更新

function hotfix(chunk, check_name)

關於坑

這裏有一個注意事項，lua的module模塊，如：

module("AA", package.seeall)

當咱們加載lua模塊的時候，這時候這個模塊信息並不像初始化全局代碼同樣，就算提早設置了package.loaded["AA"] = nil, 也不會出如今env中同時也不會調用_G的__newindex函數，也就是說env["AA"]爲空，故這種寫法沒法進行熱更新，因此一般模塊的寫法改爲以下

--定義模塊AA
AA = {}
--至關於package.seeall
setmetatable(AA, {__index = _G})
--環境隔離
local _ENV = AA

參考

源碼td_rlua

項目使用TDEngine