1. 程式人生 > >cocos2dx之熱更新

cocos2dx之熱更新

第一次動手弄熱更新將這過程記錄一下。

1.熱更新基本原理
這裡先說一下熱更新的基本原理
1)不能更新主程式,只能更新資源、lua等檔案
c++生成的主程式如果變化只能通過下載升級包安裝,而其它檔案可以通過http動態下載到使用者手機上,然後程式內部重新執行入口函式達到更新程式碼邏輯和資源圖片的效果。所以c++那部分程式碼在程式上線前最好最完善。

2)下載的檔案會放到手機的可寫入目錄下,而且該目錄中檔案的優先順序會高於程式原始安裝目錄
http方式下載後的檔案並不能直接覆蓋安裝程式所在資料夾中的同名檔案,因為許可權不足。但是lua屬於動態載入,只要在搜尋路徑中把可寫入目錄的優先順序設定為最高,那麼如果兩個目錄中都有同名檔案,程式也會用最新下載的
AssetsManagerEx類的create函式中會把使用者定義的可寫入目錄設定為最高優先順序

3)lua檔案和資原始檔被載入後,即便在程式執行中,檔案也可以直接刪除
這種機制才確保檔案可以被動態替換掉

4)手機本地和伺服器中儲存一個程式中所有檔案的md5碼列表,通過比較二者檔案md5碼列表的不同過濾出需要更新的檔案進行下載
傳統PC更新方式一般是把差異檔案打包成一個壓縮包,然後客戶端根據大版本差異把對應的壓縮包下載到本地,再解壓覆蓋,這樣做的好處是下載一個檔案會比較快,缺點第一是當客戶端版本比較多的時候,升級壓縮包會變得很多,很難維護。第二是如果壓縮包比較大,解壓時間會比較長,而且不太容易做進度條,導致程式感覺被卡住了
AssetsManagerEx採用的是比較所有檔案是否一致的方法(需要先寫個工具把程式下所有檔案的md5碼計算出來,並且生成對應格式的manifest檔案才行),這點更象是網頁載入的方式,也就是web顯示時如果本地有快取就比較快取和伺服器是否一樣,如果一樣就用快取的,不一樣就下載。這樣伺服器只需要儲存一個完整的最新客戶端,如果更新了某個檔案,只需要在伺服器上替換對應檔案,然後修改配置檔案中的版本號和那個檔案的md5碼即可。優點是沒有解壓縮的過程,缺點是更新檔案比較多時略慢,而且有一定機率下載失敗,好在現在手機網速都比較高,失敗了重新下載即可,即使偶爾升級失敗進不去也關係不大。

cocos2dx有AssetsManagerEx來幫助我們實現熱更新,可以參考官網自帶例子AssetsManagerExTest。

需要準備的檔案
客戶端
對於客戶端而言,就是一份project.manifest檔案,它記錄了所有資源一級程式碼的md5,方便在第一次更新的時候做比對,一旦有過一次更新之後,以後就不會用這個檔案了,而是用下載目錄下的project.manifest,不然的話更新了還是白更新
伺服器
伺服器上,需要三樣東西project.manifest,version.manifest,以及更新包。

關於這幾個檔案的生成,可參考我這裡
建立一個更新檔案UpdateAssetScene.lua

local UpdateAssetScene = class("UpdateAssetScene", function()
    return display.newScene("UpdateAssetScene")
end)

function UpdateAssetScene:ctor()
    self:_initPath()
    self:_initAssetMgr()
    self:_startUpdate()
end

function UpdateAssetScene:_initPath()
    --可寫路徑
    self.writablePath = cc.FileUtils:getInstance():getWritablePath()
    --下載儲存路徑
    self.storagePath = self.writablePath .. "update"
    --本地配置檔案路徑
    self.manifestFile = "res/version/project.manifest"
    --下載儲存路徑
    local storagePath = self.writablePath .. "update"
    --建立可寫目錄與設定搜尋路徑
    if not (cc.FileUtils:getInstance():isDirectoryExist(storagePath)) then         
        cc.FileUtils:getInstance():createDirectory(storagePath)
        cc.FileUtils:getInstance():createDirectory(storagePath .. '/src/')
        cc.FileUtils:getInstance():createDirectory(storagePath .. '/res/')
    end

    --設定app讀檔案的優先順序,將下載儲存路徑設為最高
    cc.FileUtils:getInstance():addSearchPath(storagePath .. "/src/", true)
    cc.FileUtils:getInstance():addSearchPath(storagePath .. "/res/", true)
