cocos2dx[3.2](22)——三种缓存类

【唠叨】

    Cocos引擎主要有三种缓存类：

        > 纹理缓存     ： TextureCache

        > 精灵帧缓存 ： SpriteFrameCache

        > 动画缓存     ： AnimationCache

    缓存的目的就是：先将所需资源（如纹理图片）加载到内存中，之后再次使用该资源的时候，就可以直接从内存中取出，而不需要重新加载。从而减少了CPU和GPU的内存占用。

    本文对参考文献的内容进行了整理与整合，并加入一些自己的观点。

【致谢】

    http://www.cocoachina.com/bbs/read.php?tid-200714.html （纹理缓存TextureCache）

    http://www.cocoachina.com/bbs/read.php?tid-200359.html （精灵帧缓存SpriteFrameCache）

    http://www.cocoachina.com/bbs/read.php?tid-201628.html （动画缓存AnimationCache）

    http://blog.csdn.net/star530/article/details/23612487 （三种缓存类介绍）

【TextureCache】

1、概述

    在游戏中需要加载大量的纹理图片，这些操作都是很耗内存和资源的。

    当游戏中有个界面用到的图片非常多，第一次点进这界面时速度非常慢（因为要加载绘制很多图片）出现卡顿，我们可以使用TextureCache提前异步加载纹理，等加载结束，进入到这个界面再使用这些图片速度就会非常快。

    > Texture2D（纹理）                ：即图片加载入内存后供CPU和GPU操作的贴图对象。  

    > TextureCache（纹理缓存）：用于加载和管理纹理。一旦纹理加载完成，下次使用时可使用它返回之前加载的纹理，从而减少对GPU和CPU内存的占用。

    当你创建一个精灵Sprite，你一般会使用Sprite::create(fileName)。假如你去看Sprite::create(fileName)的实现方式，你将看到它将这个图片增加到纹理缓存中去了。

//
	Sprite* Sprite::create(const std::string& filename)
	{
		Sprite *sprite = new Sprite();
		if (sprite && sprite->initWithFile(filename))
		{
			sprite->autorelease();
			return sprite;
		}
		_SAFE_DELETE(sprite);
		return nullptr;
	}
	bool Sprite::initWithFile(const std::string& filename)
	{
		ASSERT(filename.size()>0, "Invalid filename for sprite");
		// 加载filename的纹理图片
		Texture2D *texture = Director::getInstance()->getTextureCache()->addImage(filename);
		if (texture)
		{
			Rect rect = Rect::ZERO;
			rect.size = texture->getContentSize();
			return initWithTexture(texture, rect);
		}
		return false;
	}
//

2、获取TextureCache

    在3.x版本中，TextureCache不再作为单例模式使用。而是作为Director的成员变量，通过以下方式获取。

//
	// 获取纹理缓存类 TextureCache
	Director::getInstance()->getTextureCache();
//

3、纹理的加载与获取

    如果文件名以前没有被加载时，它会创建一个新的 Texture2D 对象，它会返回它。它将使用文件名作为key否则，它会返回一个引用先前加载的图像。

    > addImage             ：函数会返回一个纹理Texture2D的引用，可能是新加载到内存的，也可能是之前已经存在的。

    > getTextureForKey ：获得这个key所对应的纹理缓存，若这个Key对应的纹理不存在，那么就返回nullptr。

    > 支持的图片格式有： .png，.bmp，.tiff， .jpeg， .pvr 。

//
	// addImage 加载纹理图片
	// 支持图片格式: .png, .bmp, .tiff, .jpeg, .pvr
	Texture2D *texture = Director::getInstance()->getTextureCache()->addImage(filename);
	
	// getTextureForKey 获取纹理图片
	Texture2D *texture = Director::getInstance()->getTextureCache()->getTextureForKey(textureKeyName);
//

4、异步加载纹理

    TextureCache类还支持异步加载资源的功能，利用 addImageAsync 方法。你可以很方面地给addImageAsync方法添加一个回调方法，这样，当纹理异步加载结束的时候，可以得到通知。

    > 支持的图片格式有：.png， .jpg 。

    你可以选择异步加载方式，这样你就可以为loading场景增加一个进度条。

    关键代码如下：

