cocos2d-x CCArray使用中避免出现野指针问题

Posted 2021-08-25 googlingman

 

问题及现象

　　

　　此前，调试cocos2d-x + CocoStudio游戏程序过程中遇到一个运行时错误。通过调用堆栈来看，错误指针停在~CCNodeRGBA()。

分析1

　　CCNodeRGBA是一个继承自CCNode的子类，其主要是增加了与结点透明度相关的属性控制功能。

　　

class CC_DLL CCNodeRGBA : public CCNode, public CCRGBAProtocol

　　　　CCNodeRGBA是CCSprite和Widget（即UIWidget）的直接父类。因此，出现错误对象应当与CCSprite和Widget对象及可能的子类对象有关。

分析2

    具体的错误堆栈内容我就不截图了。从栈中层次分析，最可能是析构结点过程（一级级的析构，这是C++的析构规则，由子到父到祖父再到...）的最后产生了上述错误，大致可以估计出现了内存崩溃。

分析3

　　既然问题初步定位在内存崩溃，那么很可能与指针使用相关。回想前段时间（及很早以前－－其实这部分代码很早前就有了）感觉系统运行正常－－当然是还在没有增加新近添加的功能之前。

　　那么，怎么尽快分析出BUG？代码近5000行！好在绝大部分都已经运行起来，于是我从测试实例入手（不敢直接使用缩小范围法：即由原来的200个模块缩小（主要是通过注释屏蔽的方法）到想测试的100个模块）。GOOD！在最简单的操作测试中，新增加功能正常！这给了我极大鼓励！

　　于是，我继续使用测试实例法，并且把新增加功能一个个测试（反复进行）。最终，范围逐渐定位在一个大致的实现算法上。

问题解决

　　问题出在：C++野指针问题！相关代码如下：

//此前有声明：Card* Cells[4]={NULL};
Cells[col]= (Card*)TableauPiles[whichColumnForCC]->lastObject();
Card* t2=Cells[col];
Cells[col]->setPosition(m_pCurNode->getChildByTag(10006+col)->getPosition());
m_pCurNode->reorderChild(Cells[col],++zIndexForAll);
Cells[col]->setPosition(m_pCurNode->getChildByTag(10006+col)->getPosition());
m_pCurNode->reorderChild(Cells[col],++zIndexForAll);
TableauPiles[whichColumnForCC]->removeLastObject();

　　问题出在第一句与最后一句。第一句的意义是指：把Cells[col]指针指向一个已经内存分配的Card对象所在位置。而最后一句，把这个对象对应内存释放掉了！于是Cells[col]指向的对象成了僵尸。

　　僵尸很可怕！我们大家都看过类似体裁的故事吧！我的游戏中，Cells[col]指针的精灵仍然可以在屏幕上移动，好像是正常的精灵一样！！！这也正是我直接使用以前的代码而现在迟迟没有发现的原因之一（当然，根本原因还与本人C++功能有密切关系）。

进一步分析

　　大家都知道CCArray这个数据类型很好使用，因为它继承自STL中现有结构，而且效率明确提高，特别是其提供了大量的简化数组操作的方法。但是，也有不足：在使用CCArray时，有关retain问题我就不再重复了－－网络上有的是。在普通的cocos2d-x编码中，使用了retain那么在最后就要调用相应的release；但是，当你配合使用CocoStudio　UI编辑器或者场景编辑器进行开发时就不需要（也不能够）调用release了。有关细节，Hanrea告诉我UI解析器在释放场景内容时自动处理了。当然，我还没有分析他们的源代码，所以只是这么结论了。当然，在我前段时间花费不少时间克服的问题也证明了这一点。

　　接下来，removeLastObject这个方法有一个bool类型参数，默认为true，即释放掉相应内存。源码如下：

void CCArray::removeLastObject(bool bReleaseObj)
{
    CCAssert(data->num, "no objects added");
    ccArrayRemoveObjectAtIndex(data, data->num-1, bReleaseObj);
}

　　再跟踪下去：

void ccArrayRemoveObjectAtIndex(ccArray *arr, unsigned int index, bool bReleaseObj/* = true*/)
{
    CCAssert(arr && arr->num > 0 && index < arr->num, "Invalid index. Out of bounds");
    if (bReleaseObj)
    {
        CC_SAFE_RELEASE(arr->arr[index]);
    }
    
    arr->num--;
    
    unsigned int remaining = arr->num - index;
    if(remaining>0)
    {
        memmove((void *)&arr->arr[index], (void *)&arr->arr[index+1], remaining * sizeof(CCObject*));
    }
}

　　注意上面第一个if语句，当参数为true时，把相应内存真正释放掉了。请参考我们上面的游戏代码。

　　最后，纠正一下错误，很简单，把上面最后一句修改如下即可：

TableauPiles[whichColumnForCC]->removeLastObject(false);

显然，传递参数false就是只在本数组中进行了下标调整（arr->num也比原来减小了1），并没有进行最后一个结点对应的内存释放。反而，最后一个数组结点对应内存被Cells[col]这个指针接收下了。于是，避免了一个野指针（僵尸）事件，一切自然OK！