浅析cocos2d-x 2.x到3.x事件侦听设计变化原因之一

DionysosLai 2015/2/28

对于事件侦听的设计，cocos2d-x从2.x到3.x发生了根本性的变化，一直以来对此，只是单纯的使用考虑如何构建自己的游戏代码，并未对其二者设计孰优孰劣进行探究。只是前段时间在做一个新游戏时，关于2.x的触摸事件发现了一个设计不人性化问题，本想向cocos2dx官网反应，但测试3.x时，并未发现这个问题。对此，本文细述这个问题，分析二者设计的不同，同时希望抛砖引玉。
简单阐述2.x与3.x的事件侦听不同点：
在2.x中，需要注册一个事件侦听。
在3.x中，则需要创建一个侦听器的对象，然后定义回调方法，最后将侦听和事件分发器绑定。
注意，2.x是注册一个事件侦听，在3.x中则是创建一个侦听器对象。这二者有什么不同呢？这里分别在2.x中和3.x写一个测试demo，可以看到2.x中一个严重设计bug问题。

2.x代码如下：

.h
    DelegateTest();
    virtual ~DelegateTest();
    virtual void keyBackClicked();

    .cpp
    DelegateTest::DelegateTest(){}
.cpp
DelegateTest::~DelegateTest()
{
    CCLOG("DelegateTest release!!");
}

bool DelegateTest::init()
{
    if (!CCLayer::init())
    {
        return false;
    }

    this->setKeypadEnabled(true);

    CCDirector::sharedDirector()->getTouchDispatcher()->addTargetedDelegate(this, 0 ,true);
    return true;
}

void DelegateTest::keyBackClicked()
{
    CCScene* sceneGame = DelegateTest::scene();
    CCDirector::sharedDirector()->replaceScene(sceneGame);
    CCLog("keyBackClicked!!!");
}

这里，是一个简单的触摸侦听事件事件demo，在init()中添加注册触摸事件，同时使能返回键功能，同时按下返回键时，切换界面。
先理论分析调试信息，应该是如下所示：
按下返回键：
keyBackClicked!!!
DelegateTest release!!
再次按下返回键：
keyBackClicked!!!
DelegateTest release!!
……
事件呢，调试信息如下：
按下返回键:
keyBackClicked!!!
再次按下返回键：
keyBackClicked!!!
退出游戏：
DelegateTest release!!
DelegateTest release!!
看到区别了吗！出现这种现象的结果什么呢。就是当前场景并未移除掉，同样能接收触摸，当不止一个场景出现时，其逻辑就会出现紊乱！！！
现在代码移植到3.x中。

3.x代码如下：

.h
    DelegateTest();
    virtual ~DelegateTest();
    virtual void onKeyReleased(cocos2d::EventKeyboard::KeyCode keyCode, cocos2d::Event* event) override;
    cocos2d::EventListenerKeyboard* m_keyboardListener;     // 键盘listener
    cocos2d::EventListenerTouchOneByOne* m_touchListener    ;   // 触摸listener

.cpp
DelegateTest::DelegateTest(){}

DelegateTest::~DelegateTest()
{
    log("DelegateTest release!!");
}

bool DelegateTest::init()
{
    if (!CCLayer::init())
    {
        return false;
    }

    m_keyboardListener = EventListenerKeyboard::create();
    m_keyboardListener->retain();
    m_keyboardListener->onKeyReleased = CC_CALLBACK_2(DelegateTest::onKeyReleased, this);
    getEventDispatcher()->addEventListenerWithSceneGraphPriority(m_keyboardListener, this);

    //setKeypadEnabled(true); ----不再适用
    m_touchListener = EventListenerTouchOneByOne::create();
    m_touchListener->retain();
    m_touchListener->onTouchBegan = CC_CALLBACK_2(DelegateTest::onTouchBegan, this);
    m_touchListener->onTouchBegan = [&](cocos2d::Touch* touch, cocos2d::Event* event){
        return true;
    };
    getEventDispatcher()->addEventListenerWithSceneGraphPriority(m_touchListener, this);

    return true;
}

void DelegateTest::onKeyReleased( cocos2d::EventKeyboard::KeyCode keyCode, cocos2d::Event* event )
{
    Scene* sceneLayer = DelegateTest::scene();
    Director::getInstance()->replaceScene(sceneLayer);
    log("onKeyReleased!!!");
}

功能与前面描述的一模一样。调试信息如下所示：
onKeyReleased!!!
DelegateTest release!!
onKeyReleased!!!
DelegateTest release!!
与我们要的结果一致。为何会出现这两种不同的情况呢。这是由于2.x中，是注册侦听事件，因此我们必须对应的要注销侦听事件。而3.x是创建侦听器对象，这样析构时，会自动移除对象，从设计上来说，3.x比2.x更加的容易，且不容易出错。
那么对于2.x要如何更改，使之出现的结果跟我们理论上一致呢？这里更改函数keyBackClicked()代码即可：

void DelegateTest::keyBackClicked()
{
    CCScene* sceneGame = DelegateTest::scene();
    CCDirector::sharedDirector()->replaceScene(sceneGame);
    CCDirector::sharedDirector()->getTouchDispatcher()->removeDelegate(this);
    CCLog("keyBackClicked!!!");
}

当然，理论上3.x退出场景时，也要移除侦听器对象，函数是release()，这里省咯了而已。也许大家会说，不就是在2.x中添加一句话而已，而且忘记注销，本身就是自己的问题。这里首先要说一点，就是当layer比较多时，注销触摸并不是一件简单的事情，同时，退出场景可能在一个子类中调用；也可能在另一个layer中，要求关闭当前场景中所有layer，比如暂停界面。另一个面，当使用到popScene和pushScene时，这更加是一个灾难！！！对于一个游戏引擎，良好的设计应该能主动帮忙开发者避免以坑。这也是为什么在cocos2d-x中渲染时，为何不专门开一个线程，实现逻辑与展示分开。因为这样太难了，会导致大量细节问题，无形中加大开发者难度，当然，随着以后引擎开发，相信会解决这个问题。详细可以参考王哲回答：http://www.zhihu.com/question/27612727/answer/38078748。
对于以上代码细节，可以访问笔者githup：https://github.com/DionysosLai/CocoSamples 中的“Delegate Test”内容。2015年第一篇文章，新年新兆头，祝大家新年更棒！！！—ps:第一次使用markdown编辑器，感觉萌萌哒！！！