首页 > 代码库 > cocos2d-x+lua代码热加载(Hot Swap)的研究

cocos2d-x+lua代码热加载(Hot Swap)的研究

        代码热加载跟自动更新无关,主要目的是在程序运行的时候动态的替换代码,从而实现不重启程序而更新代码的目的。最理想的情况当然是我修改完代码并保存,然后就可以直接在游戏中看到修改后的效果,这个在实际开发过程中会大大提高效率。 即便达不到理想情况,我们也希望可以实现部分热加载,从而简化操作。例如我们可以仅仅对配置文件、消息文件、界面文件实现热加载,这样策划更新数据后可以直接在游戏中看结果,而不需要重新打开客户端去跑任务。

        热加载主要原理其实很简单,lua require文件都会缓存在package.loaded里面,当重新加载文件的时候,把这个置空,然后重新require对应文件就可以了。

        实际应用中会有更多需要考虑的因素,所以完全的代码热加载很复杂(原理很简单,但是实现很复杂,需要关注的因素很多)。

        CocosIDE展示了代码热加载的效果:编辑场景中图片的位置并保存,然后图片自动放置到新的位置上面了。 这个效果看着非常神奇,但是实际上并没有什么实用价值。因为它的热加载,其实就是重新require文件(基于上面提到的原理)的过程,这个过程中会重新require ‘main.lua‘,从而整个游戏都会被重新启动。当我们只有一个简单的场景的时候,就可以实现看起来很完美的热加载。然而,由于实际游戏客户端项目会比这个复杂很多,我们会涉及到多场景、多界面、多状态的维护,所以想实现没有Bug的热加载是很困难的。

        现在只研究了一部分,初步可行,后期完善了会更加实用。

1、按R键重新加载所有的lua脚本。这个后面可以做很多优化。比如windows下检测文件变化,而不需要手动按键。只重新加载改变的文件而不是所有文件都遍历一遍。

local listener = cc.EventListenerKeyboard:create();

            listener:registerScriptHandler(function(keycode, evt)
            	--print(keycode)
                if keycode == 138 then
                    -- 按R重新加载代码
                    reload_script_files();

                    -- 逻辑代码  重新加载所有的配置
                    -- 逻辑代码 关闭并重新打开当前已打开的窗口
                end
            end, cc.Handler.EVENT_KEYBOARD_RELEASED);

            local eventDispatcher = cc.Director:getInstance():getEventDispatcher();
            eventDispatcher:addEventListenerWithSceneGraphPriority(listener, scene);

2、重新加载脚本的实现,这个会递归遍历这个脚本所有依赖的子脚本。所以一般情况下我们只需要加载一个main.lua就足够了。当然后面优化后就可以加载特定的文件而无需从main.lua一直遍历下去

-- 外部库 登记
local package_list = package_list or {
    bit = true,
    lfs = true,
    cjson = true,
    pb = true,
    socket = true,
}

-- 全局性质类/或禁止重新加载的文件记录
local ignored_file_list = ignored_file_list or {
    global = true ,
}

--已重新加载的文件记录
local loaded_file_list = loaded_file_list or {}

--视图排版控制
function leading_tag( indent )
    -- body
    if indent < 1 then
        return ''
    else
        return string.rep( '    |',  indent - 1  ) .. '    '
    end
end

--关键递归重新加载函数
--filename 文件名
--indent   递归深度, 用于控制排版显示
function recursive_reload( filename, indent )
    -- body
    if package_list[ filename] then 
        --对于 外部库, 只进行重新加载, 不做递归子文件
        --卸载旧文件
        package.loaded[ filename] = nil

        --装载信文件
        require( filename )

        --标记"已被重新加载"
        loaded_file_list[ filename] = true

        --print( leading_tag(indent) .. filename .. "... done" )
        return true
    end

    --普通文件
    --进行 "已被重新加载" 检测
    if loaded_file_list[ filename] then 
        --print( leading_tag(indent) .. filename .. "...already been reloaded IGNORED" )
        return true
    end

    local fullPath = cc.FileUtils:getInstance():fullPathForFilename(string.gsub(filename, '%.', '/') .. '.lua');
    --print(fullPath)
    --读取当前文件内容, 以进行子文件递归重新加载
    local file, err = io.open( fullPath )
    if file == nil then 
        print( string.format( "failed to reaload file(%s), with error:%s", fullPath, err or "unknown" ) )
        return false
    end

    print( leading_tag(indent) .. filename)

    -- 缓存文件内容,及时关闭文件,否则文件不可写入
    local data = http://www.mamicode.com/{}>
3、具体逻辑层面的处理

      lua的热加载主要麻烦的地方其实在逻辑层面的处理上面,一开始写代码的时候就要注意一些问题。比如:

      a、全局变量这样创建     test = test or {}    这样重新加载文件的时候就不会初始化全局变量了。同理,lua文件作用域内的函数调用也需要类似的判定防止重复运行。

      b、重新加载配置和重新打开当前窗口都需要针对自己的逻辑特殊处理。 

      c、理论上我们希望的热加载是对函数实现的替换。所以肯定不会实时的反应修改,比如npc的位置不会因为重新加载脚本而实时改变,这个是我们加载场景的时候就创建好的,如果需要npc站在新的位置上,需要重新加载场景或者运行刷新npc位置的函数。 同理,窗口中控件的位置也不会实时改变,需要我们重新打开窗口。 不过如果我们可以通过代码自动执行相关的刷新操作,其实对最终用户来说是没有什么区别的。同样是可以达到所见即所得的效果。

       d、当我们重新加载脚本后,所有的脚本内容都会自动更新。但是注册给cocos2d-x的函数不会,估计是因为tolua已经缓存了对应的函数体。这个暂时想不到好的解决方法,因为即便我能够清空tolua中的缓存,也无法找到对应的lua中的新函数。 除非重新注册函数,而重新注册函数其实就相当于重新打开窗口这个过程。


4、实际应用

      这里描述的是相对理想的情况,而且由于肯定是热加载功能为游戏框架服务,而不是反过来游戏框架去适应热加载。所以最终达不到真正理想的无缝加载。不过即便如此,通过上面三步操作也可以大大提高游戏开发效率。

      当我们写了部分界面的功能后,运行程序,查看结果。发现界面光效位置有偏移,在脚本中修改光效的位置,保存。这个时候光效自动在新的位置出现(依赖于自动重新打开窗口或自动刷新窗口功能,如果没有这个功能,则需要手动点按钮打开窗口)。我们可以继续添加新的功能,比如给按钮绑定函数,保存一下,点击窗口中的按钮看看效果,发现函数实现有错误,修改之,然后再保存,再点击按钮看下效果,运行正常,继续开发后续功能。

cocos2d-x+lua代码热加载(Hot Swap)的研究