COM對象與連接點機制及其MFC程序實現

楊寧

　　本文首先論述可連接對象和連接點機制的原理，然后通過一個示例說明怎樣用MFC編程實現可連接對象和內嵌于客戶的事件接收器.

　　1、可連接對象和連接點機制的基本原理

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

　　所謂出接口也是COM接口。每個出接口包含一組成員函數，每個成員函數代表了一個事件、一個通知或者一個請求。但是這些接口是在客戶的事件接收器（sink）中實現的，所以叫出接口。事件接收器也是COM對象。

　　可連接對象必須實現一個IConnectionPointContainer接口用于管理所有的出接口。每個出接口對應一個連接點對象，連接點對象實現了IConnectionPoint接口?？蛻粽峭ㄟ^IConnectionPoint接口與可連接對象建立連接。每一個連接用CONNECTDATA結構描述。

　　CONNECTDATA包含兩個成員：IUnknown* pUnk和DWORD dwCookie。pUnk對應于客戶中事件接收器的IUnknown接口指針；dwCookie是由連接點對象生成的用于唯一標識此連接的32位整數。

　　通過一個由可連接對象實現的枚舉器接口IEnumConnectionPoints，客戶可以訪問可連接對象的所有連接點。但是要獲得IEnumConnectionPoints接口指針，要通過IConnectionPointContainer：：EnumConnectionPoints（IEnumConnectionPoints**）函數，此函數返回枚舉器接口指針。

　　通過另一個有可連接對象實現的枚舉器接口IEnumConnections，無論客戶還是可連接對象都可以訪問一個連接點上的所有連接。通過IConnectionPoint：：EnumConnections（IEnumConnections**）函數可以獲得IEnumConnections接口指針。

　　綜上所述，一個可連接對象必須實現四個接口：IConnectionPointContainer、IConnectionPoint、IEnumConnectionPoints、IEnumConnections。這四個接口的定義請閱讀MSDN文檔。

　　現在結合后面的示例簡單描述一下可連接對象和客戶通信的過程。在后面的示例中，可連接對象ConnObject定義了出接口IEventSink,對應此出接口，實現了一個連接點對象SampleConnPoint(此對象實現了對應于出接口的連接點接口IConnectionPoint，接口ID為IID_IEventSink)。

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

　　2.調用pConnPtCont->FindConnectionPoint(IID_IEventSink,&pConnPt)。如果調用成功，pConnPt將存放對應于出接口IEventSink的連接點對象SampleConnPoint所實現的連接點接口IConnectionPoint指針；如果調用不成功，說明可連接對象不支持出接口IEventSink。

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

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

　　5.客戶調用pConnPt->Unadvise(m_dwCookie)來取消連接，同時調用pConnPt->Release()釋放連接點對象。
2、編程實例

　　現在用MFC實現一個可連接對象，然后寫一個極為簡單的客戶和時間接收器。

　　需要說明的是，MFC通過CCmdTarget類實現了IConnectionPointContainer和IEnumConnectionPoints接口,此外，通過CConnectionPoint類實現了IConnectionPoint接口

　　1.可連接對象ConnObject

　　在這個對象中，實現一個一般的COM接口IEventServer，客戶可以使用此接口的方法DoSomething()作一些事情，但主要的是對象將在此處觸發事件。SampleConnPoint實現連接點對象。

　　　　(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 = //連接點對象所實現的連接點接口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;

};

//聲明出接口,此出接口將由客戶的事件接收器實現

DECLARE_INTERFACE_(IEventSink,IUnknown)

{

STDMETHOD(EventHandle)()PURE;

};

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

protected:

……

//聲明實現IEventServer接口的嵌套類

BEGIN_INTERFACE_PART(EventServer,IEventServer)

STDMETHOD(DoSomething)();

END_INTERFACE_PART(EventServer)

DECLARE_INTERFACE_MAP()

//聲明實現連接點的嵌套類

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宏聲明了實現連接點的嵌套類SampleConnPoint,并且是基于CConnectionPoint類的,如果需要重載CConnectionPoint類的成員函數或者添加自己的成員函數,可以在這兩個宏中聲明.這里,CONNECTION_IID宏重載了CConnectionPoint::GetIID()函數.使用DECLARE_CONNECTION-MAP()宏聲明連接點映射表.

