COM 組件設計與應用（六）-- 用 ATL 寫第一個組件

COM 組件設計與應用（六）
用 ATL 寫第一個組件

作者：楊老師

下載源代碼

一、前言

　　1、與 《COM 組件設計與應用(五)》的內容基本一致。但本回講解的是在 vc.Net 2003 下的使用方法，即使你不再使用vc6.0，也請和上一回的內容，參照比對。
　　2、這第一個組件，除了所有 COM 組件必須的 IUnknown 接口外，我們再實現一個自己定義的接口 IFun，它有兩個函數： Add()完成兩個數值的加法，Cat()完成兩個字符串的連接。
　　3、下面......好好聽講! 開始了:-)
　

二、建立 ATL 工程

　　步驟2.1：建立一個解決方案。
　　步驟2.2：在 該解決方案中，新建一個 vc++ 的 ATL 項目。示例程序叫 Simple2，並選擇DLL方式，見圖一、圖二。


圖一、新建 ATL 項目


圖二、選擇非屬性化的DLL組件類型

　　屬性化 屬性化編程，是未來的方向，但我們現在先不要選它。
　　動態鏈接庫(DLL) 選擇它。
　　可執行文件(EXE) 以後再講。
　　服務(EXE) 表示建立一個系統服務組件程序，系統啟動後就會加載並執行的程序。

　　允許合並代理/存根(stub)代碼 選擇該項表示把“代理/存根”代碼合並到組件程序中，否則需要單獨編譯，單獨注冊代理存根程序。代理/存根，這個是什麼概念？還記得我們在上回書中介紹的嗎？當調用者調用進程外或遠程組件功能的時候，其實是代理/存根負責數據交換的。關於代理/存根的具體變成和操作，以後再說啦......
　　支持 MFC 除非有特殊的原因，我們寫 ATL 程序，最好不要選擇該項。你可能會說，如果沒有MFC的支持，那CString怎麼辦呀？告訴你個秘密吧，一般人我都不告訴他，我後半輩子就靠著這個秘密活著了：
　　1、你會STL嗎？可以用 STL 中的 string 代替；
　　2、自己寫個 MyString 類，嘿嘿；
　　3、悄悄地、秘密地、不要告訴別人（特別是別告訴微軟），把 MFC 中的 CString 源碼拿過來用；
　　4、使用 CComBSTR 類，至少也能簡化我們字符串操作；
　　5、直接用 API 操作字符串，反正我們大家學習 C 語言的時候，都是從這裡干起的。（等於沒說，呵呵）
　　支持 COM+ 1.0 支持事務處理的 COM+ 功能。COM+ 也許在第 99 回介紹吧。


三、添加 ATL 對象類

　　步驟3.1：菜單"項目\添加類..."（或者用鼠標右鍵在 項目中彈出菜單"添加\添加類..."）並選擇 ATL 簡單對象。見圖三。


圖三、選擇建立ATL簡單對象

　　除了簡單對象(只實現了 IUnknown 接口)，還可以選擇“ATL控件”(ActiveX，實現了10多個接口)......可以選擇的組件對象類型很多，但本質上，就是讓向導幫我們默認加上一些接口。在以後的文章中，陸續介紹吧。

　　步驟3.2：增加自定義類 CFun(接口 IFun) ,見圖四。

 

圖四、填寫名稱

　　其實，我們只需要輸入簡稱，其它的項目會自動填寫。沒什麼多說的，只請大家注意一下 ProgID 項，默認的 ProgID 構造方式為“項目名.簡稱名”。

　　步驟3.3：填寫接口屬性選項，見圖 五。


圖五、接口選項

　　線程模型 COM 中的線程，我認為是最討厭，最復雜的部分。COM 線程和公寓的概念，留待後續介紹。現在嗎......大家都選"單元"(Apartment)，它代表什麼那？簡單地說：當在線程中調用組件函數的時候，這些調用會排隊進行。因此，這種模式下，我們可以暫時不用考慮同步的問題。(注1)
　　接口。雙重(Dual)，這個非常 非常重要，非常非常常用，但我們今天不講(注2)。切記！切記！我們的這第一個 COM 程序中，一定要選擇“自定義”！！！！（如果你選錯了，請刪除全部內容，重新來過。）
　　聚合 我們寫的組件，將來是否允許被別人聚合(注3)使用。“只能創建為聚合”，有點類似 C++ 中的純虛類，你要是總工程師，只負責設計但不親自寫代碼的話，才選擇它。
　　ISupportErrorInfo 是否支持豐富信息的錯誤處理接口。以後就講。
　　連接點 是否支持連接點接口（事件、回調）。以後就講。
　　IObjectWithSite 是否支持IE的調用


