Cocos2d-x3.0模版容器詳解：cocos2d::Vector

1.概述

版本：v3.0 beta

語言：C++

定義在 “COCOS2DX_ROOT/cocos/base” 路徑下的 "CCVector.h" 的頭文件中。

template<class T>class CC_DLL Vector;

cocos2d::Vector<T> 是一個封裝了動態大小的數組的順序型容器。

 

它的元素是連續存儲的，cocos2d::Vector<T> 的存儲是自動處理的。其內部的數據結構實現實際上是STL標準的順序型容器 std::vector。

 

在 Cocos2d-x v3.0 beta 之前，存在另一個順序性容器 cocos2d::CCArray，這將會被棄用。

 

我們很細緻地設計了 cocos2d::Vector<T> 容器作爲 cocos2d::CCArray 的替代品，所以請使用 cocos2d::Vector<T> 代替 cocos2d::CCArray。

 

cocos2d::Vector<T> 常用操作的複雜度（效率）如下：

隨機訪問 - 常量 0(1)

在末尾插入或者移除元素 - 分攤常量 0(1)

插入或移除元素 - cocos2d::Vector<T> 長度線性相關 O(n)

 

2.模版參數

 

T - 元素類型.

-T 必須是一個指向 cocos2d::Object 子類對象的指針。不能是其他數據類型或者原生類型，因爲我們已經將 Cocos2d-x 的內存管理模型集成到 cocos2d::Vector<T> 中（從 v3.0 beta 開始）。

 

3.內存管理

 

cocos2d::Vector<T> 類包含了唯一一個數據成員：

std::vector<T> _data;

_data 的內存管理是由編譯器自動處理的。如果你在棧上聲明瞭一個 cocos2d::Vector<T> 對象，那就不需要關心內存釋放問題。

 

如果你調用了 new 操作符來分配一塊 cocos2d::Vector<T> 的動態內存，那就需要在使用完後調用 delete 操作符來釋放內存。這同樣適用於 new[] 和 delete[]。

 

注意：在新 C++ 中，它傾向於本地存儲對象而不是堆存儲對象。所以，請不要調用 new 操作符來分配 cocos2d::Vector<T> 的堆對象，而是使用棧對象來代替它。

 

如果你有足夠的理由在堆上動態分配 cocos2d::Vector<T> 的話，請使用智能指針替換原始指針，比如 Shared_ptr，unique_ptr。

 

警告： cocos2d::Vector<T> 不是 cocos2d::Object 的子類，因此不再像其他的 cocos2d 類一樣使用 retain/release 和內存計數管理。換句話說，你不能對 cocos2d::Vector<T> 本身調用 retain，release等等操作。

 

4.基本用法

 

我們用一個統一的接口外加 Cocos2d-x 的內存管理規則來封裝了 std::vector<T> 基本上所有常用的操作。

 

所以 pushBack() 方法現在將會 retain 該函參的所有權，popBack() 方法將會 release 容器最後一個元素的所有權。

 

當你使用這些操作時，你應該加倍注意底層的內存管理，這東西對於許多的 Cocos2d-x 開發新手是常見陷阱。

 

警告：cocos2d::Vector<T> 沒有重載 operator[]，所以你不能使用像 vec 這樣的操作來試圖從 cocos2d::Vector<T> 獲取元素。

 

cocos2d::Vector<T> 容器提供了許多不同種類的迭代器。我們受益於 C++ 標準庫的標準基礎設施；例如，大量專用的標準通用算法和 for_each 循環。

 

除了 std::vector<T> 容器操作，我們還添加了很多標準算法到 cocos2d::Vector<T>，比如 std::find，std::reverse 和 std::swap，這樣簡化了很多有用的、常用的操作。

 

更多 API 的使用，請參考引擎源碼和 Cocos2d-x 3.0 beta 已實現的測試例。

 

這裏提供一個簡單的示例：

//使用默認大小創建一個 Vector<Sprite*>，然後往其中加入一個精靈
auto sp0 = Sprite::create();
sp0->setTag(0);
//這裏我們 demo 使用了 shared_ptr，在你的代碼中，請使用棧對象替代
std::shared_ptr<Vector<Sprite*>>  vec0 = std::make_shared<Vector<Sprite*>>();  //default constructor
vec0->pushBack(sp0);

//使用capacity爲5來創建一個 Vector<Object*>，然後往其中加入一個精靈
auto sp1 = Sprite::create();
sp1->setTag(1);

//用一個容量初始化一個 vector
Vector<Sprite*>  vec1(5);
//在一個確定的位置插入一個確定的對象
vec1.insert(0, sp1);

//我們也可以加入一整個 vector
vec1.pushBack(*vec0);

for(auto sp : vec1)
{
    log("sprite tag = %d", sp->getTag());
}

Vector<Sprite*> vec2(*vec0);
if (vec0->equals(vec2)) { //如果兩個 vector 相同的話返回真
    log("pVec0 is equal to pVec2");
}
if (!vec1.empty()) {  //判斷 vector 是否爲空
    //獲取 vector 的 capacity 和 size，要注意的是 capacity 並不一定等於 size
    if (vec1.capacity() == vec1.size()) {
        log("pVec1->capacity()==pVec1->size()");
    }else{
        vec1.shrinkToFit();   //收縮 vector 以便內存對應上元素的數量
        log("pVec1->capacity()==%zd; pVec1->size()==%zd",vec1.capacity(),vec1.size());
    }
    //pVec1->swap(0, 1);  //通過索引交換 vector 中的兩個元素
    vec1.swap(vec1.front(), vec1.back());  //通過值交換 vector 中的兩個元素
        if (vec2.contains(sp0)) {  //返回一個布爾值，用於指示該對象是否存在於 vector 中
        log("The index of sp0 in pVec2 is %zd",vec2.getIndex(sp0));
    }
    //從 vector 中移除元素
    vec1.erase(vec1.find(sp0));
    //pVec1->erase(1);
    //pVec1->eraseObject(sp0,true);
    //pVec1->popBack();

    vec1.clear(); //移除所有元素
    log("The size of pVec1 is %zd",vec1.size());
}

輸出:

Cocos2d: sprite tag = 1
Cocos2d: sprite tag = 0
Cocos2d: pVec0 is equal to pVec2
Cocos2d: pVec1->capacity()==2; pVec1->size()==2
Cocos2d: The index of sp0 in pVec2 is 0
Cocos2d: The size of pVec1 is 0

5.最佳實踐

 

偏向於使用基於棧構建的 cocos2d::Vector<T> 而不使用基於堆構建的 cocos2d::Vector<T>。

 

當將 cocos2d::Vector<T> 作爲參數進行傳遞的時候，將它聲明爲一個常引用，如 const cocos2d::Vector<T>&。

 

當從一個函數中返回一個 cocos2d::Vector<T> 時，簡單地返回值對象。編譯器將使用移動語義優化這種情況。

 

不要試圖在 cocos2d::Vector<T> 中保存除 cocos2d::Object 子類對象指針以外的其他任意數據類型對象。

 

本文翻譯自：https://github.com/chukong/cocos-docs/blob/master/manual/framework/native/data-structure/v3/vector/en.md

 原帖地址：http://www.cocoachina.com/bbs/read.php?tid=199793