end
function UpdateAssetScene:_initAssetMgr()
    local layer  = cc.Layer:create()
    self:addChild(layer)
    self.layer = layer

    self.ttInfoText = ccui.Text:create()
    self.ttInfoText:setPosition(Const["CENTER_X"], Const["CENTER_Y"] + 50)
    self.ttInfoText:setFontSize(26)
    -- self.ttInfoText:setString("初始化...")
    layer:addChild(self.ttInfoText)

    local ivProgressBg = ccui.ImageView:create("poker/res/sliderbg.png")
    ivProgressBg:setAnchorPoint(0.5, 0)
    ivProgressBg:setPosition(Const["CENTER_X"], Const["CENTER_Y"] - 80)
    self:addChild(ivProgressBg)

    --進度條
    self.m_slider = cc.ProgressTimer:create(cc.Sprite:create("poker/res/slider.png"))
    self.m_slider:setType(cc.PROGRESS_TIMER_TYPE_BAR)
    self.m_slider:setMidpoint(cc.p(0, 0))
    self.m_slider:setBarChangeRate(cc.p(1, 0))
    self.m_slider:setPercentage(0)
    self.m_slider:setAnchorPoint(0.5, 0.5)
    self.m_slider:setPosition(ivProgressBg:getContentSize().width / 2, ivProgressBg:getContentSize().height / 2)
    ivProgressBg:addChild(self.m_slider)

    local function onNodeEvent(event)
        if "enter" == event then
            self:_updateListen()
        elseif "exit" == event then
            if self.assetsManagerEx then
                self.assetsManagerEx:release()
                self.assetsManagerEx = nil
            end
        end
    end
    layer:registerScriptHandler(onNodeEvent)
end
function UpdateAssetScene:_updateListen()
    print("self.manifestFile: ", self.manifestFile)
    print("self.storagePath: ", self.storagePath)

    --建立AssetsManagerEx物件
    self.assetsManagerEx = cc.AssetsManagerEx:create(self.manifestFile, self.storagePath)
    self.assetsManagerEx:retain()

    --下載失敗數量
    local failCount = 0 
    -- Check whether the manifest have been fully loaded
    if not self.assetsManagerEx:getLocalManifest():isLoaded() then
        print("Fail to update assets, step skipped.")
        self:_nextScene()
    else
        local function onUpdateEvent(event)
            local strInfo = ""

            local eventCode = event:getEventCode()
            if eventCode == cc.EventAssetsManagerEx.EventCode.ERROR_NO_LOCAL_MANIFEST then
                strInfo = "發生錯誤:本地找不到manifest檔案"
            elseif  eventCode == cc.EventAssetsManagerEx.EventCode.UPDATE_PROGRESSION then
                local assetId = event:getAssetId()
                local percent = event:getPercent()

                if assetId == cc.AssetsManagerExStatic.VERSION_ID then
                    strInfo = string.format("Version file: %d%%", percent)
                elseif assetId == cc.AssetsManagerExStatic.MANIFEST_ID then
                    strInfo = string.format("Manifest file: %d%%", percent)
                else
                    strInfo = string.format("%d%%", percent)
                end

                self.m_slider:setPercentage(percent)
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.ERROR_DOWNLOAD_MANIFEST then 
                self:downloadManifestError()
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.ERROR_PARSE_MANIFEST then 
                strInfo = "發生錯誤:解析manifest檔案失敗"
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.ALREADY_UP_TO_DATE then
                strInfo = "已經是最新版本了,進入遊戲主介面"
                self:updateFinished()
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.NEW_VERSION_FOUND then 
                strInfo = "發現新版本,開始升級"
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.UPDATE_FINISHED then 
                strInfo = "Update finished."
                self:updateFinished()
            elseif eventCode == cc.EventAssetsManagerEx.EventCode.ERROR_UPDATING then
                print("Asset 發生錯誤:更新失敗 ", event:getAssetId(), ", ", event:getMessage())
                failCount = failCount + 1  
                if (failCount < 5) then  
                    self.assetsManagerEx:downloadFailedAssets()  
                else  
                    print("Reach maximum fail count, exit update process")  
                    failCount = 0  
                end 
            end

            self.ttInfoText:setString(strInfo)
        end
        local listener = cc.EventListenerAssetsManagerEx:create(self.assetsManagerEx,onUpdateEvent)
        cc.Director:getInstance():getEventDispatcher():addEventListenerWithSceneGraphPriority(listener, self.layer)

        self:_startUpdate()
    end
end
-- 檢查版本並升級
function UpdateAssetScene:_startUpdate()
    if not self.assetsManagerEx then return end
    self.assetsManagerEx:update()
end

-- 更新完畢,重新啟動
function UpdateAssetScene:updateFinished()
    self.ttInfoText:setString("更新完畢,重新啟動")
    self:_nextScene()
end

-- 發生錯誤:下載manifest檔案失敗,資源伺服器沒有開啟...
function UpdateAssetScene:downloadManifestError()
    self.ttInfoText:setString("發生錯誤:下載manifest檔案失敗,資源伺服器沒有開啟...")
end

function UpdateAssetScene:_nextScene()
    local handle = scheduler.performWithDelayGlobal(function ( ... )
        delayEnableConnectHandle_ = nil
        app:enterScene("LoginMainScene")
    end, 2)
    local delayEnableConnectHandle_ = handle
end

function UpdateAssetScene:onEnter()
end

function UpdateAssetScene:onExit()
end

return UpdateAssetScene