四、添加接口函數


圖六、調出增加接口方法的菜單

圖七、增加接口函數 Add

　　請按照圖示的方法，增加Add()函數，增加Cat()函數 。[in]表示參數方向是輸入；[out]表示參數方向是輸出；[out,retval]表示參數方向是輸出，同時可以作為函數運算結果的返回值。一個函數中，可以有多個[in]、[out]，但[retval]只能有一個，並且要和[out]組合後在最後一個位置。(注4)


圖八、接口函數定義完成後的圖示

　　我們都知道，要想改變 C++ 中的類函數，需要修改兩個地方：一是頭文件(.h)中類的函數聲明，二是函數體(.cpp)文件的實現處。而我們現在用 ATL 寫組件程序，則還要修改一個地方，就是接口定義(IDL)文件。別著急 IDL 下次就要討論啦。


五、實現接口函數

　　鼠標雙點圖八中CFun\基項和接口\Add(...)就可以開始輸入函數實現了：

STDMETHODIMP CFun::Add(long n1, long n2, long *pVal){	*pVal = n1 + n2;	return S_OK;}

這個太簡單了，不再浪費“口條”。下面我們實現字符串連接的Cat()函數：

STDMETHODIMP CFun::Cat(BSTR s1, BSTR s2, BSTR *pVal){	int nLen1 = ::SysStringLen( s1 );	// s1 的字符長度	int nLen2 = ::SysStringLen( s2 );	// s2 的字符長度	*pVal = ::SysAllocStringLen( s1, nLen1 + nLen2 );// 構造新的 BSTR 同時把 s1 先保存進去	if( nLen2 )	{		::memcpy( *pVal + nLen1, s2, nLen2 * sizeof(WCHAR) );	// 然後把 s2 再連接進去//		wcscat( *pVal, s2 );	}	return S_OK;}

學生：上面的函數實現，完全是調用基本的 API 方式完成的。
老師：是的，說實話，的確比較煩瑣。
學生：我們是用memcpy()完成連接第二個字符串功能的，那麼為什麼不用函數 wcscat()那？
老師：多數情況下可以，但你需要知道：由於BSTR包含有字符串長度，因此實際的BSTR字符串內容中是可以存儲L''''\0''''的，而函數 wcscat() 是以L''''\0''''作為復制結束標志，因此可能會丟失數據。明白了嗎？
學生：明白，明白。我看過《COM 組件設計與應用(三)之數據類型》後就明白了。那麼老師，有沒有簡單一些的方法那？
老師：有呀，你看......

STDMETHODIMP CFun::Cat(BSTR s1, BSTR s2, BSTR *pVal){	CComBSTR sResult( s1 );	sResult.AppendBSTR( s2 );	*pVal = sResult.Copy();//	*pVal = sResult.Detach();	return S_OK;}

學生：哈哈，好！使用了 CComBSTR，這個就簡單多了。CComBSTR::Copy()和CComBSTR::Detach()有什麼區別？
老師：CComBSTR::Copy() 會制造一個 BSTR 的副本，另外CComBSTR::CopyTo()也有類似功能。

而CComBSTR::Detach()是使對象與內部的 BSTR 指針剝離，這個函數由於沒有復制過程，因此速度稍微快一點點。但要注意，一但剝離後，就不能再使用該對象啦。
學生：老師，您講的太牛啦，我對您的敬仰如巍巍泰山，直入雲霄......
老師：STOP，STOP！留作業啦......
　　1、自己先按照今天講的內容寫出這個組件；
　　2、不管你懂不懂，一定要去觀察 IDL 文件，CPP 文件；
　　3、編譯後，看都產生了些什麼文件？如果是文本的文件，就打開看看；
　　4、下載本文的示例程序(vc.Net 2003版本)編譯運行，看看效果。然後預習一下示例程序中的調用方法；
學生：知道啦，快下課吧，我要上廁所，我都憋的不行了......
老師：下課！別忘了頂我的帖子呀......


六、小結

　　本回介紹第一個ATL組件程序的建立步驟，而如何使用該組件，敬請關注《COM 組件設計與應用(七)》。

---

注1：Apartment，系統通過隱藏的窗口消息來排隊組件調用，因此我們可以暫時不考慮同步問題。注意，是暫時哈。
注2：雙接口表示在一個接口中，同時支持自定義接口和 IDispatch 接口。以後，以後，以後就講。因為雙接口非常重要，我們以後會天天講、夜夜講、常常講------簡稱“三講”:)
注3：組件的重用方法有2個，聚合和包容。
注4：這些都是 IDL 文件中的概念，以後用到什麼，就介紹什麼。