楊寧

　　本文首先論述可連接對(duì)象和連接點(diǎn)機(jī)制的原理，然后通過一個(gè)示例說明怎樣用MFC編程實(shí)現(xiàn)可連接對(duì)象和內(nèi)嵌于客戶的事件接收器.

　　1、可連接對(duì)象和連接點(diǎn)機(jī)制的基本原理

　　為了在組件對(duì)象和客戶之間提供更大的交互能力，組件對(duì)象也需要主動(dòng)與客戶進(jìn)行通信。組件對(duì)象通過出接口（Outgoing Interface）與客戶進(jìn)行通信。如果一個(gè)組件對(duì)象定義了一個(gè)或者多個(gè)出接口則此組件對(duì)象叫做可連接點(diǎn)對(duì)象。

　　所謂出接口也是COM接口。每個(gè)出接口包含一組成員函數(shù)，每個(gè)成員函數(shù)代表了一個(gè)事件、一個(gè)通知或者一個(gè)請(qǐng)求。但是這些接口是在客戶的事件接收器（sink）中實(shí)現(xiàn)的，所以叫出接口。事件接收器也是COM對(duì)象。

　　可連接對(duì)象必須實(shí)現(xiàn)一個(gè)IConnectionPointContainer接口用于管理所有的出接口。每個(gè)出接口對(duì)應(yīng)一個(gè)連接點(diǎn)對(duì)象，連接點(diǎn)對(duì)象實(shí)現(xiàn)了IConnectionPoint接口。客戶正是通過IConnectionPoint接口與可連接對(duì)象建立連接。每一個(gè)連接用CONNECTDATA結(jié)構(gòu)描述。

　　CONNECTDATA包含兩個(gè)成員：IUnknown* pUnk和DWORD dwCookie。pUnk對(duì)應(yīng)于客戶中事件接收器的IUnknown接口指針；dwCookie是由連接點(diǎn)對(duì)象生成的用于唯一標(biāo)識(shí)此連接的32位整數(shù)。

　　通過一個(gè)由可連接對(duì)象實(shí)現(xiàn)的枚舉器接口IEnumConnectionPoints，客戶可以訪問可連接對(duì)象的所有連接點(diǎn)。但是要獲得IEnumConnectionPoints接口指針，要通過IConnectionPointContainer：：EnumConnectionPoints（IEnumConnectionPoints**）函數(shù)，此函數(shù)返回枚舉器接口指針。

　　通過另一個(gè)有可連接對(duì)象實(shí)現(xiàn)的枚舉器接口IEnumConnections，無(wú)論客戶還是可連接對(duì)象都可以訪問一個(gè)連接點(diǎn)上的所有連接。通過IConnectionPoint：：EnumConnections（IEnumConnections**）函數(shù)可以獲得IEnumConnections接口指針。

　　綜上所述，一個(gè)可連接對(duì)象必須實(shí)現(xiàn)四個(gè)接口：IConnectionPointContainer、IConnectionPoint、IEnumConnectionPoints、IEnumConnections。這四個(gè)接口的定義請(qǐng)閱讀MSDN文檔。

　　現(xiàn)在結(jié)合后面的示例簡(jiǎn)單描述一下可連接對(duì)象和客戶通信的過程。在后面的示例中，可連接對(duì)象ConnObject定義了出接口IEventSink,對(duì)應(yīng)此出接口，實(shí)現(xiàn)了一個(gè)連接點(diǎn)對(duì)象SampleConnPoint(此對(duì)象實(shí)現(xiàn)了對(duì)應(yīng)于出接口的連接點(diǎn)接口IConnectionPoint，接口ID為IID_IEventSink)。

　　1.客戶在獲取了可連接對(duì)象的IUnknown接口指針m_pIUnknown后，調(diào)用m_pIUnknown->QueryInterface(IID_IConnectionPointContainer,(void**)&pConnPtCont);如果調(diào)用成功，pConnPtCont中將存放可連接對(duì)象的IConnectionPointContainer接口指針。如果調(diào)用不成功，則表明對(duì)象不是可連接對(duì)象。

