Lua 5.2/5.3 熱更新小結


Lua熱更新實現

用途

在生產環境上,總有可能出現不可預知的Bug,而通常修改好Bug僅僅又修改幾句,停機維護的成本又太高,對於游戲來說,通常每個服就是單獨的進程,也做不到像分布式環境下,關掉一部分機器,先升級一部分,再升級另一部分的無縫升級。這時候如果有熱更就可以迅速的把Bug修復方案通過熱更新進行修復,不會對用戶任何的影響。例如:

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

熱更新的原則

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

熱更新更新的基本內容就是更新服務的邏輯,通常只是邏輯發生變化,但原有的值並不能被改變,例如:

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",這時候則認為熱更正常。

2、不為熱更新寫更多的代碼

熱更新可以通過很多種方法實現,比如說模塊為了支持數據不變的特性,需要在模塊里額外寫一些代碼來記錄舊值,熱更新之后再把舊值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

更新

1、可以調用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

2、可以通過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


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM