我对.Net的委托模型印象很深刻,使用委托,可以快速实现观察者模式,免去写很多繁杂重复的代码。遗憾的是,C++并没有提供这样的模型,为了达到相似的目的,需要继承一个类并重写virtual方法,这种做法需要写很多代码,效率比较低下(使用过MFC的应该都能体会到)。然而,在强大的C++面前,没有什么是不可能的,已经有很多人针对这个问题进行过研究,并且实现了各种委托模型,其中最著名的就是FastDelegate,这个模型在《Member Function Pointers and the Fastest Possible C++ Delegates》中提出(原文地址:http://www.codeproject.com/KB/cpp/FastDelegate.aspx)。这个模型的特点就是“Fast”,因此不可避免地要依赖编译器的具体实现,虽然文章的最后说明该模型已在大部分的编译器上通过了测试,我仍然对此不太放心,要是哪个编译器升级后改变了实现方式,这个模型就不适合使用了。而且,由于自身水平有限以及懒惰的心理,我也不想去深究每种编译器的具体实现方式。我想要的是符合C++标准,与编译器无关的模型,而不管它是否“Fast”。经过不断的摸索,终于写出了这样的一个委托模型,下面与大家分享一下该模型的实现原理。(当然,如果你认为FastDelegate已经满足需求,而且不担心它依赖于编译器,那么完全可以忽略本文)
成员函数指针的操作
在开始之前首先介绍一下成员函数指针,它与非成员函数指针的操作方式有很大的不同。有这么一个类:
1 | class A { |
2 | public : |
3 | void Func( int ) { … } |
4 | }; |
要取得Func函数的指针,必须这么做:
1 | void (A::*pFunc)( int ) = &A::Func; |
::*是一个特殊的操作符,表示pFunc是一个指针,指向A的成员函数。获取成员函数的地址不能通过类对象来获取,必须像上面的那样,通过类名获取,而且要加上取地址操作符(&)。
那么如何通过成员函数指针来调用该函数呢?成员函数都有一个隐含的this参数,表示函数要操作的对象,现在我们只获取到了函数的指针,还缺少一个对象作为this参数。为了达到这个目的,需要先创建一个对象,然后通过该对象来调用成员函数指针:
1 | A a; |
2 | (a.*pFunc)(10); |
3 |
4 | A* pa = &a; |
5 | (pa->*pFunc)(11); |
第一种方式是通过对象本身来调用,第二种方式是通过对象指针来调用,两种方式的效果都是一样的。.*和->*都是特殊的操作符,不必纠结于它们奇怪的样子,只要知道它们只用于调用成员函数指针就行了。
第一步:使用类模板
通过上面的介绍,我们知道了要调用一个成员函数,仅仅有成员函数指针是不够的,还需要一个对象指针,所以要用一个类将两者绑到一起。由于对象的类型是无穷多的,所以这里必须使用类模板:
01 | template < typename T> |
02 | class DelegateHandler { |
03 |
04 | public : |
05 | DelegateHandler(T* pT, void (T::*pFunc)( int )) |
06 | : m_pT(pT), m_pFunc(pFunc) { } |
07 |
08 | void Invoke( int value) { |
09 | (m_pT->*m_pFunc)(value); |
10 | } |
11 |
12 | private : |
13 | T* m_pT; |
14 | void (T::*m_pFunc)( int ); |
15 | }; |
可以像下面那样使用该模板:
1 | A a; |
2 | DelegateHandler<A> ah(&a, &A::Func); |
3 | ah.Invoke(3); |
4 |
5 | B b; |
6 | DelegateHandler<B> bh(&b, &B::Method); //B::Method的声明与A::Func一致 |
7 | bh.Invoke(4); |
到这里产生了一个问题:如果希望调用的目标是非成员函数,怎么办?上面的类模板无法调用非成员函数,不过使用模板偏特化就可以解决这个问题:
01 | template <> |
02 | class DelegateHandler< void > { |
03 |
04 | public : |
05 | DelegateHandler( void (*pFunc)( int )) |
06 | : m_pFunc(pFunc) { } |
07 |
08 | void Invoke( int value) { |
09 | (*m_pFunc)(value); |
10 | } |
11 |
12 | private : |
13 | void (*m_pFunc)( int ); |
14 | }; |
使用方法也是一样的:
1 | DelegateHandler< void > h(NonmemberFunc); // void NonmemberFunc(int); |
2 | h.Invoke(5); |
也许你会有疑问:非成员函数不需要将函数指针和对象指针绑到一起,为什么这里还要用一个类来包装函数指针?看了下面的内容自然会明白了。
第二步:使用多态
对于单目标的委托来说,使用上面的代码或许就已经足够了。但是我的目的当然不止于此,我想要的是多目标的委托。多目标委托其实就是一个容器,在这个容器里可以存放多个对象,当调用委托的时候依次调用每个对象。容器里的对象应该都是相同的类型,这样才能够放到强类型的容器中;而且委托调用方不应该知道具体的调用目标是什么,所以这些对象也应该要隐藏具体的细节。遗憾的是,上一步中实现的类模板都不具备这些能力,DelegateHandler<A>和DelegateHandler<B>是不同的类型,不能放到同一个容器中,调用方要调用它们也必须知道调用的目标是什么类型。
解决这个问题的方法就是使用多态,令所有的委托目标类都继承一个公共的接口,调用方只通过这个接口来进行调用,这样就不必知道每个目标具体的类型。下面就是该接口的定义:
1 | class IDelegateHandler { |
2 |
3 | public : |
4 | virtual ~IDelegateHandler() { } |
5 | virtual void Invoke( int ) = 0; |
6 | }; |
然后令DelegateHandler继承该接口:
1 | template < typename T> |
2 | class DelegateHandler : public IDelegateHandler { |
3 | … |
4 | } |
5 |
6 | template <> |
7 | class DelegateHandler< void > : public IdelegateHandler { |
8 | … |
9 | } |
现在可以将各种类型的DelegateHandler放到同一个容器中,并使用同样的方式来调用了:
01 | A a; |
02 | B b; |
03 |
04 | DelegateHandler<A> ah(&a, &A::Func); |
05 | DelegateHandler<B> bh(&b, &B::Method); |
06 | DelegateHandler< void > vh(NonmemberFunc); |
07 |
08 | std::vector<IDelegateHandler*> handlers; |
09 | handlers.push_back(&ah); |
10 | handlers.push_back(&bh); |
11 | handlers.push_back(&vh); |
12 | |
13 | for (auto it = handlers.cbegin(); it != handlers.cend(); ++it) { |
14 | (*it)->Invoke(7); |
15 | } |
第三步:使用宏
不知道你注意到没有,上面写了那么多代码,只是为了实现一个返回值为void,有一个int参数的委托!如果要实现更多类型的委托,上面的代码就要重复很多次了。幸好,C++有宏这个东西,使用它可以帮助我们快速生成大量代码。然而这个宏的定义可不是那么简单,为了它我费了好大周折。下面开始讲述这个探索的过程,如果不想看我啰嗦,可以直接跳到后面看现成的代码。
我们都知道,函数参数的声明可以只有类型而没有名称,但是为了在函数内使用参数,该参数必须有名称。例如:
1 | void Invoke( int ) { |
2 | //不能使用参数 |
3 | } |
4 | void Invoke( int value) { |
5 | //可以通过value这个名称来使用参数 |
6 | } |
另外,调用函数的时候只能使用名称,不能带有类型:
1 | int value = 10; |
2 | Invoke(value); |
这些问题似乎都显而易见,根本不值一提,但这些就是定义宏的关键。一开始我想象宏的使用应该是这样的:
1 | DELEGATE( void , DelegateHandler, int , int ); |
毫无疑问,在它的定义中,从第三个参数开始应该使用可变参数,像这样(只截取了定义的一部分):
1 | #define DELEGATE(retType, name, …) \ |
2 | … |
3 | retType Invoke(__VA_ARGS__) { \ |
4 | return (*m_pFunc)(__VA_ARGS__); \ |
5 | } \ |
6 | … |
展开后的代码是这样的:
1 | … |
2 | void Invoke( int , int ) { |
3 | return (*m_pFunc)( int , int ); |
4 | } |
5 | … |
这样很明显是错误的,即使在定义委托的时候加上参数名称也不行。问题的原因是函数参数的声明方式与调用方式不同,而且我们不能将__VA_ARGS__拆开来处理,我们没办法为参数添加名称,也不能去掉参数的名称。
既然如此,我们就使用两个__VA_ARGS__,一个用于函数参数的声明,一个用于调用。以上面的为例,第一个__VA_ARGS__应该是这样子:
1 | int a, int b |
第二个__VA_ARGS__应该是这样子:
1 | a, b |
宏展开之后应该是这样子:
1 | … |
2 | void Invoke( int a, int b) { |
3 | return (*m_pFunc)(a, b); |
4 | } |
5 | … |
这样就正确了。可是这样又带来了一个新问题:一个宏里只能使用一个可变参数。解决方法是,使用另外的宏来产生这两个__VA_ARGS__!好了,我不再说废话了,直接给出代码来,代码比我的表达能力更强。
01 | #define DECLARE_PARAMS(...) __VA_ARGS__ |
02 | #define DECLARE_ARGS(...) __VA_ARGS__ |
03 |
04 | //0个参数的委托 |
05 | #define DELEGATE0(retType, name) \ |
06 | DECLARE_DELEGATE(retType, name, DECLARE_PARAMS( void ), ) |
07 |
08 | //1个参数的委托 |
09 | #define DELEGATE1(retType, name, p1) \ |
10 | DECLARE_DELEGATE( \ |
11 | retType, \ |
12 | name, \ |
13 | DECLARE_PARAMS(p1 a), \ |
14 | DECLARE_ARGS(a)) |
15 |
16 | //2个参数的委托 |
17 | #define DELEGATE2(retType, name, p1, p2) \ |
18 | DECLARE_DELEGATE( \ |
19 | retType, \ |
20 | name, \ |
21 | DECLARE_PARAMS(p1 a, p2 b), \ |
22 | DECLARE_ARGS(a, b)) |
23 | |
24 | //3个参数的委托 |
25 | #define DELEGATE3(retType, name, p1, p2, p3) \ |
26 | DECLARE_DELEGATE( \ |
27 | retType, \ |
28 | name, \ |
29 | DECLARE_PARAMS(p1 a, p2 b, p3 c), \ |
30 | DECLARE_ARGS(a, b, c)) |
31 |
32 | //4个参数的委托 |
33 | #define DELEGATE4(retType, name, p1, p2, p3, p4) \ |
34 | DECLARE_DELEGATE( \ |
35 | retType, \ |
36 | name, \ |
37 | DECLARE_PARAMS(p1 a, p2 b, p3 c, p4 d), \ |
38 | DECLARE_ARGS(a, b, c, d)) |
39 |
40 | //5个参数的委托 |
41 | #define DELEGATE5(retType, name, p1, p2, p3, p4, p5) \ |
42 | DECLARE_DELEGATE( \ |
43 | retType, \ |
44 | name, \ |
45 | DECLARE_PARAMS(p1 a, p2 b, p3 c, p4 d, p5 e), \ |
46 | DECLARE_ARGS(a, b, c, d, e)) |
47 |
48 | //6个参数的委托 |
49 | #define DELEGATE6(retType, name, p1, p2, p3, p4, p5, p6) \ |
50 | DECLARE_DELEGATE( \ |
51 | retType, \ |
52 | name, \ |
53 | DECLARE_PARAMS(p1 a, p2 b, p3 c, p4 d, p5 e, p6 f), \ |
54 | DECLARE_ARGS(a, b, c, d, e, f)) |
55 |
56 | //7个参数的委托 |
57 | #define DELEGATE7(retType, name, p1, p2, p3, p4, p5, p6, p7) \ |
58 | DECLARE_DELEGATE( \ |
59 | retType, \ |
60 | name, \ |
61 | DECLARE_PARAMS(p1 a, p2 b, p3 c, p4 d, p5 e, p6 f, p7 g), \ |
62 | DECLARE_ARGS(a, b, c, d, e, f, g)) |
63 |
64 | //8个参数的委托 |
65 | #define DELEGATE8(retType, name, p1, p2, p3, p4, p5, p6, p7, p8) \ |
66 | DECLARE_DELEGATE( \ |
67 | retType, \ |
68 | name, \ |
69 | DECLARE_PARAMS(p1 a, p2 b, p3 c, p4 d, p5 e, p6 f, p7 g, p8 h), \ |
70 | DECLARE_ARGS(a, b, c, d, e, f, g, h)) |
71 |
72 | #define DECLARE_DELEGATE(retType, name, params, args) \ |
73 | class I##name { \ |
74 | public : \ |
75 | virtual ~I##name() { } \ |
76 | virtual retType Invoke(params) = 0; \ |
77 | }; \ |
78 | template < typename T> \ |
79 | class name : public I##name { \ |
80 | public : \ |
81 | name(T* pType, retType (T::*pFunc)(params)) \ |
82 | : m_pType(pType), m_pFunc(pFunc) { } \ |
83 | retType Invoke(params) { \ |
84 | return (m_pType->*m_pFunc)(args); \ |
85 | } \ |
86 | private : \ |
87 | T* m_pType; retType (T::*m_pFunc)(params); \ |
88 | }; \ |
89 | template <> \ |
90 | class name< void > : public I##name { \ |
91 | public : \ |
92 | name(retType (*pFunc)(params)) \ |
93 | : m_pFunc(pFunc) { } \ |
94 | retType Invoke(params) { \ |
95 | return (*m_pFunc)(args); \ |
96 | } \ |
97 | private : \ |
98 | retType (*m_pFunc)(params); \ |
99 | } |
注意最后面少了一个分号,这是故意为之的,为了强迫在定义委托的时候加上分号。这种宏定义的方法对参数个数有了限制,我这里的定义最多只支持8个参数,为了支持更多参数,需要写更多的代码。其实我认为8个参数已经足够了,超过8个参数的函数不是好的设计,应该重新考虑一下。