　　2.調(diào)用pConnPtCont->FindConnectionPoint(IID_IEventSink,&pConnPt)。如果調(diào)用成功，pConnPt將存放對(duì)應(yīng)于出接口IEventSink的連接點(diǎn)對(duì)象SampleConnPoint所實(shí)現(xiàn)的連接點(diǎn)接口IConnectionPoint指針；如果調(diào)用不成功，說明可連接對(duì)象不支持出接口IEventSink。

　　3.調(diào)用pConnPt->Advise(pIEventSink,&m_dwCookie)以建立事件接收器（EventSink）與連接點(diǎn)的連接。其中pIEventSink是客戶事件接收器IUnknown接口的指針，此指針通過此函數(shù)傳遞給了可連接對(duì)象以便可連接對(duì)象發(fā)起對(duì)客戶的通信；m_dwCookie是連接標(biāo)識(shí)，此值由可連接對(duì)象設(shè)置由客戶保存，客戶還要使用此值以斷開連接。

　　4.可連接對(duì)象可以通過連接點(diǎn)調(diào)用客戶事件接收器中的方法。在客戶與連接點(diǎn)成功建立連接后，連接點(diǎn)中已經(jīng)保存了客戶事件接收器接口的指針并可以調(diào)用pConnPt->GetConnections()來獲取。

　　5.客戶調(diào)用pConnPt->Unadvise(m_dwCookie)來取消連接，同時(shí)調(diào)用pConnPt->Release()釋放連接點(diǎn)對(duì)象。
2、編程實(shí)例

　　現(xiàn)在用MFC實(shí)現(xiàn)一個(gè)可連接對(duì)象，然后寫一個(gè)極為簡(jiǎn)單的客戶和時(shí)間接收器。

　　需要說明的是，MFC通過CCmdTarget類實(shí)現(xiàn)了IConnectionPointContainer和IEnumConnectionPoints接口,此外，通過CConnectionPoint類實(shí)現(xiàn)了IConnectionPoint接口

　　1.可連接對(duì)象ConnObject

　　在這個(gè)對(duì)象中，實(shí)現(xiàn)一個(gè)一般的COM接口IEventServer，客戶可以使用此接口的方法DoSomething()作一些事情，但主要的是對(duì)象將在此處觸發(fā)事件。SampleConnPoint實(shí)現(xiàn)連接點(diǎn)對(duì)象。

　　　　(1)在GUIDs.h中寫入:

// {EE888B01-EA9C-11d3-97B5-5254AB191930}

static const IID CLSID_ConnObject = //組件ID

{ 0xee888b01, 0xea9c, 0x11d3, { 0x97, 0xb5, 0x52, 0x54, 0xab, 0x19, 0x19, 0x30 } };

// {EE888B02-EA9C-11d3-97B5-5254AB191930}

static const IID IID_IEventServer = //一般的COM接口,客戶使用此接口的方法

//DoSomething()

{ 0xee888b02, 0xea9c, 0x11d3, { 0x97, 0xb5, 0x52, 0x54, 0xab, 0x19, 0x19, 0x30 } };


//// {EE888B03-EA9C-11d3-97B5-5254AB191930}

static const IID IID_IEventSink = //連接點(diǎn)對(duì)象所實(shí)現(xiàn)的連接點(diǎn)接口ID

{ 0xee888b03, 0xea9c, 0x11d3, { 0x97, 0xb5, 0x52, 0x54, 0xab, 0x19, 0x19, 0x30 } };


　　2. 在IConnObject.h中寫入

#include "GUIDs.h"

//聲明IEventServer接口

DECLARE_INTERFACE_(IEventServer,IUnknown)

{

STDMETHOD(DoSomething)()PURE;

};

