Cocos2dx Lua 热更新

在我没接触热更新之前,我对热更新是一脸懵逼。后来看了些资料,自己动手试验了下,基本上了解了它的过程。
所谓的热更新,就是在线更新代码和资源。

热更新的过程

首先,客户端向服务器发送请求,服务器告诉客户端,没更新啦,你是最新的啦,那就直接跳过喽。但如果是告诉你有更新,那就要告诉我哪些需要更新对吧,你可能需要更新的东西,放在一个文件里,一并发送给客户端,客户端拿到这个文件,就一个一个去向服务器要,最后把要更新的内容都下载到本地了。但是如果下载的资源之前已经存在,会不会出问题啊?
我们以win32平台为例


Cocos2dx Lua 热更新_第1张图片
luagame4.png

这个是工程目录

而对于下载目录,一般是

C:\Users\user\AppData\Local\LuaGame4

但是这又有一个问题,平时我们调用资源都是直接调工程目录下啊,这会你下载到c盘里了,怎么能调用到?
这就涉及到一个优先级的问题了,比如一张图片它的路径是img/sample.png,在工程目录下的全路径就是
E/LuaGame4/res/img/sample.png ,那我们在代码里通常是这么调用的

local sp = cc.Sprite:create("img/sample.png")
self:addChild(sp)

回到之前的问题,现在要更新这张图片,上面说的是下载到

C:\Users\user\AppData\Local\LuaGame4

这个目录下,那我们要用同样的代码就能调用到新资源,只要将这个目录下的资源路径和我们工程下一致,然后将C:\Users\user\AppData\Local\LuaGame4 加入搜索路径,并且将它优先级设置最高,那么就可以调用到了。

具体实现

知道了它的大致工作过程,再来实际操作下,估计就会很清晰了。
在cocos2dx中,使用的是AssetsManagerEx这个类。而对于AssetsManager这个类是不推荐使用的,这个类有很多东西都没考虑到,我们就不深究了。
先上代码

local writablePath = cc.FileUtils:getInstance():getWritablePath()
    local storagePath = writablePath .. "new_version"
--将下载目录的src和res作为优先级最高的搜索目录,这样才能保证下载的能覆盖原来的代码
cc.FileUtils:getInstance():addSearchPath(storagePath.."/src/",true)
    cc.FileUtils:getInstance():addSearchPath(storagePath.."/res/",true)

    -- 创建AssetsManagerEx对象
    local assetsManagerEx = cc.AssetsManagerEx:create("src/version/project.manifest", storagePath)
    assetsManagerEx:retain()


    -- 设置下载消息listener
    local function handleAssetsManagerEx(event)
        if (cc.EventAssetsManagerEx.EventCode.ALREADY_UP_TO_DATE == event:getEventCode()) then
            print("已经是最新版本了,进入游戏主界面")
            -- app:enterScene("GameScene")
        end

        if (cc.EventAssetsManagerEx.EventCode.NEW_VERSION_FOUND == event:getEventCode()) then
            print("发现新版本,开始升级")
        end


        if (cc.EventAssetsManagerEx.EventCode.UPDATE_PROGRESSION == event:getEventCode()) then
            print("更新进度=" .. event:getPercent())
        end


        if (cc.EventAssetsManagerEx.EventCode.UPDATE_FINISHED == event:getEventCode()) then
            print("更新完毕,重新启动")
            app:run()
        end

        if (cc.EventAssetsManagerEx.EventCode.ERROR_NO_LOCAL_MANIFEST == event:getEventCode()) then
            print("发生错误:本地找不到manifest文件")
        end

        if (cc.EventAssetsManagerEx.EventCode.ERROR_DOWNLOAD_MANIFEST == event:getEventCode()) then
            print("发生错误:下载manifest文件失败")
        end

        if (cc.EventAssetsManagerEx.EventCode.ERROR_PARSE_MANIFEST == event:getEventCode()) then
            print("发生错误:解析manifest文件失败")
        end

        if (cc.EventAssetsManagerEx.EventCode.ERROR_UPDATING == event:getEventCode()) then
            print("发生错误:更新失败")
        end
    end


    local dispatcher = cc.Director:getInstance():getEventDispatcher()
    local eventListenerAssetsManagerEx = cc.EventListenerAssetsManagerEx:create(assetsManagerEx, handleAssetsManagerEx)
    dispatcher:addEventListenerWithFixedPriority(eventListenerAssetsManagerEx, 1)


    -- 检查版本并升级
    assetsManagerEx:update()

