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

前端之家收集整理的这篇文章主要介绍了基于Quick-cocos2dx 2.2.3 的动态更新实现完整篇。(打包,服务器接口,模块自更新)前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

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

先直接上代码UpdateScene.lua:

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

  1. require("config")
  2. require("framework.init")
  3. require("framework.shortcodes")
  4. require("framework.cc.init")
  5.  
  6.  
  7. local UpdateScene = class("UpdateScene",function()
  8. return display.newScene("UpdateScene")
  9. end)
  10.  
  11.  
  12. local NEEDUPDATE = true
  13. local server = "http://服务器ip:3001/"
  14. local versionFile = "version/?fileVersion="
  15. local allFileList = "version/?id="
  16. local nowVersion = CCUserDefault:sharedUserDefault():getStringForKey("current-version-code")
  17. local bigVersion = CCUserDefault:sharedUserDefault():getStringForKey("VERSION_BIG")
  18.  
  19.  
  20. function UpdateScene:ctor( )
  21. display.newSprite("kfs_background.png",display.cx,display.cy):addTo(self)
  22. self.path = device.writablePath.."kdfs/"
  23. self:createDownPath(self.path)
  24. self:createDownPath(self.path.."res/")
  25. self:createDownPath(self.path.."scripts/")
  26.  
  27.  
  28. if string.len(nowVersion) == 0 then
  29. nowVersion = bigVersion..".0"
  30. end
  31. local list = string.split(nowVersion,".")
  32. self.nowId = tonumber(list[3])
  33. self.versionBig = list[1].."."..list[2]
  34.  
  35.  
  36. --大版本变化了
  37. if self.versionBig ~= bigVersion then
  38. self:delAllFilesInDirectory(self.path)
  39. end
  40. NEEDUPDATE = CCUserDefault:sharedUserDefault():getBoolForKey("CanUpdate")
  41. --NEEDUPDATE = true
  42. self.updateProgress = self:newProgressTimer( "kfs_jindutiaoBox.png","kfs_jindutiao.png" ):pos(display.cx,120):addTo(self)
  43. self.progressLabel = ui.newTTFLabel({text = "更新",size = 26,align = ui.TEXT_ALIGN_CENTER,color = display.COLOR_BLACK}):pos(display.cx,160):addTo(self)
  44. end
  45.  
  46.  
  47. function UpdateScene:downIndexedVersion( )
  48. if not self.nowDownIndex then self.nowDownIndex = 1 end
  49. local versionUrl = server..versionFile..self.needDownVersions[self.nowDownIndex].version.."."..self.needDownVersions[self.nowDownIndex].id
  50. local packageUrl = self.needDownVersions[self.nowDownIndex].fileUrl
  51. if self.nowDownIndex == 1 then
  52. self.assetsManager = AssetsManager:new(packageUrl,versionUrl,self.path) --资源包路径,代码号路径,存储路径
  53. self.assetsManager:registerScriptHandler(handler(self,self.downHandler))
  54. else
  55. self.assetsManager:setVersionFileUrl(versionUrl)
  56. self.assetsManager:setPackageUrl(packageUrl)
  57. end
  58.  
  59.  
  60. if self.assetsManager:checkUpdate() then
  61. self.assetsManager:update()
  62. end
  63. end
  64.  
  65.  
  66. function UpdateScene:getNewestVersion( )
  67. self.progressLabel:setString("正在获取版本列表")
  68.  
  69.  
  70. if not NEEDUPDATE then
  71. print("当前版本为DEBUG版本,不需要更新!")
  72. self.progressLabel:setString("当前版本为DEBUG版本,不需要更新")
  73. self:performWithDelay(function ( )
  74. self:noUpdateStart()
  75. end,2)
  76. return
  77. end
  78.  
  79.  
  80. function callback(event)
  81. local ok = (event.name == "completed")
  82. local request = event.request
  83. if event.name then print("request event.name = " .. event.name) end
  84. if not ok then
  85. print("请求失败 "..request:getErrorMessage())
  86. self.progressLabel:setString("版本更新列表请求网络出错")
  87. self:performWithDelay(function ( )
  88. self:noUpdateStart()
  89. end,2)
  90. return
  91. end
  92. local code = request:getResponseStatusCode()
  93. if code ~= 200 then
  94. print("请求错误代码 "..request:getResponseStatusCode())
  95. self.progressLabel:setString("版本更新列表请求网络出错"..request:getResponseStatusCode())
  96. self:performWithDelay(function ( )
  97. self:noUpdateStart()
  98. end,2)
  99. return
  100. end
  101. if json.decode(request:getResponseString()) then
  102. print(request:getResponseString())
  103. local needDownVersions = json.decode(request:getResponseString())
  104. if needDownVersions.code == 200 then
  105. self.needDownVersions = needDownVersions.list
  106. for i,v in ipairs(self.needDownVersions) do
  107. if v.needRestart > 0 then
  108. self.needRestart = true
  109. end
  110. end
  111. if #self.needDownVersions > 0 then
  112. self:downIndexedVersion()
  113. end
  114. else
  115. self.progressLabel:setString("当前版本已经是最新版本")
  116. self.updateProgress.progressTimer:setPercentage(100)
  117. self:performWithDelay(function ( )
  118. self:noUpdateStart()
  119. end,2)
  120. end
  121. end
  122. end
  123. local request = network.createHTTPRequest(callback,server..allFileList..self.nowId.."&versionBig="..self.versionBig,"GET")
  124. request:setTimeout(10)
  125. request:start()
  126. end
  127.  
  128.  
  129. function UpdateScene:onEnter( )
  130. self:getNewestVersion()
  131. end
  132.  
  133.  
  134. function UpdateScene:afterUpdateStart( )
  135. if self.needRestart then
  136. print("提示需要重新启动游戏")
  137. require("game")
  138. game.exit()
  139. return
  140. end
  141. print("更新成功,启动游戏")
  142. package.loaded["config"] = nil
  143. CCLuaLoadChunksFromZIP("game.zip")
  144. require("game")
  145. game.startup()
  146. end
  147.  
  148.  
  149. function UpdateScene:noUpdateStart( )
  150. print("没有更新或者更新失败启动游戏")
  151. require("game")
  152. CCLuaLoadChunksFromZIP("game.zip")
  153. game.startup()
  154. end
  155.  
  156.  
  157. function UpdateScene:downHandler( event )
  158. if event == "success" then
  159. if self.nowDownIndex < #self.needDownVersions then
  160. self.nowDownIndex = self.nowDownIndex +1
  161. self:downIndexedVersion()
  162. else
  163. self.progressLabel:setString("更新成功")
  164. self:performWithDelay(function ( )
  165. self:afterUpdateStart()
  166. end,2)
  167. end
  168. elseif string.startWith(event,"error") then
  169. local text = ""
  170. if event == "errorNetwork" then text = "网络出错!" end
  171. if event == "errorNoNewVersion" then self.updateProgress.progressTimer:setPercentage(100) text = "已是最新" end
  172. if event == "errorUncompress" then text = "解压出错" end
  173. if event == "errorUnknown" then text = "未知错误" end
  174. self.progressLabel:setString(text)
  175. self:performWithDelay(function ( )
  176. self:noUpdateStart()
  177. end,2)
  178. else
  179. local alreadyDownPercent = (self.nowDownIndex - 1)*100/(#self.needDownVersions )
  180. print("alreadyDownPercent:",alreadyDownPercent)
  181. alreadyDownPercent = alreadyDownPercent + event/(#self.needDownVersions )
  182. alreadyDownPercent = math.floor(alreadyDownPercent)
  183. self.progressLabel:setString("已更新"..alreadyDownPercent.."%")
  184. self.updateProgress.progressTimer:setPercentage(alreadyDownPercent)
  185. self:progressTimerAction(self.updateProgress.progressTimer,self.updateProgress.progressTimer:getPercentage(),alreadyDownPercent)
  186. end
  187. end
  188.  
  189.  
  190. function UpdateScene:createDownPath( path )
  191. if not self:checkDirOK(path) then
  192. print("更新目录创建失败,直接开始游戏")
  193. self:noUpdateStart()
  194. return
  195. else
  196. -- print("更新目录存在或创建成功")
  197. end
  198. end
  199.  
  200.  
  201. function UpdateScene:checkDirOK( path )
  202. require "lfs"
  203. local oldpath = lfs.currentdir()
  204. if lfs.chdir(path) then
  205. lfs.chdir(oldpath)
  206. return true
  207. end
  208. if lfs.mkdir(path) then
  209. return true
  210. end
  211. end
  212.  
  213.  
  214. function UpdateScene:newProgressTimer( bgBarImg,progressBarImg )
  215. local bg = display.newSprite(bgBarImg)
  216. local progressTimer = CCProgressTimer:create(display.newSprite(progressBarImg))
  217. bg.progressTimer = progressTimer
  218. progressTimer:setType(kCCProgressTimerTypeBar)
  219. progressTimer:setPercentage(0)
  220. progressTimer:setMidpoint(ccp(0,0))
  221. progressTimer:setBarChangeRate(ccp(1,0))
  222. progressTimer:setPosition(ccp(bg:getContentSize().width/2,bg:getContentSize().height/2))
  223. bg:addChild(progressTimer,140)
  224. return bg
  225. end
  226.  
  227.  
  228. function UpdateScene:progressTimerAction( progressTimer,fromPercentage,toPercentage,duration )
  229. if not duration then duration = 0.3 end
  230. local ac = CCProgressFromTo:create(duration,toPercentage)
  231. progressTimer:runAction(ac)
  232. end
  233.  
  234.  
  235. function UpdateScene:delAllFilesInDirectory( path )
  236. for file in lfs.dir(path) do
  237. if file ~= "." and file ~= ".." then
  238. local f = path..'/'..file
  239. local attr = lfs.attributes (f)
  240. assert (type(attr) == "table")
  241. if attr.mode == "directory" then
  242. self:delAllFilesInDirectory (f)
  243. else
  244. os.remove(f)
  245. end
  246. end
  247. end
  248. end
  249.  
  250.  
  251. string.startWith = function(str,strStart)
  252. local a,_ = string.find(str,strStart)
  253. return a==1
  254. end
  255.  
  256.  
  257. string.split = function(s,p)
  258. local rt= {}
  259. string.gsub(s,'[^'..p..']+',function(w) table.insert(rt,w) end )
  260. return rt
  261. end
  262.  
  263.  
  264. return 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 则返回以下格式接口:

  1. {"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为如下代码

  1. function __G__TRACKBACK__(errorMessage)
  2. print("----------------------------------------")
  3. print("LUA ERROR: " .. tostring(errorMessage) .. "\n")
  4. print(debug.traceback("",2))
  5. print("----------------------------------------")
  6. end
  7.  
  8. local writablePath = CCFileUtils:sharedFileUtils():getWritablePath()
  9.  
  10. CCFileUtils:sharedFileUtils():addSearchPath(writablePath.."kdfs/".."res/")
  11. CCFileUtils:sharedFileUtils():addSearchPath(writablePath.."kdfs/".."scripts/")
  12. CCFileUtils:sharedFileUtils():addSearchPath("res/")
  13. CCFileUtils:sharedFileUtils():addSearchPath("scripts/")
  14.  
  15. CCLuaLoadChunksFromZIP("framework_precompiled.zip")
  16. CCLuaLoadChunksFromZIP("update.zip")
  17.  
  18. xpcall(function()
  19. CCDirector:sharedDirector():runWithScene(require("UpdateScene").new())
  20. 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"
"$APP_ROOT"
rm -rf *.zip
"开始编译代码"
sh Quick目录 /bin/compile_scripts .sh -i 游戏目录 /scripts -o game.zip #编译游戏代码
/update -o update.zip #编译自更新代码
if [ -d "$DIR" /res ]; then
-rf /res/ * #把当前目录下的res目录清空
fi
then
/scripts/ #把当前目录下的res目录清空
fi
chmod 777 /scripts
/res
"- copy scripts"
cp -rf -p game.zip /scripts #把编译好的game.zip复制到scripts目录下
-rf -p update.zip /.. /res/update .zip #把编译好的update.zip 放到游戏目录下的res目录下
/res #把编译好的update.zip放到当前目录的res目录下
"- copy resources"
-rf -p "$APP_ROOT" /res "$DIR" / #把游戏目录下的res目录所有的内容复制到当前目录下的res目录
find . - type f -mtime +15000 - exec rm -rf {} \; #实现增量更新的关键,代码含义为 删掉当前res目录下 文件修改日期为 多少天或者多少时或多少秒 之前的文件
-name ".DS_Store" | xargs -Rf #清除一些冗余文件,可不要
"打包res和scripts"
zip -r kdfs.zip res/* scripts/* #将当前版本的增量更新的res资源和代码game.zip 打包成一个文件
kdfs.zip kdfs$1.zip #根据接受的参数重新命名本次更新文件
@H_301_450@ "开始上传"
scp kdfs$1.zip root@服务器ip: /root/kdfs_server/web-server/public/versionFile/ #通过scp上传到服务器
"上传结束"


关于回滚代码的需求,打个比方你现在版本为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的时候的了。

猜你在找的Cocos2d-x相关文章