//聲明出接口,此出接口將由客戶的事件接收器實(shí)現(xiàn)

DECLARE_INTERFACE_(IEventSink,IUnknown)

{

STDMETHOD(EventHandle)()PURE;

};

　　3.添加基類為CCmdTarget的類CConnObject.在類聲明文件CConnObject1.h中加上#include “IConnObject.h”,在類聲明中寫入:

protected:

……

//聲明實(shí)現(xiàn)IEventServer接口的嵌套類

BEGIN_INTERFACE_PART(EventServer,IEventServer)

STDMETHOD(DoSomething)();

END_INTERFACE_PART(EventServer)

DECLARE_INTERFACE_MAP()

//聲明實(shí)現(xiàn)連接點(diǎn)的嵌套類

BEGIN_CONNECTION_PART(CConnObject,SampleConnPoint)

CONNECTION_IID(IID_IEventSink)

END_CONNECTION_PART(SampleConnPoint)

DECLARE_CONNECTION_MAP()

DECLARE_OLECREATE(CConnObject)

　　說明:BEGIN_CONNECTION_PART和END_CONNECTION_PART宏聲明了實(shí)現(xiàn)連接點(diǎn)的嵌套類SampleConnPoint,并且是基于CConnectionPoint類的,如果需要重載CConnectionPoint類的成員函數(shù)或者添加自己的成員函數(shù),可以在這兩個(gè)宏中聲明.這里,CONNECTION_IID宏重載了CConnectionPoint::GetIID()函數(shù).使用DECLARE_CONNECTION-MAP()宏聲明連接點(diǎn)映射表.

　　4.在類CConnObject的實(shí)現(xiàn)文件中寫入

IMPLEMENT_OLECREATE(CConnObject,"ConnObject",

0xee888b01, 0xea9c, 0x11d3, 0x97, 0xb5, 0x52, 0x54, 0xab, 0x19, 0x19, 0x30);

BEGIN_INTERFACE_MAP(CConnObject,CCmdTarget)

INTERFACE_PART(CConnObject,IID_IEventServer,EventServer)

INTERFACE_PART(CConnObject,IID_IConnectionPointContainer,ConnPtContainer)

END_INTERFACE_MAP()

BEGIN_CONNECTION_MAP(CConnObject,CCmdTarget)

CONNECTION_PART(CConnObject,IID_IEventSink,SampleConnPoint)

END_CONNECTION_MAP()

說明:A.必須在接口映射中寫入INTERFACE_PART(CConnObject,IID_IConnectionPointContainer,ConnPtContainer)以實(shí)現(xiàn)IConnectionPointContainer接口.注意,CCmdTarget類內(nèi)嵌有才ConnPtContainer類以實(shí)現(xiàn)IConnectionPointContainer接口,并用m_xConnPtContainer加以記錄.

B.用BEGIN_CONNECTION_MAP和END_CONNECTION_MAP宏實(shí)現(xiàn)連接點(diǎn)映射.CONNECTION_PART定義了實(shí)現(xiàn)連接點(diǎn)的類.

　　5.在CConnObject::CConnObject()中寫入:

EnableConnections();

　　6.實(shí)現(xiàn)IEventServer接口

　　IEventServer接口是基于IUnknown接口的,實(shí)現(xiàn)IUnknown接口的方法這里不在贅述.在實(shí)現(xiàn)文件中寫入:

STDMETHODIMP

CConnObject::XEventServer::DoSomething()

{

//DoSomething

METHOD_PROLOGUE(CConnObject,EventServer)

pThis->FireEvent();

return S_OK;

}

DoSomething()方法可以為客戶提供需要的服務(wù).這里著重的是可連接對(duì)象在此處觸發(fā)客戶事件接收器的事件,FireEvent()函數(shù)是ConnObject類實(shí)現(xiàn)的專門觸發(fā)事件的的函數(shù),代碼如下:

void CConnObject::FireEvent()

