cocos2dx spine之一 ：spine缓存 (c++ & lua)

cocos2dx版本为3.10

1.在使用spine的过程中，发现了一个比较严重的问题：每次创建SkeletonAnimation的时候都会很卡，即使是使用同一个骨骼数据skeletonData。
跟踪代码发现，在每次调用函数spine::SkeletonAnimation::createWithFile (const std::string& skeletonDataFile, const std::string& atlasFile, float scale = 1);的时候都需要重新解析一次skeletonDataFile产生骨骼数据skeletonData。

2.问题找到了，那要想个最简单的解决办法，就是将骨骼数据skeletonData缓存起来，需要的时候再取出来使用。

3.直接修改SkeletonAnimation的源码
①在头文件SkeletonAnimation.h中增加对应函数以及成员变量

public:
//从缓存中创建Animation
static SkeletonAnimation* createFromCache(const std::string& skeletonDataKeyName);

//将文件读入到cache中(skeletonDataKeyName参数为自定义的骨骼数据名称)
static spSkeletonData* readSkeletonDataToCache(const std::string& skeletonDataKeyName, const std::string& skeletonDataFile, const std::string& atlasFile, float scale = 1);

//从cache中得到skeletonData(skeletonDataKeyName参数为自定义的骨骼数据名称)
static spSkeletonData* getSkeletonDataFromCache(const std::string& skeletonDataKeyName);

//从cache中删除skeletonData(skeletonDataKeyName参数为自定义的骨骼数据名称)
static bool removeSkeletonData(const std::string& skeletonDataKeyName);

//清理所有skeletonData
static void removeAllSkeletonData();

//是否在cache中存在对应的骨骼数据skeletonData
static bool isExistSkeletonDataInCache(const std::string& skeletonDataKeyName);
private:
struct SkeletonDataInCache{
spSkeletonData* _skeleton_data; //记录骨骼数据
spAtlas* _atlas; //记录对应图片块信息
};
typedef std::map<std::string, SkeletonDataInCache>::iterator ItSkeletonData;
static std::map<std::string, SkeletonDataInCache> _all_skeleton_data_cache; //记录所有的skeletonData缓冲区

②在源文件SkeletonAnimation.cpp中增加对应函数实现以及初始化静态成员变量

SkeletonAnimation* SkeletonAnimation::createFromCache(const std::string& skeletonDataKeyName)
{
if (spSkeletonData* skeleton_data = getSkeletonDataFromCache(skeletonDataKeyName)){
SkeletonAnimation* node = new SkeletonAnimation(skeleton_data, false);
node->autorelease();
return node;
}

return nullptr;
}

spSkeletonData* SkeletonAnimation::readSkeletonDataToCache(const std::string& skeletonDataKeyName, const std::string& skeletonDataFile, const std::string& atlasFile, float scale /*= 1*/)
{
ItSkeletonData it = _all_skeleton_data_cache.find(skeletonDataKeyName);

if (it == _all_skeleton_data_cache.end()){
SkeletonDataInCache skeleton_data_in_cache;
skeleton_data_in_cache._atlas = nullptr;
skeleton_data_in_cache._skeleton_data = nullptr;

skeleton_data_in_cache._atlas = spAtlas_createFromFile(atlasFile.c_str(), 0);
CCASSERT(skeleton_data_in_cache._atlas, "readSkeletonDataToCachereading Error  atlas file.");

spSkeletonJson* json = spSkeletonJson_create(skeleton_data_in_cache._atlas);
json->scale = scale;
skeleton_data_in_cache._skeleton_data = spSkeletonJson_readSkeletonDataFile(json, skeletonDataFile.c_str());
CCASSERT(skeleton_data_in_cache._skeleton_data, json->error ? json->error : "readSkeletonDataToCache Error reading skeleton data file.");
spSkeletonJson_dispose(json);

if (skeleton_data_in_cache._atlas && skeleton_data_in_cache._skeleton_data){
_all_skeleton_data_cache[skeletonDataKeyName] = skeleton_data_in_cache;

return skeleton_data_in_cache._skeleton_data;
}
else{ //错误处理，释放创建的资源
if (skeleton_data_in_cache._skeleton_data){
spSkeletonData_dispose(skeleton_data_in_cache._skeleton_data);
}

if (skeleton_data_in_cache._atlas){
spAtlas_dispose(skeleton_data_in_cache._atlas);
}
}
}

return nullptr;
}

