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

3. 若是当前值为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