第一次動手弄熱更新將這過程記錄一下。
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
參考:
http://blog.csdn.net/u010693827/article/details/55047909
http://www.cnblogs.com/daxiaxiaohao/p/4162400.html
http://blog.csdn.net/xkym_game/article/details/46548357
http://blog.csdn.net/xue_huashan/article/details/47337623
http://blog.csdn.net/u011488256/article/details/52274826
https://my.oschina.net/u/1785418/blog/283043