{

//獲取連接點(diǎn)上的連接指針隊(duì)列

const CPtrArray* pConnections = m_xSampleConnPoint.GetConnections();

ASSERT(pConnections!=NULL);

int cConnections = pConnections->GetSize();

IEventSink* pIEventSink;

//對(duì)每一個(gè)連接觸發(fā)事件

for(int i = 0; i < cConnections; i++)

{

//獲取客戶事件接收器接口指針

pIEventSink = (IEventSink*)(pConnections->GetAt(i));

ASSERT(pIEventSink!=NULL);

//調(diào)用客戶事件接受器事件處理函數(shù)

//此函數(shù)是出接口定義,由客戶事件接收器實(shí)現(xiàn)的

pIEventSink->EventHandle();

}

}
3、客戶事件接收器(Sink)

　　事件接收器也是COM對(duì)象,也可以用嵌套類來實(shí)現(xiàn),但是它只是客戶的一個(gè)內(nèi)部對(duì)象,所以可以沒有CLSID和類廠.下面示例是一個(gè)對(duì)話框程序,對(duì)話框有三個(gè)按鈕:”連接”(IDC_CONNECT),”斷開”(IDC_DISCONNECT),”事件”(IDC_EVENT).

　　1.創(chuàng)建一個(gè)基于對(duì)話框的工程:ConnClient.

　　2.在CConnClientDlg中首先加入#include “IConnObject.h”,然后在對(duì)話框類聲明中聲明事件接收器嵌套類:

BEGIN_INTERFACE_PART(EventSink,IEventSink)

STDMETHOD(EventHandle)();

END_INTERFACE_PART(EventSink)

同時(shí)聲明幾個(gè)私有變量:

private:

LPCONNECTIONPOINTCONTAINER pConnPtCont;//記錄組件對(duì)象

//IConnectionPointContainer接口指針

LPCONNECTIONPOINT pConnPt;//記錄連接點(diǎn)接口指針

DWORD m_dwCookie;//記錄連接標(biāo)識(shí)

IUnknown* m_pIUnknown;//用以記錄組件對(duì)象IUnknown接口指針

　　3.實(shí)現(xiàn)事件接收器:

STDMETHODIMP_(ULONG)

CConnClientDlg::XEventSink::AddRef()

{

return 1;

}

STDMETHODIMP_(ULONG)

CConnClientDlg::XEventSink::Release()

{

return 0;

}

STDMETHODIMP

CConnClientDlg::XEventSink::QueryInterface(REFIID riid,void** ppvObj)

{

METHOD_PROLOGUE(CConnClientDlg,EventSink)

if(IsEqualIID(riid,IID_IUnknown)

IsEqualIID(riid,IID_IEventSink))

{

*ppvObj = this;

AddRef();

return S_OK;

}

else

{

return E_NOINTERFACE;

}

}

STDMETHODIMP

CConnClientDlg::XEventSink::EventHandle() //此函數(shù)將被可連接對(duì)象調(diào)用

{

::AfxMessageBox("源對(duì)象向事件接收器發(fā)出了的通知!");

return S_OK;

}

　　4.初始化COM庫(kù)并創(chuàng)建組件對(duì)象實(shí)例

　　在CConnClientDlg::OninitDialog()中寫入:

HRESULT hResult;

hResult = ::CoInitialize(NULL);

if(FAILED(hResult))

{

::AfxMessageBox("不能初始化COM庫(kù)!");

return FALSE;

}

m_pIUnknown = NULL;

hResult = ::CoCreateInstance(CLSID_ConnObject,NULL,

CLSCTX_INPROC_SERVER,IID_IUnknown,(void**)&m_pIUnknown);

if(FAILED(hResult))

{

m_pIUnknown = NULL;

::AfxMessageBox("不能創(chuàng)建ConnObject對(duì)象!");

return FALSE;

}

