基于Quick-cocos2dx 2.2.3 的动态更新实现完整篇。(打包,服务器接口,模块自更新)

来源:互联网 发布:cnki翻译助手软件下载 编辑:程序博客网 时间:2024/05/22 05:02

摘要 1,如何设计更新服务器接口。 2,不改变原框架的代码的情况下如何实现更新,并且可以实现精确的进度。 3,如何按照版本打包。 4,如何跨n个小版本更新。 5,版本回滚。 6,如何更新你的自动更新模块和framework_precomplied.zip代码。

先直接上代码UpdateScene.lua:

代码位置为:你的游戏目录/update/UpdateScene.lua

require("config")require("framework.init")require("framework.shortcodes")require("framework.cc.init")local UpdateScene  = class("UpdateScene", function()    return display.newScene("UpdateScene")end)local NEEDUPDATE   = truelocal server       = "http://服务器ip:3001/"local versionFile  = "version/?fileVersion="local allFileList  = "version/?id="local nowVersion   = CCUserDefault:sharedUserDefault():getStringForKey("current-version-code")local bigVersion   = CCUserDefault:sharedUserDefault():getStringForKey("VERSION_BIG")function UpdateScene:ctor(  )    display.newSprite("kfs_background.png", display.cx, display.cy):addTo(self) self.path = device.writablePath.."kdfs/"     self:createDownPath(self.path)    self:createDownPath(self.path.."res/")    self:createDownPath(self.path.."scripts/")    if string.len(nowVersion) == 0 then        nowVersion = bigVersion..".0"    end    local list      = string.split(nowVersion,".")    self.nowId      = tonumber(list[3])    self.versionBig = list[1].."."..list[2]    --大版本变化了    if self.versionBig ~= bigVersion then         self:delAllFilesInDirectory(self.path)    end            NEEDUPDATE          = CCUserDefault:sharedUserDefault():getBoolForKey("CanUpdate")    --NEEDUPDATE          = true        self.updateProgress = self:newProgressTimer( "kfs_jindutiaobox.png","kfs_jindutiao.png" ):pos(display.cx,120):addTo(self)    self.progressLabel  = ui.newTTFLabel({text = "更新", size = 26, align = ui.TEXT_ALIGN_CENTER, color = display.COLOR_BLACK}):pos(display.cx,160):addTo(self) endfunction UpdateScene:downIndexedVersion(  )    if not self.nowDownIndex then self.nowDownIndex = 1 end    local versionUrl = server..versionFile..self.needDownVersions[self.nowDownIndex].version.."."..self.needDownVersions[self.nowDownIndex].id    local packageUrl = self.needDownVersions[self.nowDownIndex].fileUrl    if self.nowDownIndex == 1 then         self.assetsManager = AssetsManager:new(packageUrl,versionUrl,self.path)  --资源包路径,代码号路径,存储路径        self.assetsManager:registerScriptHandler(handler(self, self.downHandler))    else        self.assetsManager:setVersionFileUrl(versionUrl)        self.assetsManager:setPackageUrl(packageUrl)    end    if self.assetsManager:checkUpdate() then        self.assetsManager:update()    endendfunction UpdateScene:getNewestVersion(  )    self.progressLabel:setString("正在获取版本列表")    if not NEEDUPDATE then        print("当前版本为DEBUG版本,不需要更新!")        self.progressLabel:setString("当前版本为DEBUG版本,不需要更新")        self:performWithDelay(function (  )            self:noUpdateStart()        end,2)        return    end    function callback(event)        local ok = (event.name == "completed")        local request = event.request        if event.name then print("request event.name = " .. event.name) end        if not ok then            print("请求失败 "..request:getErrorMessage())            self.progressLabel:setString("版本更新列表请求网络出错")            self:performWithDelay(function (  )                self:noUpdateStart()            end,2)            return        end        local code = request:getResponseStatusCode()        if code ~= 200 then            print("请求错误,代码 "..request:getResponseStatusCode())            self.progressLabel:setString("版本更新列表请求网络出错"..request:getResponseStatusCode())            self:performWithDelay(function (  )                self:noUpdateStart()            end,2)            return        end        if json.decode(request:getResponseString()) then            print(request:getResponseString())            local needDownVersions = json.decode(request:getResponseString())            if needDownVersions.code == 200 then                self.needDownVersions = needDownVersions.list                for i,v in ipairs(self.needDownVersions) do                    if v.needRestart > 0 then                        self.needRestart = true                    end                end                if #self.needDownVersions > 0 then                    self:downIndexedVersion()                end            else                self.progressLabel:setString("当前版本已经是最新版本")                self.updateProgress.progressTimer:setPercentage(100)                self:performWithDelay(function (  )                    self:noUpdateStart()                end,2)            end        end    end         local request = network.createHTTPRequest(callback, server..allFileList..self.nowId.."&versionBig="..self.versionBig, "GET")    request:setTimeout(10)    request:start()endfunction UpdateScene:onEnter(  )    self:getNewestVersion()endfunction UpdateScene:afterUpdateStart(  )    if self.needRestart then        print("提示需要重新启动游戏")        require("game")        game.exit()        return    end    print("更新成功,启动游戏")    package.loaded["config"] = nil    CCLuaLoadChunksFromZIP("game.zip")    require("game")    game.startup()endfunction UpdateScene:noUpdateStart(  )    print("没有更新或者更新失败启动游戏")    require("game")    CCLuaLoadChunksFromZIP("game.zip")    game.startup()endfunction UpdateScene:downHandler( event )    if event == "success" then         if self.nowDownIndex < #self.needDownVersions then             self.nowDownIndex = self.nowDownIndex +1            self:downIndexedVersion()        else            self.progressLabel:setString("更新成功")            self:performWithDelay(function (  )                self:afterUpdateStart()            end,2)        end    elseif string.startWith(event,"error") then        local text = ""        if event == "errorNetwork" then text = "网络出错!" end        if event == "errorNoNewVersion" then self.updateProgress.progressTimer:setPercentage(100) text = "已是最新" end        if event == "errorUncompress" then text = "解压出错" end        if event == "errorUnknown" then text = "未知错误" end        self.progressLabel:setString(text)        self:performWithDelay(function (  )            self:noUpdateStart()        end,2)    else        local alreadyDownPercent = (self.nowDownIndex - 1)*100/(#self.needDownVersions )        print("alreadyDownPercent:",alreadyDownPercent)        alreadyDownPercent = alreadyDownPercent + event/(#self.needDownVersions )        alreadyDownPercent = math.floor(alreadyDownPercent)        self.progressLabel:setString("已更新"..alreadyDownPercent.."%")        self.updateProgress.progressTimer:setPercentage(alreadyDownPercent)        self:progressTimerAction(self.updateProgress.progressTimer,self.updateProgress.progressTimer:getPercentage(),alreadyDownPercent)    endendfunction UpdateScene:createDownPath( path )    if not self:checkDirOK(path) then        print("更新目录创建失败,直接开始游戏")        self:noUpdateStart()        return    else    -- print("更新目录存在或创建成功")    endendfunction UpdateScene:checkDirOK( path )    require "lfs"    local oldpath = lfs.currentdir()    if lfs.chdir(path) then        lfs.chdir(oldpath)        return true    end    if lfs.mkdir(path) then        return true    endendfunction UpdateScene:newProgressTimer( bgBarImg,progressBarImg )     local bg = display.newSprite(bgBarImg)    local progressTimer = CCProgressTimer:create(display.newSprite(progressBarImg))    bg.progressTimer = progressTimer    progressTimer:setType(kCCProgressTimerTypeBar)     progressTimer:setPercentage(0)     progressTimer:setMidpoint(ccp(0,0))     progressTimer:setBarChangeRate(ccp(1, 0))     progressTimer:setPosition(ccp(bg:getContentSize().width/2,bg:getContentSize().height/2))     bg:addChild(progressTimer, 140)    return bgendfunction UpdateScene:progressTimerAction( progressTimer,fromPercentage,toPercentage,duration )    if not duration then duration = 0.3 end    local ac = CCProgressFromTo:create(duration,fromPercentage,toPercentage)    progressTimer:runAction(ac)endfunction UpdateScene:delAllFilesInDirectory( path )    for file in lfs.dir(path) do      if file ~= "." and file ~= ".." then          local f = path..'/'..file          local attr = lfs.attributes (f)          assert (type(attr) == "table")          if attr.mode == "directory" then              self:delAllFilesInDirectory (f)          else              os.remove(f)          end      end    endendstring.startWith = function(str,strStart)    local a,_ = string.find(str,strStart)    return a==1endstring.split = function(s, p)    local rt= {}    string.gsub(s, '[^'..p..']+', function(w) table.insert(rt, w) end )    return rtendreturn UpdateScene
代码解释:

NeedUpdate 这个变量代表自动更新开关,平常咱们在debug模式下等等时候,不需要这个这个功能,可以把它关掉。

server,versionFile,allFileList 这3个变量组成你增量更新所需要的2个服务器接口。

server..versionFile 接受一个版本号作参数,返回的也是这个版本号,具体原因参见代码,主要是为了配合AssetsManager的参数需求。

server..allFileList 接受一个当前的版本的小版本号。比如全版本是 1.0.1 的话,那小版本就是1。同理 1.0.5的话,小版本id就是5。

server..allFileList?id=0&bigversion=1.0 则返回以下格式接口:

{"code":200,"list":[{"id":1,"fileUrl":"http://服务器地址/vf/kdfs1.0.1.zip","version":"1.0","needRestart":0}]}
接口中有一个很重要的变量 needRestart 表示本次更新是否有需要重新启动游戏加载的更新包。具体原因见后文。 

其它代码不一一赘述。

以上就是服务器接口设计篇。

接下来讲讲更新自更新模块和打包。

简单讲讲实现方法。

将前文的UpdateScene编译成zip,然后和 framework_precompiled.zip 一起在放到res目录下,游戏启动的时候别加载这两个文件。main.lua为如下代码:

function __G__TRACKBACK__(errorMessage)    print("----------------------------------------")    print("LUA ERROR: " .. tostring(errorMessage) .. "\n")    print(debug.traceback("", 2))    print("----------------------------------------")endlocal writablePath = CCFileUtils:sharedFileUtils():getWritablePath()CCFileUtils:sharedFileUtils():addSearchPath(writablePath.."kdfs/".."res/")CCFileUtils:sharedFileUtils():addSearchPath(writablePath.."kdfs/".."scripts/")CCFileUtils:sharedFileUtils():addSearchPath("res/")CCFileUtils:sharedFileUtils():addSearchPath("scripts/")CCLuaLoadChunksFromZIP("framework_precompiled.zip")CCLuaLoadChunksFromZIP("update.zip")xpcall(function()CCDirector:sharedDirector():runWithScene(require("UpdateScene").new())end, __G__TRACKBACK__)

