cocos2d-js热更新
1. 热更新基本思路
得到cocoachina论坛上fysp和akira_cn的帮助,理清了游戏热更新的思路:
- 执行AssetsManager后,搜索路径增加了jsb.fileUtils.getWritablePath()目录,并且是优先搜索;
- 需要热更新js不放在project.json中定义,等AssetsManager更新完了,用cc.loader.load动态加载;
- 所以在jsb.fileUtils.getWritablePath()目录下载的资源和js文件,与项目目录保持一致,那么优先加载新下载的资源和js文件,再进入游戏,从而实现热更新。
2. AssetsManager
cocos2d-js 3.0 rc0对AssetsManager功能进行了完善增强,支持多线程下载、断点续传、文件压缩、更好的进度信息以及错误重试机制,实现游戏资源文件和脚本文件的热更新变的更加方便。 用cocos new MyGame -l js -d /directory/to/project
方式新建一个测试项目,参考sample写的src/AssetsManager.js:
var __failCount = 0;
var AssetsManagerLoaderScene = cc.Scene.extend({
_am:null,_progress0,_percentByFilerun:function(){
if (!cc.sys.isNative) {
this.loadGame();
return;
}
var layer = new cc.Layer();
this.addChild(layer);
this._progress cc.LabelTTF.create("0%","Arial",12);
this._progress.x = cc.winSize.width / 2;
y height / 2 + 50;
layer.addChild(this._progress);
// android: /data/data/com.huanle.magic/files/
var storagePath = (jsb.fileUtils ? jsb.fileUtils.getWritablePath() : "./");
this._am jsb.AssetsManager("res/project.manifest",storagePath);
this._am.retain();
!this._am.getLocalManifest().isLoaded())
{
cc.log("Fail to update assets,step skipped.");
this.loadGame();
}
else
{
var that = this;
var listener cc.EventListenerAssetsManager(this._am,function(event) {
switch (event.getEventCode()){
case cc.EventAssetsManager.ERROR_NO_LOCAL_MANIFEST:
cc"No local manifest file found,skip assets update.");
that.loadGame();
break;
case cc.EventAssetsManager.UPDATE_PROGRESSION:
that._percent event.getPercent();
that._percentByFile event.getPercentByFile();
cc.log(that._percent + "%");
var msg event.getMessage();
if (msg) {
cc.log(msg);
}
case cc.EventAssetsManager.ERROR_DOWNLOAD_MANIFEST:
case cc.EventAssetsManager.ERROR_PARSE_MANIFEST"Fail to download manifest file,update skipped.");
that.loadGame();
case cc.EventAssetsManager.ALREADY_UP_TO_DATEcase cc.EventAssetsManager.UPDATE_FINISHED"Update finished.");
that.loadGame();
case cc.EventAssetsManager.UPDATE_Failed"Update Failed. " event.getMessage());
__failCount ++;
if (__failCount < 5)
{
that._am.downloadFailedAssets();
}
else
{
cc"Reach maximum fail count,exit update process");
__failCount 0;
that.loadGame();
}
case cc.EventAssetsManager.ERROR_UPDATING"Asset update error: " event.getAssetId() "," event.getMessage());
that.loadGame();
case cc.EventAssetsManager.ERROR_DECOMPRESS.log(default:
break;
}
});
cc.eventManager.addListener(listener,179)">1);
this._am.update();
cc.director.runScene(this);
}
this.schedule(this.updateProgress,179)">0.5);
},163)">loadGame:function(){
cc.loader.loadJs(["src/files.js"],93)">function(err){
cc.loader.loadJs(jsFiles,93)">function(err){
cc.director.runScene(HelloWorldScene());
});
});
},163)">updateProgress:function(dt){
this._progress.string = "" + this._percent;
},163)">onExit:function(){
cc"AssetsManager::onExit");
this._am.release();
this._super();
}
});
修改项目目录下的main.js:
修改项目目录下的project.json:
就留一个AssetsManager.js,其他的js都通过它来加载。
增加一个src/files.js,需要动态加载的js文件都写在jsFiles这个数组里,这样js文件有增加变化,这个files.js一并更新,方便动态加载:
项目res目录增加一个project.manifest文件,AssetsManager.js里会用到:
这里主要配置服务端资源下载地址,具体字段说明,在下面服务端配置里说明。然后用cocos compile -p android
编译打包成一个apk安装包,等配置好服务端更新资源安装测试。
3. 服务端配置
需要建一个WEB服务器做下载用,在其WEB目录http://10.0.128.219/res
(我的测试机),增加version.manifest文件:
测试发现,AssetsManager首先会下载version.manifest文件,如果有更新的版本,那么才会去下载project.manifest,然后下载其中描述的资源文件。
project.manifest如下:
由于客户端本地project.manifest里groupVersions的版本信息比服务器端的低,所以AssetsManager会下载http://10.0.128.219/res/src/app.zip
到手机的/data/data/org.cocos2dx.hellojavascript/files/src/app.zip
,并且会自动解压,但不会删除压缩包本身。
建议用root过的android手机测试,否则/data/data是没有权限查看。运行客户端测试程序后用adb连接查看:
用firefox调试连上手机,发现app.js资源地址是/data/data/org.cocos2dx.hellojavascript/files/src/app.js,而不是assets/src/app.js,实现了热更新:
4. 增量更新
修改服务端version.manifest:这时在android客户端测试,已经更新到update1的,只会下载update2的更新,而没有更新过的,会把update1和update2都下载下来。