//
	TextureCacheTest::TextureCacheTest()
	: _numberOfSprites(20)
	, _numberOfLoadedSprites(0)
	{
		auto size = Director::getInstance()->getWinSize();
		_labelLoading = Label::createWithTTF("loading...", "fonts/arial.ttf", 15);
		_labelPercent = Label::createWithTTF("%0", "fonts/arial.ttf", 15);
		_labelLoading->setPosition(Point(size.width / 2, size.height / 2 - 20));
		_labelPercent->setPosition(Point(size.width / 2, size.height / 2 + 20));
		this->addChild(_labelLoading);
		this->addChild(_labelPercent);
		
		// 异步加载纹理图片 addImageAsync
		// 加载完纹理后，会执行回调函数
		Director::getInstance()->getTextureCache()->addImageAsync("Images/HelloWorld.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
		Director::getInstance()->getTextureCache()->addImageAsync("Images/grossini.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
		Director::getInstance()->getTextureCache()->addImageAsync("Images/CloseNormal.png", CC_CALLBACK_1(TextureCacheTest::loadingCallBack, this));
		....
	}
	
	// 异步加载的回调函数
	void TextureCacheTest::loadingCallBack(cocos2d::Texture2D *texture)
	{
		++_numberOfLoadedSprites;
		
		char tmp[10];
		sprintf(tmp,"%%%d", (int)(((float)_numberOfLoadedSprites / _numberOfSprites) * 100));
		_labelPercent->setString(tmp);
		
		if (_numberOfLoadedSprites == _numberOfSprites)
		{
			this->removeChild(_labelLoading, true);
			this->removeChild(_labelPercent, true);
			addSprite();
		}
	}
//

5、清理缓存

//
	// 释放当前所有引用计数为1的纹理，即目前没有被使用的纹理。
	// 比如新场景创建好后，使用此方法释放没有使用的纹理非常方便。
	Director::getInstance()->getTextureCache()->removeUnusedTextures();

	// 通过给定的纹理贴图（texture）的关键名（key name）从缓存中删除该纹理贴图
	Director::getInstance()->getTextureCache()->removeTextureForKey("Images/grossinis.png");

	// 清除加载纹理贴图的记录，如果你收到“内存警告”，请调用该方法。 
	// 在短期内 : 会释放一些资源文件来防止你的app出现闪退现象 
	// 在中期内 : 会分配更多资源 
	// 长远来看 : 没有区别
	Director::getInstance()->getTextureCache()->removeAllTextures();
//

【SpriteFrameCache】

1、概述

    SpriteFrameCache 主要服务于多张碎图合并出来的纹理图片。这种纹理在一张大图中包含了多张小图，直接通过TextureCache引用会有诸多不便，因而衍生出来精灵框帧的处理方式，即把截取好的纹理信息保存在一个精灵框帧内，精灵通过切换不同的框帧来显示出不同的图案。

    SpriteFrameCache 内部封装了一个Map<std::string, SpriteFrame*> _spriteFrames对象。（其中key为帧的名称）

    SpriteFrameCache一般用来 处理 plist文件 （这个文件指定了每个独立的精灵在这张“大图”里面的位置和大小），该文件对应一张包含多个精灵的大图，plist文件可以使用TexturePacker制作。

    SpriteFrameCache的常用接口和TextureCache类似，不再赘述了，唯一需要注意的是添加精灵帧的配套文件一个plist文件和一张大的纹理图。

2、获取与销毁SpriteFrameCache

    SpriteFrameCache是一个单例对象，所以获取方法与Director一样。

//
	// 获取单例对象
	SpriteFrameCache* cache = SpriteFrameCache::getInstance(); 

	// 销毁单例对象
	SpriteFrameCache::destroyInstance();
//

3、精灵帧的加载与使用

     通过 addSpriteFramesWithFile 加载 plist文件，将plist文件中的多张小图加载到精灵帧缓存中。

//
	// boy.png 里集合了boy1.png,boy2.png这些小图。
	// 参数2 可不写
	SpriteFrameCache *frameCache = SpriteFrameCache::getInstance();	
	frameCache->addSpriteFramesWithFile("boy.plist", "boy.png");    

	//从SpriteFrameCache缓存中找到boy1.png这张图片.
	auto frame_sp = Sprite::createWithSpriteFrameName("boy1.png"); 
	this->addChild(frame_sp, 2);
//

4、清理缓存

//
    // 从精灵帧缓存中删除一个精灵帧.
    SpriteFrameCache::getInstance()->removeSpriteFrameByName(const std::string &name);
    
    // 清除载入精灵帧的字典。如果接收到“Memory Warning”, 请调用这个方法。
    // 就眼前来说 : 它将释放一些资源来阻止你的应用崩溃掉。
    // 中期的角度 : 它将分配更多的资源。
    // 从长远来说 : 它将变成相同的。
    SpriteFrameCache::getInstance()->removeSpriteFrames();
    
    // 从一个.plist文件移除多个精灵帧。即：存储在这个文件的精灵帧将被删除。
    // 当某个特定的纹理需要被删除时候调用这个方法很方便。
    SpriteFrameCache::getInstance()->removeSpriteFramesFromFile(const std::string &plist);
    
    // 移除与特定的纹理结合的所有的精灵帧。
    // 当某个特定的纹理需要被删除时候调用这个方法很方便。
    SpriteFrameCache::getInstance()->removeSpriteFramesFromTexture(cocos2d::Texture2D *texture);
    
    // 移除没用的精灵帧。保留数为1的精灵帧将被删除。
    // 在开始一个新的场景之后调用这个方法很方便。
    SpriteFrameCache::getInstance()->removeUnusedSpriteFrames();
//

5、SpriteFrameCache  VS.  TextureCache

    SpriteFrameCache精灵框帧缓存。顾名思义，这里缓存的是精灵帧SpriteFrame，它主要服务于多张碎图合并出来的纹理图片（plist文件）。这种纹理在一张大图中包含了多张小图，直接通过TextureCache引用会有诸多不便，因而衍生出来精灵框帧的处理方式，即把截取好的纹理信息保存在一个精灵框帧内，精灵通过切换不同的框帧来显示出不同的图案。

    跟TextureCache功能一样，将SpriteFrame缓存起来，在下次使用的时候直接去取。

    不过跟TextureCache不同的是：如果内存池中不存在要查找的图片，它会提示找不到，而不会去本地加载图片。

    > TextureCache时最底层也是最有效的纹理缓存，缓存的是加载到内存中的纹理资源，也就是图片资源。

    > SpriteFrameCache精灵框帧缓存，缓存的时精灵帧。

    > SpriteFrameCache是基于TextureCache上的封装。缓存的是精灵帧，是纹理指定区域的矩形块。各精灵帧都在同一纹理中，通过切换不同的框帧来显示出不同的图案。

【AnimationCache】

1、概述

    通常情况下，对于一个精灵动画，每次创建时都需要加载精灵帧，然后按顺序添加到数组，再用Animation读取数组创建动画。这是一个非常烦琐的计算过程。而对于使用频率高的动画，例如角色的走动、跳舞等，可以将其加入到AnimationCache中，每次使用都从这个缓存中调用，这样可以有效的降低创建动画的巨大消耗。

    所以将创建好的动画Animation直接放在动画缓存AnimationCache中，当需要执行动画动作时，就直接从动画缓存中拿出来，去创建初始化Animation会非常方便。

2、相关函数

    AnimationCache是一个单例对象，所以获取方法与Director一样。

    通过 AnimationCache::getInstance() 获取单例对象。

    其相关函数如下：

//
	// 添加一个动画到缓存，命名为name。
	// name - animation : 是一组 键-值对(key-value) 的关系。
	void addAnimation(Animation *animation, const std::string& name);

	// 添加动画的plist文件到缓存
	void addAnimationsWithFile(const std::string& plist);

	// 获得指定名称为name的动画
	Animation* getAnimation(const std::string& name);

	// 移除一个指定的动画 
	void removeAnimation(const std::string& name);
//

3、使用举例

//
//
    //动画命名为 Explosion，加入到动画缓存中
    Animation* animation = Animation::createWithSpriteFrames(arr, 0.04);
    AnimationCache::getInstance()->addAnimation(animation, "Explosion");

    //直接从动画缓存中取出 "Explosion" 动画
    Animation* animation = AnimationCache::getInstance()->getAnimation("Explosion");
//
//

【清理顺序】

    值得注意的是清理的顺序。

    我们推荐 清理顺序 如下：

        > 首先清理，动画缓存AnimationCache，

        > 然后清理，精灵帧缓存SpriteFrameCache，

        > 最后清理，纹理缓存TextureCache。

    按照引用层级由高到低，以保证释放引用有效。