Cocos内存管理源码解析

前段时间在捕鱼的地方使用对象池的时候，因为对cocos里面的autorelease机制不熟悉，导致了内存的泄露，特写次文章记录一下。

在cocos2dx-3.8中的自动内存管理机制是借助引用计数来实现的。对于老版本的cocos引用计数使用的是CCObject，但是这个类在后面就被弃用了，使用Ref来代替，cocos内几乎所有的类都是继承自Ref。

Ref基本的原理就是其内部存在一个引用计数_referenceCount，当这个引用计数为0的时候，就会被释放。引用计数通过retain，release来操作。

Ref从创建到销毁的过程

我就简单的往屏幕中添加一个Label来测试Ref的创建和销毁，首先创建一个Label

auto label = Label::create();
label->setString("KaMi");
addChild(label)

以上代码就是简单的在屏幕中添加一个label，让我们看看create干了什么

Label* Label::create(){
    auto ret = new (std::nothrow) Label();
    if (ret){
        ret->autorelease();
    }
    return ret;
}

create函数是一个工厂方法，cocos中很多类都实现了这个方法，其中可以看到ret->autorelease();，这个函数就是把当前对象加入到自动释放池内，对于自动释放池下面会详细讲解。
（注：Ref初始化的时候引用计数为1不是0）

接下来看一下addChild(label)里面，这个方法是属于Node的，里面跳转的代码有些长，我就截取了一小部分。

void Node::addChild(Node *child){
    CCASSERT( child != nullptr, "Argument must be non-nil");
    this->addChild(child, child->_localZOrder, child->_name);
}

void Node::addChild(Node* child, int localZOrder, const std::string &name){
    ...
    addChildHelper(child, localZOrder, INVALID_TAG, name, false);
}

void Node::addChildHelper(Node* child, int localZOrder, int tag, const std::string &name, bool setTag){
    ...
    this->insertChild(child, localZOrder);
    ...
}

void Node::insertChild(Node* child, int z){
    _transformUpdated = true;
    _reorderChildDirty = true;
    _children.pushBack(child);
    child->_localZOrder = z;
}

最终跳转到了insertChild中，通过_children.pushBack(child)把label加入到_children中去。那么问题来了，到底在哪里对引用计数+1操作了呢？答案就在pushBack中，_children是cocos为Ref量身定制的向量Vector<T>，这个向量只能给继承了Ref的类来使用。

void pushBack(T object){
    ...
    _data.push_back( object );
    object->retain();
}

代码中可以看到object->retain()，对添加进来的对象引用+1操作。那么什么时候-1呢？

当我们场景移除的时候，应该是要释放在场景中的label的。Node被移除时会调用当前Node的父亲的removeChild函数，此函数最后会调用Node的cleanup函数，cleanup函数是递归函数，会遍历所有的子节点。当cleanup完之后会从父节点的_children这个向量中删除，此时就会调用release函数。

//当某个儿子节点cleanup完之后会调用_children.earse(childIndex)
iterator erase(ssize_t index){
    ...
    auto it = std::next( begin(), index );
    (*it)->release();
    return _data.erase(it);
}

release函数就是对当前实例的引用计数-1，如果-1后为0那么释放内存。

void Ref::release(){
    ...
    --_referenceCount;

    if (_referenceCount == 0){
        ...
        delete this;
    }
}

自动释放池

Ref中有autorelease函数，咋一看感觉内存不需要我来管了，他会自动释放。然而这个自动和我脑子里想的自动相差一个孙悟空的跟头，毕竟是c++不是java。先看看autorelease的源码

Ref* Ref::autorelease()
{
    PoolManager::getInstance()->getCurrentPool()->addObject(this);
    return this;
}

代码很短，autorelease并没有release，而是把对象加入到了对象池中。那么这个对象池是什么时候去release里面的对象的呢？接下来就要看Director的mainLoop函数了，这个函数在Director中没有实现，是在DisplayLinkDirector中实现的。

void DisplayLinkDirector::mainLoop(){
    if (_purgeDirectorInNextLoop){
        ...
    }
    else if (_restartDirectorInNextLoop){
        ...
    }
    else if (! _invalid){
        drawScene();
     
        // release the objects
        PoolManager::getInstance()->getCurrentPool()->clear();
    }
}

mainLoop是每一帧调用的函数。我们发现cocos在每一帧结束绘制drawScene之后都会调用PoolManager::getInstance()->getCurrentPool()->clear();的操作。接下去看看clean的实现细节

void AutoreleasePool::clear()
{
#if defined(COCOS2D_DEBUG) && (COCOS2D_DEBUG > 0)
    _isClearing = true;
#endif
    std::vector<Ref*> releasings;
    releasings.swap(_managedObjectArray);
    for (const auto &obj : releasings)
    {
        obj->release();
    }
#if defined(COCOS2D_DEBUG) && (COCOS2D_DEBUG > 0)
    _isClearing = false;
#endif
}

我们发现，在clean里面对所有在_managedObjectArray中的对象都进行了一次release操作，并把它从_managedObjectArray中删除掉。_managedObjectArray是什么，查看前一段代码中addObject的实现细节就知道，autorelease就是把当前对象加入到_managedObjectArray中。

也就是说，我们创建的Label的时候引用计数为1，然后调用autorelease添加到_managedObjectArray中，之后又被addChild到屏幕中，此时引用计数为2。当一帧绘制结束的时候会系统会调用释放池的clear函数，此函数会遍历所有在自动释放池内的对象并release，最后从对象池中删除之（所以第二帧结束后不会被再次调用release了），此时引用计数为1。当我们把当前场景移除的时候会调用release把引用计数减少至0，并从内存中释放。

以上就是cocos的的自动内存管理机制