并且在你的游戏代码里排除掉 UpdateScene.lua 。目的是为了保证游戏启动的时候加载的就是唯一的一份UpdateScene代码。

sh quick的目录/bin/compile_scripts.sh -i 游戏的目录/update -o update.zip

我没有把UpdateScene.lua 放到 scripts目录下,而是有个单独的目录update。这样的话可以单独把这个目录打包,然后启动游戏的时候加载。

可以参考下面的脚本完整实现以下功能:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#!/bin/sh
 
DIR="$( cd "$(dirname"${BASH_SOURCE[0]}" )" && pwd )"
APP_ROOT="游戏目录啦"
 
echo"$DIR"
echo"$APP_ROOT"
 
rm-rf *.zip
 
echo"开始编译代码"
 
sh Quick目录/bin/compile_scripts.sh -i 游戏目录/scripts-o game.zip   #编译游戏代码
sh Quick目录/bin/compile_scripts.sh -i 游戏目录/update-o update.zip  #编译自更新代码
 
if[ -d "$DIR"/res]; then
    rm-rf "$DIR"/res/*   #把当前目录下的res目录清空
fi
 
if[ -d "$DIR"/scripts]; then
    rm-rf "$DIR"/scripts/*#把当前目录下的res目录清空
fi
 
chmod777 "$DIR"/scripts
chmod777 "$DIR"/res
 
echo"- copy scripts"
cp-rf -p game.zip "$DIR"/scripts#把编译好的game.zip复制到scripts目录下
cp-rf -p update.zip "$DIR"/../res/update.zip #把编译好的update.zip 放到游戏目录下的res目录下
cp-rf -p update.zip "$DIR"/res  #把编译好的update.zip放到当前目录的res目录下
 
echo"- copy resources"
cp-rf -p "$APP_ROOT"/res"$DIR"#把游戏目录下的res目录所有的内容复制到当前目录下的res目录
 
find./res-typef -mtime +15000 -execrm -rf {} \;  #实现增量更新的关键,代码含义为 删掉当前res目录下 文件修改日期为 多少天或者多少时或多少秒 之前的文件
find./res-name ".DS_Store"| xargsrm -Rf     #清除一些冗余文件,可不要
 
echo"打包res和scripts"
zip -r kdfs.zip res/* scripts/*   #将当前版本的增量更新的res资源和代码game.zip 打包成一个文件
cpkdfs.zip kdfs$1.zip    #根据接受的参数重新命名本次更新文件
 
echo"开始上传"
scpkdfs$1.zip root@服务器ip:/root/kdfs_server/web-server/public/versionFile/#通过scp上传到服务器
echo"上传结束"


关于回滚代码的需求,打个比方你现在版本为1.0.10,你需要回到1.0.5,其实实现很简单:

1,编译你1.0.5的时候的game.zip,原理很简单,你有你的代码服务器svn或git。

2,打包res资源,你可以打包一次从1.0.0-1.0.5的资源。

这样的话,你的代码和资源都是1.0.5的时候的了。


0 0
原创粉丝点击