spSkeletonData* SkeletonAnimation::getSkeletonDataFromCache(const std::string& skeletonDataKeyName)
{
ItSkeletonData it = _all_skeleton_data_cache.find(skeletonDataKeyName);
if (it != _all_skeleton_data_cache.end()){
return it->second._skeleton_data;
}

return nullptr;
}

bool SkeletonAnimation::removeSkeletonData(const std::string& skeletonDataKeyName)
{
ItSkeletonData it = _all_skeleton_data_cache.find(skeletonDataKeyName);
if (it != _all_skeleton_data_cache.end()){
if (it->second._skeleton_data) spSkeletonData_dispose(it->second._skeleton_data);
if (it->second._atlas) spAtlas_dispose(it->second._atlas);

_all_skeleton_data_cache.erase(it);
return true;
}

return false;
}

void SkeletonAnimation::removeAllSkeletonData()
{
for (ItSkeletonData it = _all_skeleton_data_cache.begin(); it != _all_skeleton_data_cache.end(); ++it){
if (it->second._skeleton_data) spSkeletonData_dispose(it->second._skeleton_data);
if (it->second._atlas) spAtlas_dispose(it->second._atlas);
}

_all_skeleton_data_cache.clear();
}

bool SkeletonAnimation::isExistSkeletonDataInCache(const std::string& skeletonDataKeyName)
{
ItSkeletonData it = _all_skeleton_data_cache.find(skeletonDataKeyName);
if (it != _all_skeleton_data_cache.end()){
return true;
}

return false;
}

std::map<std::string, SkeletonAnimation::SkeletonDataInCache> SkeletonAnimation::_all_skeleton_data_cache; //初始化静态成员

4.好了，重新编译libcocos2d后，下面为c++的使用方式。
①在需要使用的地方调用对应的接口进行创建

//判断是否存在自定义名称为GirlSkeletonDataKey的骨骼数据
spSkeletonData* skeleton_data = spine::SkeletonAnimation::getSkeletonDataFromCache("GirlSkeletonDataKey");

//如果不存在对应的骨骼数据，则读入解析一遍
if (!skeleton_data){
skeleton_data = spine::SkeletonAnimation::readSkeletonDataToCache("GirlSkeletonDataKey", "girl.json", "girl.atlas");
}

if (skeleton_data){
//直接使用骨骼数据创建动画
spine::SkeletonAnimation* skeleton_animation = SkeletonAnimation::createWithData(skeleton_data);

//也可以使用这个接口，效果和createWithData一样
//spine::SkeletonAnimation* skeleton_animation = SkeletonAnimation::createFromCache("GirlSkeletonDataKey");
}

②在需要释放数据的地方调用这个接口释放所有的骨骼数据缓存数据

spine::SkeletonAnimation::removeAllSkeletonData();

5.lua使用方式
①直接进入cocos2d-x-3.10\tools\tolua，运行genbindings.py来重新生成c++和lua之间的绑定文件
②重新编译libluacocos2d
③下面为lua的使用方式

--由于lua中没有绑定spSkeletonData，所以readSkeletonDataToCache的函数返回值无效（getSkeletonDataFromCache函数也一样），不能对返回值进行判断！
if not sp.SkeletonAnimation:isExistSkeletonDataInCache("GirlSkeletonDataKey") then
sp.SkeletonAnimation:readSkeletonDataToCache("GirlSkeletonDataKey", "girl.json", "girl.atlas");
end
--由于cocos2dx_spine.ini中没对SkeletonAnimation::createWithData函数进行绑定，所以这个函数在lua中不能使用
local skeleton_animation = sp.SkeletonAnimation:createFromCache("GirlSkeletonDataKey");

以上，完。