cocos2d-x使用AssetsManager类实现资源的在线更新

从2.1.2版本开始，2dx在libExtensions下添加了一个AssetsManager类用于资源的在线更新和简单的版本管理，同时添加了AssetsManagerTest项目示范了AssetsManager类的用法。

运行AssetsManagerTest，可以看到菜单界面

点击enter，看到下面的画面

重新运行程序，点击update，可以看到后台的log

然后再点击enter，发现画面已经发生改变

重新运行程序，画面一直都是新的。
重新运行程序，点击reset，再点击enter，发现画面回到了旧画面


代码分析
程序创建了一个UpdateLayer，上面有三个menuitem，这个不用多说
当点击update时，程序调用getAssetsManager() 获取AssetsManager 的实例，在getAssetsManager() 中应用了单例的模式，如果没有创建pAssetsManager 则new一个，第一个参数是更新包地址，第二个参数是版本文件地址，第三个参数是本地存储路径

1. void UpdateLayer::update(cocos2d::CCObject *pSender)
2. {
3.     // update resources
4.     getAssetsManager()->update();
5.     
6.     isUpdateItemClicked = true;
7. }
8. AssetsManager* UpdateLayer::getAssetsManager()
9. {
10.     static AssetsManager *pAssetsManager = NULL;
11.     
12.     if (! pAssetsManager)
13.     {
14.         pAssetsManager = new AssetsManager("https://raw.github.com/minggo/AssetsManagerTest/master/package.zip", //资源更新包地址
15.                                            "https://raw.github.com/minggo/AssetsManagerTest/master/version", //版本文件地址
16.                                            pathToSave.c_str()); //本地存储地址，见 createDownloadedDir()
17.     }
18.     
19.     return pAssetsManager;
20. }

复制代码

获得实例后，调用 update() 方法

1. void AssetsManager::update()
2. {
3.     // 1. Urls of package and version should be valid;
4.     // 2. Package should be a zip file.
5.     if (_versionFileUrl.size() == 0 ||
6.         _packageUrl.size() == 0 ||
7.         std::string::npos == _packageUrl.find(".zip"))
8.     {
9.         CCLOG("no version file url, or no package url, or the package is not a zip file");
10.         return;
11.     }
12.     
13.     // Check if there is a new version.
14.     if (! checkUpdate()) return; //检查是否需要更新
15.     
16.     // Is package already downloaded?
17.     string downloadedVersion = CCUserDefault::sharedUserDefault()->getStringForKey(KEY_OF_DOWNLOADED_VERSION);
18.     if (downloadedVersion != _version)
19.     {
20.         if (! downLoad()) return; //下载
21.         
22.         // Record downloaded version.
23.         CCUserDefault::sharedUserDefault()->setStringForKey(KEY_OF_DOWNLOADED_VERSION, _version.c_str());
24.         CCUserDefault::sharedUserDefault()->flush();
25.     }
26.     
27.     // Uncompress zip file.
28.     if (! uncompress()) return; //解压缩
29.     
30.     // Record new version code.
31.     CCUserDefault::sharedUserDefault()->setStringForKey(KEY_OF_VERSION, _version.c_str()); //更新本地版本号
32.     
33.     // Unrecord downloaded version code.
34.     CCUserDefault::sharedUserDefault()->setStringForKey(KEY_OF_DOWNLOADED_VERSION, "");
35.     
36.     CCUserDefault::sharedUserDefault()->flush();
37.     
38.     // Set resource search path.
39.     setSearchPath(); //更新资源搜索路径列表
40.     
41.     // Delete unloaded zip file.
42.     string zipfileName = _storagePath + TEMP_PACKAGE_FILE_NAME;
43.     if (remove(zipfileName.c_str()) != 0)
44.     {
45.         CCLOG("can not remove downloaded zip file");
46.     }
47. }

复制代码

update() 方法执行过程中，调用checkUpdate() 方法检查是否需要下载更新包

