COM组件设计与应用（十六）－－连接点(vc.net)

COM组件设计与应用（十六）
连接点(vc.net)

作者：

一、前言

　　上回书介绍了回调接口，在此基础上，我们理解连接点就容易多了。

二、原理


图一、连接点组件原理图。左侧为客户端，右侧为服务端（组件对象）

　　看着好复杂呀......呵呵，其实简单的紧：（注1）
1、一个 COM 组件，允许有多个连接点对象(IConnectionPoint)。
   也就是说可以有多个发生“事件”的源头。上图就有3个连接点；
2、管理这些连接点的接口叫“连接点容器”(IConnectionPointContainer)。
   连接点容器接口特别简单，因为只有2个函数，一个是 FindConnectionPoint()，表示查找你想要的连接点；另一个是 EnumConnectionPoints()，表示列出所有的连接点，然后你去选择使用哪个。在实际的应用中，查找法使用最多，占90%，而枚举法使用只占 10%，一般在支持第三方的插件(Plug in)时才使用。（你想写个 IE 的插件吗？我们后面就要讲到啦）
3、每一个连接点，可以被多个客户端的接收器(Sink)连接；
   这个我们已经熟悉啦，还记得我们在上回书中为了管理多个回调接口，使用了 cookie 的方式进行区别吗？！

三、实现组件（一）

1、建立一个空白解决方案。
2、在解决方案中，新增 ATL 项目。示例程序中项目名称叫 Simple16， 注意不要选择“属性化编程”方式。
3、添加 ATL 类。选择 “ATL 的简单对象”。
4、名称卡片中，输入组件名称。示例程序中是 DispConnect。



5、选项卡片中，接口类型选双接口。注意一定要选择“连接点”。



6、增加接口函数。和上回书的程序一样，增加一个方法计算整数加法， 而通过连接点返回计算结果。





7、下面该增加“事件”函数了。选择事件接口(_IDispConnectEvents)，添加函数。



8、该函数用来返回 Add() 函数的计算结果。



9、生成事件代理类程序代码。选择组件类对象(CDispConnect)，执行鼠标右键菜单“添加连接点”



10、选择你要让 IDE 帮你生成哪个连接点的代理程序代码。我们这个组件只有一个连接点，那只好选择它了。 （在示例二的程序中，我们实现了两个连接点，那么你就要选择两个接口啦）



11、到此，VC 的 IDE 终于帮咱们完成了所有的框架，下面该咱们自己写真正的任务代码啦。

STDMETHODIMP CDispConnect::Add(long n1, long n2)
{
	long nVal = n1 + n2;
	Fire_Result( nVal );	// 调用IDE帮我们生成的代理函数代码，发出事件

	return S_OK;
}

四、实现调用者（一）

1、建立一个 MFC 项目。示例程序中的名称叫 Use。
2、按照咱们以前所学的知识，添加 #import、AfxOleInit()、......不多浪费口条了。如果你还不会，那么请重新从“第四回”再次阅读。 （注2）
3、这里只介绍一下重点部分。我们需要在调用者工程中，增加“接收器”对象。还记得上回书中的增加“回调接收器”对象的方法吗？上回中，我们的回调接口是从 IUnknown 继承下来的。本回中，由于我们的组件是双接口(Dual)的，连接点也是双接口的，因此这次我们的接收器要从 IDispatch 派生啦。




4、完成 CSink 类的接口函数（虚函数）

STDMETHODIMP CSink::QueryInterface(const struct _GUID &iid,void ** ppv)
{
	*ppv=this;
	return S_OK;
}

ULONG __stdcall CSink::AddRef(void)
{	return 1;	}	// 做个假的就可以，因为反正这个对象在程序结束前是不会退出的

ULONG __stdcall CSink::Release(void)
{	return 0;	}	// 做个假的就可以，因为反正这个对象在程序结束前是不会退出的

STDMETHODIMP CSink::GetTypeInfoCount(unsigned int *)
{	return E_NOTIMPL;	}	// 不用实现，反正也不用

STDMETHODIMP CSink::GetTypeInfo(unsigned int,unsigned long,struct ITypeInfo ** )
{	return E_NOTIMPL;	}	// 不用实现，反正也不用

STDMETHODIMP CSink::GetIDsOfNames(const IID &,LPOLESTR *,UINT,LCID,DISPID *)
{	return E_NOTIMPL;	}	// 不用实现，反正也不用

