C++实现的委托机制(1)
1.引言
下面的委托实现使用的MyGUI里面的委托实现，MyGUI是一款强大的GUI库，想理解更多的MyGUI信息，猛击这里mygui.info
最终的代码可以在这里下载:http://www.2cto.com/uploadfile/2011/1009/20111009023128248.rar
我们的目标是要实现一个跟.NET几乎完全一样的委托，使用简单，支持多播，可以添加删除委托。同时支持C++的普通函数、模板函数、类成员函数，类的静态成员函数，并且支持多态。使用方式如下：
copy to clipboardprint?// 普通函数
void normalFunc(){ cout << "func1" << endl; }
class Base
{
public:
// 类成员函数
void classFunc(){ cout << "Base func1" << endl; }
};
int main() www.2cto.com
{
Base b;
CMultiDelegate myDelegate;
myDelegate += newDelegate(normalFunc);
myDelegate += newDelegate(&b, &Base::classFunc);
myDelegate(); // 此时会调用normalFunc和classFunc
myDelegate -= newDelegate(&b, &Base::classFunc);
myDelegate(); // 此时会调用normalFunc
return 0;
}
// 普通函数
void normalFunc(){ cout << "func1" << endl; }
class Base
{
public:
// 类成员函数
void classFunc(){ cout << "Base func1" << endl; }
};
int main()
{
Base b;
CMultiDelegate myDelegate;
myDelegate += newDelegate(normalFunc);
myDelegate += newDelegate(&b, &Base::classFunc);
myDelegate(); // 此时会调用normalFunc和classFunc
myDelegate -= newDelegate(&b, &Base::classFunc);
myDelegate(); // 此时会调用normalFunc
return 0;
}
2.实现无参函数委托
要实现委托，首先要解决的是封装C++中的函数指针。因为在C++中，普通函数指针和类成员函数指针是完全不一样的。如下例子
copy to clipboardprint?class CMyClass
{
public:
void func(int);
};
// 定义一个指向CMyClass类型，参数列表为(int)，返回值为void的函数指针
typedef void (CMyClass::*ClassMethod) (int); // 注意定义时使用了特殊的运算符::*
class CMyClass
{
public:
void func(int);
};
// 定义一个指向CMyClass类型，参数列表为(int)，返回值为void的函数指针
typedef void (CMyClass::*ClassMethod) (int); // 注意定义时使用了特殊的运算符::*
那么此函数指针只能指向CMyClass类型的成员函数，不能指向其他类或者普通函数
类成员函数指针不能直接调用，要通过一个类实例来调用，如下
copy to clipboardprint?CMyClass *object = new CMyClass;
ClassMethod method = CMyClass::func;
(object->*method)(5); // 注意调用时使用了特殊运算符->*
CMyClass *object = new CMyClass;
ClassMethod method = CMyClass::func;
(object->*method)(5); // 注意调用时使用了特殊运算符->*
那么如何封装呢？我们先来定义下接口吧
（为了简单起见，下面的实现都是以无参函数为例，后续会讲到如何支持任意参数）
copy to clipboardprint?class IDelegate
{
public:
virtual ~IDelegate() { }
virtual bool isType(const std::type_info& _type) = 0;
virtual void invoke() = 0;
virtual bool compare(IDelegate *_delegate) const = 0;
};
class IDelegate
{
public:
virtual ~IDelegate() { }
virtual bool isType(const std::type_info& _type) = 0;
virtual void invoke() = 0;
virtual bool compare(IDelegate *_delegate) const = 0;
};
IDelegate类的接口很少，也很简单，必要接口只有一个，就是invoke，用于触发函数
但为了可以方便管理，使用了isType和compare函数来进行相等判断。
下面是封装的普通函数指针
copy to clipboardprint?class CStaticDelegate : public IDelegate
{
public:
typedef void (*Func)();
CStaticDelegate(Func _func) : mFunc(_func) { }
virtual bool isType( const std::type_info& _type) { return typeid(CStaticDelegate) == _type; }
virtual void invoke() { mFunc(); }
virtual bool compare(IDelegate *_delegate) const
{
if (0 == _delegate || !_delegate->isType(typeid(CStaticDelegate)) ) return false;
CStaticDelegate * cast = static_cast<CStaticDelegate*>(_delegate);
return cast->mFunc == mFunc;
}
private:
Func mFunc;
};
class CStaticDelegate : public IDelegate
{
public:
typedef void (*Func)();
CStaticDelegate(Func _func) : mFunc(_func) { }
virtual bool isType( const std::type_info& _type) { return typeid(CStaticDelegate) == _type; }
virtual void invoke() { mFunc(); }
virtual bool compare(IDelegate *_delegate) const
{
if (0 == _delegate || !_delegate->isType(typeid(CStaticDelegate)) ) return false;
CStaticDelegate * cast = static_cast<CStaticDelegate*>(_delegate);
return cast->mFunc == mFunc;
}
private:
Func mFunc;
};
可以看到，CStaticDelegate只是简单地封装了普通函数指针，代码也非常简单
（类的某些成员函数，如isType和compare使用了RTTI，
对C++的动态类型判断不熟的可以猛击这里http://blog.csdn.net/gouki04/article/details/6796173）
好了，注意了，下面开始封装类成员函数指针
copy to clipboardprint?template<class T>
class CMethodDelegate : public IDelegate
{
public:
typedef void (T::*Method)();
CMethodDelegate(T * _object, Method _method) : mObject(_object), mMethod(_method) { }
virtual bool isType( const std::type_info& _type) { return typeid(CMethodDelegate) == _type; }
virtual void invoke()
{
(mObject->*mMethod)();
}
virtual bool compare(IDelegate *_delegate) const
{
if (0 == _delegate || !_delegate->isType(typeid(CMethodDelegate)) ) return false;
CMethodDelegate* cast = static_cast<CMethodDelegate* >(_delegate);
return cast->mObject == mObject && cast->mMethod == mMethod;
}
private:
T * mObject;
Method mMethod;
};
template<class T>
class CMethodDelegate : public IDelegate
{
public:
typedef void (T::*Method)();
CMethodDelegate(T * _object, Method _method) : mObject(_object), mMethod(_method) { }
virtual bool isType( const std::type_info& _type) { return typeid(CMethodDelegate) == _type; }
virtual void invoke()
{
(mObject->*mMethod)();
}
virtual bool compare(IDelegate *_delegate) const
{
if (0 == _delegate || !_delegate->isType(typeid(CMethodDelegate)) ) return false;
CMethodDelegate* cast = static_cast<CMethodDelegate* >(_delegate);
return cast->mObject == mObject && cast->mMethod == mMethod;
}
private:
T * mObject;
Method mMethod;
};
首先解释一下：因为类成员函数指针与类的类型有关，不同类的成员函数指针是不一样的。
要解决类型不同，很简单，使用模板就行。
代码跟CStaticDelegate基本一样，下面稍微解释一下：
CMethodDelegate类主要封装了一个类实例指针以及类成员函数的指针
这样在invoke时就不要额外的通过一个类实例了
要注意一点，compare函数的实现中，相等判定是类实例以及类函数指针都一样。
也就是说就算是指针同一个成员函数，但实例不同，委托就不同
为了方便使用，定义函数newDelegate来创建委托使用的函数
copy to clipboardprint?inline IDelegate* newDelegate( void (*_func)() )
{
return new CStaticDelegate(_func);
}
template<class T>
inline IDelegate* newDelegate( T * _object, void (T::*_method)() )
{
return new CMethodDelegate<T>(_object, _method);
}
inline IDelegate* newDelegate( void (*_func)() )
{
return new CStaticDelegate(_func);
}
template<class T>
inline IDelegate* newDelegate( T * _object, void (T::*_method)() )
{
return new CMethodDelegate<T>(_object, _method);
}
至此，对C++函数指针的封装就完成了，不难吧。
下面就是委托的实现了
copy to clipboardprint?class CMultiDelegate
{
public:
typedef std::list<IDelegate*> ListDelegate;
typedef ListDelegate::iterator ListDelegateIterator;
typedef ListDelegate::const_iterator ConstListDelegateIterator;
CMultiDelegate () { }
~CMultiDelegate () { clear(); }
bool empty() const
{
for (ConstListDelegateIterator iter = mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if (*iter) return false;
}
return true;
}
void clear()
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if (*iter)
{
delete (*iter);
(*iter) = 0;
}
}
}
CMultiDelegate& operator+=(IDelegate* _delegate)
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if ((*iter) && (*iter)->compare(_delegate))
{
delete _delegate;
return *this;
}
}
mListDelegates.push_back(_delegate);
return *this;
}
CMultiDelegate& operator-=(IDelegate* _delegate)
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if ((*iter) && (*iter)->compare(_delegate))
{
if ((*iter) != _delegate) delete (*iter);
(*iter) = 0;
break;
}
}
delete _delegate;
return *this;
}
void operator()( )
{
ListDelegateIterator iter = mListDelegates.begin();
while (iter != mListDelegates.end())
{
if (0 == (*iter))
{
iter = mListDelegates.erase(iter);
}
else
{
(*iter)->invoke();
++iter;
}
}
}
private:
CMultiDelegate (const CMultiDelegate& _event);
CMultiDelegate& operator=(const CMultiDelegate& _event);
private:
ListDelegate mListDelegates;
};
class CMultiDelegate
{
public:
typedef std::list<IDelegate*> ListDelegate;
typedef ListDelegate::iterator ListDelegateIterator;
typedef ListDelegate::const_iterator ConstListDelegateIterator;
CMultiDelegate () { }
~CMultiDelegate () { clear(); }
bool empty() const
{
for (ConstListDelegateIterator iter = mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if (*iter) return false;
}
return true;
}
void clear()
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if (*iter)
{
delete (*iter);
(*iter) = 0;
}
}
}
CMultiDelegate& operator+=(IDelegate* _delegate)
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if ((*iter) && (*iter)->compare(_delegate))
{
delete _delegate;
return *this;
}
}
mListDelegates.push_back(_delegate);
return *this;
}
CMultiDelegate& operator-=(IDelegate* _delegate)
{
for (ListDelegateIterator iter=mListDelegates.begin(); iter!=mListDelegates.end(); ++iter)
{
if ((*iter) && (*iter)->compare(_delegate))
{
if ((*iter) != _delegate) delete (*iter);
(*iter) = 0;
break;
}
}
delete _delegate;
return *this;
}
void operator()( )
{
ListDelegateIterator iter = mListDelegates.begin();
while (iter != mListDelegates.end())
{
if (0 == (*iter))
{
iter = mListDelegates.erase(iter);
}
else
{
(*iter)->invoke();
++iter;
}
}
}
private:
CMultiDelegate (const CMultiDelegate& _event);
CMultiDelegate& operator=(const CMultiDelegate& _event);
private:
ListDelegate mListDelegates;
};
仔细理解下CMultiDelegate类的实现，代码都不深奥。
比较重要的是3个函数 ：+=，-=，()运算符的重载函数
+= 用于添加一个委托函数
-= 用于去掉一个委托函数
() 用于触发委托函数
差不多就是普通的stl容器使用了。
这里要重点说明的一点是，大家仔细看 += 函数的实现中
copy to clipboardprint?if ((*iter) && (*iter)->compare(_delegate))
{
delete _delegate; // 如果该委托函数已经被添加了，则delete掉外部的_delegate
return *this;
}
if ((*iter) && (*iter)->compare(_delegate))
{
delete _delegate; // 如果该委托函数已经被添加了，则delete掉外部的_delegate
return *this;
}
为什么要delete掉外部的指针呢？
因为C++的内存泄露一直是个麻烦事，所以MyUGI的委托里，所有的委托函数统一由Delegate本身管理
外部不要自己new或delete委托函数，也不要保存一个委托函数，Delegate本身会管理好的。
建议像如下使用：
copy to clipboardprint?CMultiDelegate myDelegate;
myDelegate += newDelegate(normalFunc);
myDelegate -= newDelegate(normalFunc);
CMultiDelegate myDelegate;
myDelegate += newDelegate(normalFunc);
myDelegate -= newDelegate(normalFunc);
而不建议像如下使用：
copy to clipboardprint?CMultiDelegate myDelegate;
IDelegate* delegateFunc = newDelegate(normalFunc);
myDelegate += delegateFunc;
myDelegate -= delegateFunc;
CMultiDelegate myDelegate;
IDelegate* delegateFunc = newDelegate(normalFunc);
myDelegate += delegateFunc;
myDelegate -= delegateFunc;
上面2种方法都没错，都不会造成内存泄露
你可能会觉得第2种方法减少new的次数，比第一种方法更好。其实不然，因为第2种方法有个很大的隐患
copy to clipboardprint?myDelegate -= delegateFunc; // 在这一步，delegateFunc所指向的空间已经被释放掉了（在-=函数里面）
myDelegate -= delegateFunc; // 在这一步，delegateFunc所指向的空间已经被释放掉了（在-=函数里面）
所以如果你后面又想将delegateFunc添加到myDelegate里面时，你就不能再这样用了
copy to clipboardprint?myDelegate += delegateFunc; // 错误，因为delegateFunc的空间已经被释放了
myDelegate += delegateFunc; // 错误，因为delegateFunc的空间已经被释放了
你得重新new一个
delegateFunc = newDelegate(normalFunc);
myDelegate += delegateFunc;
相信你不会愿意这样做的，因为这种方法很容易造成内存泄露或者崩溃
现在你应该可以明白 -= 函数是怎么释放委托函数内存了吧。
按上面的方法，你已经可以使用无参数的函数委托了。下一篇文章将会介绍如何实现任意参数的函数委托