1. bool AssetsManager::checkUpdate()
2. {
3.     if (_versionFileUrl.size() == 0) return false;
4.     
5.     _curl = curl_easy_init();
6.     if (! _curl)
7.     {
8.         CCLOG("can not init curl");
9.         return false;
10.     }
11.     
12.     // Clear _version before assign new value.
13.     _version.clear();
14.     
15.     CURLcode res;
16.     curl_easy_setopt(_curl, CURLOPT_URL, _versionFileUrl.c_str());
17.     curl_easy_setopt(_curl, CURLOPT_SSL_VERIFYPEER, 0L);
18.     curl_easy_setopt(_curl, CURLOPT_WRITEFUNCTION, getVersionCode);
19.     curl_easy_setopt(_curl, CURLOPT_WRITEDATA, &_version);
20.     res = curl_easy_perform(_curl);
21.     
22.     if (res != 0)
23.     {
24.         CCLOG("can not get version file content, error code is %d", res);
25.         curl_easy_cleanup(_curl);
26.         return false;
27.     }
28.     
29.     string recordedVersion = CCUserDefault::sharedUserDefault()->getStringForKey(KEY_OF_VERSION);
30.     if (recordedVersion == _version) //判断版本是否与本地版本相同，如果相同则更新搜索路径列表，并返回不需要更新
31.     {
32.         CCLOG("there is not new version");
33.         // Set resource search path.
34.         setSearchPath(); //更新列表
35.         return false;
36.     }
37.     
38.     CCLOG("there is a new version: %s", _version.c_str());
39.     
40.     return true;
41. }

复制代码

检查的方法就是以指定的路径向服务器请求版本文件，然后比较内容是否与本地记录的版本（CCUserDefault::sharedUserDefault()->getStringForKey(KEY_OF_VERSION);）一致，一致则结束，不一致则返回需要更新，然后调用downLoad() 来下载，下载的过程中会回调 progressFunc 来反馈进度，下载的过程应该是同步的阻塞模式（我没仔细跟进去分析，从代码的写法上猜测的），也就是下载过程中不能做其他操作。下载完成后，调用 uncompress() 解压缩到指定的路径。然后更新本地版本号为新版本号，并写文件（CCUserDefault::sharedUserDefault()->flush();）。最后调用setSearchPath() 将存储路径添加到搜索路径列表中去。

1. void AssetsManager::setSearchPath()
2. {
3.     vector<string> searchPaths = CCFileUtils::sharedFileUtils()->getSearchPaths(); //获得当前列表
4.     vector<string>::iterator iter = searchPaths.begin(); //获取列表的头
5.     searchPaths.insert(iter, _storagePath); //添加，添加后，新添加的路径在前
6.     CCFileUtils::sharedFileUtils()->setSearchPaths(searchPaths); //回写
7. }

复制代码

2.1.2版本引擎对CCFileUtils 进行了重构，所谓的资源搜索路径列表就是指一个存有多个路径的序列，在搜索某个文件时，按照列表的顺序遍历（使用迭代器），依次测试文件是否存在，直到发现文件。如果列表以某种顺序组织，比如按版本号的降序排列，即先搜索新版本，后搜索旧版本，从而可以实现新版本资源替换旧版本资源的功能。

点击reset，删除已下载的文件

1. void UpdateLayer::reset(cocos2d::CCObject *pSender)
2. {
3.     // Remove downloaded files
4. #if (CC_TARGET_PLATFORM != CC_PLATFORM_WIN32)
5.     string command = "rm -r ";
6.     // Path may include space.
7.     command += """ + pathToSave + """;
8.     system(command.c_str());
9. #else
10.     string command = "rd /s /q ";
11.     // Path may include space.
12.     command += """ + pathToSave + """;
13.     system(command.c_str());
14. #endif
15.     // Delete recorded version codes.
16.     getAssetsManager()->deleteVersion();
17.     
18.     createDownloadedDir();
19. }

复制代码

点击enter，需要注意有一个判断是否点击过的update的判断，如果没有点击过则需要将新的路径手工添加到搜索列表中去，如果点击过则路径已经自动添加过了

1. void UpdateLayer::enter(cocos2d::CCObject *pSender)
2. {
3.     // Should set search resource path before running script if "update" is not clicked.
4.     // Because AssetsManager will set 
5.     if (! isUpdateItemClicked) //判断是否需要手工添加搜索路径
6.     {
7.         vector<string> searchPaths = CCFileUtils::sharedFileUtils()->getSearchPaths();
8.         searchPaths.insert(searchPaths.begin(), pathToSave);
9.         CCFileUtils::sharedFileUtils()->setSearchPaths(searchPaths);
10.     }
11.     
12.     CCScriptEngineProtocol *pEngine = ScriptingCore::getInstance();
13.     CCScriptEngineManager::sharedManager()->setScriptEngine(pEngine);
14.     ScriptingCore::getInstance()->runScript("main.js");
15. }

复制代码

总结
1、AssetsManager类 提供了一个很方便的更新资源的官方途径，这对手游特别是手机网游来说是一个很利好的消息，毕竟能够更新资源而不需要更新应用本身是可以减少用户流失的
2、版本管理的功能还较弱，目前的功能只能记录一个版本，即最新版本，如果能够多版本（更新历史） 管理的话，会更方便
3、应用启动后，搜索路径还需要手工添加，应该做成与版本关联的方式，根据本地的版本记录来自动的添加