m_dwCookie = 0;//預(yù)置連接標(biāo)識(shí)為0
5.在按鈕”連接”(IDC_CONNECT)的CLICK事件處理函數(shù)void CConnClientDlg::OnConnect()中寫入:

void CConnClientDlg::OnConnect()

{

if(m_dwCookie!=0)

{

return;

}

if(m_pIUnknown!=NULL)

{

HRESULT hResult;

hResult = m_pIUnknown->QueryInterface(IID_IConnectionPointContainer,

(void**)&pConnPtCont);

if(FAILED(hResult))

{

::AfxMessageBox("不能獲取對(duì)象的IConnectionPointContainer接口!");

return;

}

ASSERT(pConnPtCont!=NULL);

hResult = pConnPtCont->FindConnectionPoint(IID_IEventSink,&pConnPt);

if(FAILED(hResult))

{

pConnPtCont->Release();

::AfxMessageBox("不能獲取對(duì)象的IEventSink連接點(diǎn)接口!");

return;

}

ASSERT(pConnPt!=NULL);

//獲取事件接收器指針

IUnknown* pIEventSink;

m_xEventSink.QueryInterface(IID_IUnknown,(void**)&pIEventSink);

//通過連接點(diǎn)接口的Advise方法將事件接收器指針傳給可連接對(duì)象

if(SUCCEEDED(pConnPt->Advise(pIEventSink,&m_dwCookie)))

{

::AfxMessageBox("與可連接對(duì)象ConnObject建立連接成功!");

}

else

{

::AfxMessageBox("不能與ConnObject建立連接!");

}

pConnPt->Release();

pConnPtCont->Release();

return;

}

}


　　上述代碼與可連接對(duì)象的連接點(diǎn)建立連接.

　　6.編寫按鈕”斷開”(IDC_DISCONNECT)的CLICK處理函數(shù)如下:

void CConnClientDlg::OnDisconnect()

{

if(m_dwCookie==0)

{

return;

}

pConnPt->Unadvise(m_dwCookie);

pConnPt->Release();

pConnPtCont->Release();

m_dwCookie = 0;

}

　　7.編寫按鈕”事件”(IDC_EVENT)的CLICK處理函數(shù):

void CConnClientDlg::OnEvent()

{

if(m_pIUnknown!=NULL)

{

IEventServer* pIEventServer;

HRESULT hResult;

hResult = m_pIUnknown->QueryInterface(IID_IEventServer,(void**)&pIEventServer);

if(FAILED(hResult))

{

::AfxMessageBox("不能獲取IEventServer接口!");

return;

}

pIEventServer->DoSomething();

}

}

　　這里,客戶調(diào)用組件提供的服務(wù)DoSomething(),而正如前面所看到的,組件對(duì)象將在這個(gè)函數(shù)中觸發(fā)一個(gè)由客戶事件接收器處理(CConnClientDlg::XEventSink::EventHandle())的事件.

　　8.在退出應(yīng)用時(shí):

void CConnClientDlg::OnCancel()

{

m_pIUnknown->Release();

::CoUninitialize();

CDialog::OnCancel();

}

　　運(yùn)行程序后,首先點(diǎn)擊”連接”,然后點(diǎn)擊”事件”按鈕,這時(shí)將彈出MessageBox,并提示” 源對(duì)象向事件接收器發(fā)出了的通知!”.

　　小結(jié)

　　正是由于有了可連接對(duì)象這一機(jī)制,實(shí)現(xiàn)了客戶與組件對(duì)象的雙向通信,使組件對(duì)象具有了事件機(jī)制.這種類似于”服務(wù)器推送(Server push)”的技術(shù)在分布式應(yīng)用系統(tǒng)中十分重要.

　　本文所舉示例是用基于IUnknown接口實(shí)現(xiàn)的,其實(shí),用自動(dòng)化接口IDispatch作為出接口更為方便.需要說明的是,用ATL來寫可連接對(duì)象更為簡(jiǎn)潔,MSDN文檔中有一個(gè)示例.