先从

-- 创建AssetsManagerEx对象
 local assetsManagerEx = cc.AssetsManagerEx:create("src/version/project.manifest", storagePath)

开始看,首先构建一个AssetsManagerEx:create对象,需要传入两个参数

  • project.manifest路径
  • 下载路径

这里我传入的project.manifest路径是src/version/project.manifest

Cocos2dx Lua 热更新_第2张图片
manifest.png

这是个什么文件呢,打开看看

{
    "packageUrl" : "http://localhost:8080/examples/servlets/update/assets/",
    "remoteManifestUrl" : "http://localhost:8080/examples/servlets/update/version/project.manifest",
    "remoteVersionUrl" : "http://localhost:8080/examples/servlets/update/version//version.manifest",
    "version" : "1.0.0",
    "engineVersion" : "3.x dev",

    "assets" : {
        "res/blocks.png" : {
            "md5" : "...."
        }
    },
    
    "searchPaths" : [
    ]
}

这是一个json格式的文件,解释下每个key的意思

key 作用
packageUrl 更新包的url
remoteManifestUrl project.manifest的url
remoteVersionUrl 这个文件和project.manifest一个意思,但是比project.manifest更简洁,待会说
version 版本,是否需要更新就是看他了
engineVersion 引擎版本,写不写无所谓
assets 所有的文件名和他的md5值,在更新的时候会比对本地和远程的md5值,不一致则会更新,否则不更新

来看下version.manifest写了点啥

{
    "packageUrl" : "http://localhost:8080/examples/servlets/update/assets/",
    "remoteManifestUrl" : "http://localhost:8080/examples/servlets/update/version/project.manifest",
    "remoteVersionUrl" : "http://localhost:8080/examples/servlets/update/version//version.manifest",
    "version" : "1.0.2",
    "engineVersion" : "3.x dev",
}

卧槽,这不就是project.manifest的简化版吗?
卧槽,你怎么知道!
既然是简化版,那为什么要弄两个文件,不直接用更详细的project.manifest呢?

这是出于更新流量的考虑,我们在工程目录下会放一个关于整个项目资源的project.manifest的清单文件,在更新的时候,AssetsManagerEx会拿到其中的remoteVersionUrl,先将version.manifest下载下来,比对version,判断是否要更新,如果要更新,再下载较为详细的project.manifest文件,这样做的好处,就是当你的工程比较大的时候,对应的project.manifest也会比较大,如果每次都直接去下载project.manifest,那么就会造成不必要的让费了。

创建完AssetsManagerEx对象之后,要为它注册监听事件,方便我们对更新情况进行把握,比如进度,比如是否出错等等。对于对应的事件,在代码中已经写的很清楚了,这里就不再说了。

之后调用assetsManagerEx:update()开始更新。

完了。
啊?完了?
啊,完了啊
你妹啊

好吧,我知道你还是有点懵逼,这TM我这服务器怎么搞?我这本地要弄些啥啊。。莫得关系,往下看

需要准备的文件

  • 客户端
    对于客户端而言,就是一份project.manifest文件,它记录了所有资源一级代码的md5,方便在第一次更新的时候做比对,一旦有过一次更新之后,以后就不会用这个文件了,而是用下载目录下的project.manifest,不然的话更新了还是白更新
  • 服务器
    服务器上,需要三样东西project.manifestversion.manifest,以及更新包。

搞个简单的tomcat

热更新用的http协议,而写一个http后台,比较容易的方法就是搞个tomcat,不会的朋友可以看下怎么搭建,不算难,有点java基础的话,看两盘文章就知道怎么用了

Cocos2dx Lua 热更新_第3张图片
tomcat.png

这是我tomcat的目录,我建了一个update文件夹,下面有两个子文件夹

  • version
Cocos2dx Lua 热更新_第4张图片
version.png
  • assets
Cocos2dx Lua 热更新_第5张图片
assets.png

文章中就放了一个资源的路径res/blocks.png,他的url就是packageUrlres/blocks.png做拼接,也就是http://localhost:8080/examples/servlets/update/assets/res/blocks.png

这么一放,就有点感觉了吧?服务器上的目录和你工程目录完全一致,这样的话,只要把下载目录加入到搜索路径里,对于一样的相对路径,就能在下载目录中找到了。

你可能感兴趣的:(Cocos2dx Lua 热更新)