STDMETHODIMP CSink::Invoke(
	long dispID,
	const struct _GUID &,
	unsigned long,
	unsigned short,
	struct tagDISPPARAMS * pParams,
	struct tagVARIANT *,
	struct tagEXCEPINFO *,
	unsigned int *)
{		// 只需要实现这个就足够啦
	switch(dispID)	// 根据不同的dispID,完成不同的回调函数
	{
	case 1:
		......	// 这里就能接收到 COM 发出的事件啦
		break;
	case 2:
		......	// 事件的代号 dispID 其实就是 IDL 文件中的连接点函数的id(n)的号码
		break;
	default:	break;
	}
	return S_OK;
}

五、示例（二）

　　示例程序中的第2个组件(MultConnect)，我们再增加一个连接点( _IDispConnectEvents2 )。这个接口对象负责完成一个时钟，每间隔一定的豪秒就向调用者发出“时钟事件”。增加第二个连接点的方法是要手工修改 IDL 文件

......
library MultConnectLib
{
	importlib("stdole2.tlb");
	...... // 第一个连接点。是 ATL 帮我们生成的
	[   // 第2个连接点，需要我们手工添加
		uuid(E3330AE1-2B1D-42E6-A8E0-A9CB0D1AC74C), // CLSID 可以用 GUIDGEN.EXE 产生
		helpstring("_IDispConnect事件接口")
	]
	dispinterface _IDispConnectEvents2
	{
		properties:
		methods:
	};
	[
		uuid(4B0FDB44-BAF2-4F25-A2B0-B5ECD5CD440E), // 这是示例程序的类型库ID，肯定和你产生是不同的
		helpstring("DispConnect Class")
	]
	coclass DispConnect
	{
		[default] interface IDispConnect;
		[default, source] dispinterface _IDispConnectEvents;
		[source] dispinterface _IDispConnectEvents2; // 别忘了，这还有一行
	};
};

　　好了，和前面的方式一样，增加接口函数、让IDE帮我们实现代理类代码、输入程序代码、修改框架代码中的BUG。在示例中，我们的事件函数叫 HRESULT Timer([in] VARIANT varData)，varData 中传递一个时间类型(VT_DATA）的信息（注3）。下面我们来看一下代理类代码中的错误：

HRESULT Fire_Timer( VARIANT  varDate)
{
　　HRESULT hr = S_OK;
　　T * pThis = static_cast(this);
　　int cConnections = m_vec.GetSize();

　　for (int iConnection = 0; iConnection < cConnections; iConnection++)
　　{
　　　　pThis->Lock();
　　　　CComPtr punkConnection = m_vec.GetAt(iConnection);
　　　　pThis->Unlock();

　　　　IDispatch * pConnection = static_cast(punkConnection.p);
　　　　if (pConnection)
　　　　{
　　　　　　CComVariant avarParams[1];
　　　　　　// 原始为：avarParams[0] = varDate;	avarParams[0].vt = VT_VARIANT;
　　　　  // 但可惜这是错误的，因为 avarParams[0] = varDate; 就已经正确地完成了赋值
　　　　  // 再对 avarParams[0].vt 赋值，是引用方式才能这么操作的。
　　　　  avarParams[0] = varDate; // 这才是正确的操作
　　　　   CComVariant varResult;

　　　　   DISPPARAMS params = { avarParams, NULL, 1, 0 };
　　　　   hr = pConnection->Invoke(1, IID_NULL, LOCALE_USER_DEFAULT, DISPATCH_METHOD, ¶ms, &varResult, NULL, NULL);
　　　　 }
　　}
　　return hr;
}

　　在编写调用者客户端代码方面，如果你需要接收时钟事件，那么可以仿照示例一再从 IDispatch 派生一个时钟接收器。大家下载事例程序代码，里面有丰富的注释信息。

六、小结

　　连接点，尤其是双接口的连接点，在远程（DCOM）环境上运行效率是比较低的。如果你只想完成简单的“通知”功能，那么前一回中的“回调接口”是一个明智的方案，并且可以运行在DCOM环境上。连接点方案当然也很重要，因为微软的许多应用程序(IE、Office......)都支持连接点，并且 ActiveX 只能通过连接点接口提供“事件”功能。所以，咱们还是都掌握为善吧。善哉 、善哉......

---

注1：金庸老先生的武侠小说里，总是用“XX 紧”来表示“很 XX”。我也学一学，嘿嘿。
注2：如果看了好几遍，您老人家还不会的话，那只好......先别学了。5555
注3：DATA 类型就是是8字节的double，它的整数部分表示从 1899年12月30日开始的总天数，小数部分表示当天的时间已经渡过了一天的多少分之一。这个时间类型，用VARIANT表示，就是VT_DATE类型，MFC 中用 COleDateTime 表示。示例程序中有对该类型的操作示范。