　　4.在類CConnObject的實現文件中寫入

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)以實現IConnectionPointContainer接口.注意,CCmdTarget類內嵌有才ConnPtContainer類以實現IConnectionPointContainer接口,并用m_xConnPtContainer加以記錄.

B.用BEGIN_CONNECTION_MAP和END_CONNECTION_MAP宏實現連接點映射.CONNECTION_PART定義了實現連接點的類.

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

EnableConnections();

　　6.實現IEventServer接口

　　IEventServer接口是基于IUnknown接口的,實現IUnknown接口的方法這里不在贅述.在實現文件中寫入:

STDMETHODIMP

CConnObject::XEventServer::DoSomething()

{

//DoSomething

METHOD_PROLOGUE(CConnObject,EventServer)

pThis->FireEvent();

return S_OK;

}

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

void CConnObject::FireEvent()

{

//獲取連接點上的連接指針隊列

const CPtrArray* pConnections = m_xSampleConnPoint.GetConnections();

ASSERT(pConnections!=NULL);

int cConnections = pConnections->GetSize();

IEventSink* pIEventSink;

//對每一個連接觸發事件

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

{

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

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

ASSERT(pIEventSink!=NULL);

//調用客戶事件接受器事件處理函數

//此函數是出接口定義,由客戶事件接收器實現的

pIEventSink->EventHandle();

}

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

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

　　1.創建一個基于對話框的工程:ConnClient.

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

BEGIN_INTERFACE_PART(EventSink,IEventSink)

STDMETHOD(EventHandle)();

END_INTERFACE_PART(EventSink)

同時聲明幾個私有變量:

private:

LPCONNECTIONPOINTCONTAINER pConnPtCont;//記錄組件對象

//IConnectionPointContainer接口指針

LPCONNECTIONPOINT pConnPt;//記錄連接點接口指針

DWORD m_dwCookie;//記錄連接標識

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

　　3.實現事件接收器:

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() //此函數將被可連接對象調用

{

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

return S_OK;

}

　　4.初始化COM庫并創建組件對象實例

　　在CConnClientDlg::OninitDialog()中寫入:

HRESULT hResult;

hResult = ::CoInitialize(NULL);

if(FAILED(hResult))

{

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

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("不能創建ConnObject對象!");

return FALSE;

}

m_dwCookie = 0;//預置連接標識為0
5.在按鈕”連接”(IDC_CONNECT)的CLICK事件處理函數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("不能獲取對象的IConnectionPointContainer接口!");

return;

}

ASSERT(pConnPtCont!=NULL);

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

if(FAILED(hResult))

{

pConnPtCont->Release();

::AfxMessageBox("不能獲取對象的IEventSink連接點接口!");

return;

}

ASSERT(pConnPt!=NULL);

//獲取事件接收器指針

IUnknown* pIEventSink;

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

//通過連接點接口的Advise方法將事件接收器指針傳給可連接對象

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

{

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

}

else

{

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

}

pConnPt->Release();

pConnPtCont->Release();

return;

}

}


　　上述代碼與可連接對象的連接點建立連接.

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

void CConnClientDlg::OnDisconnect()

{

if(m_dwCookie==0)

{

return;

}

pConnPt->Unadvise(m_dwCookie);

pConnPt->Release();

pConnPtCont->Release();

m_dwCookie = 0;

}

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

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();

}

}

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

　　8.在退出應用時:

void CConnClientDlg::OnCancel()

{

m_pIUnknown->Release();

::CoUninitialize();

CDialog::OnCancel();

}

　　運行程序后,首先點擊”連接”,然后點擊”事件”按鈕,這時將彈出MessageBox,并提示” 源對象向事件接收器發出了的通知!”.

　　小結

　　正是由于有了可連接對象這一機制,實現了客戶與組件對象的雙向通信,使組件對象具有了事件機制.這種類似于”服務器推送(Server push)”的技術在分布式應用系統中十分重要.

　　本文所舉示例是用基于IUnknown接口實現的,其實,用自動化接口IDispatch作為出接口更為方便.需要說明的是,用ATL來寫可連接對象更為簡潔,MSDN文檔中有一個示例.

原文轉自：http://www.kjueaiud.com