COM 組件設計與應用(五)——用 ATL 寫第一個組件

1、前言

　　一、若是你在使用 vc5.0 及之前的版本，請你升級爲 vc6.0 或 vc.net 2003；

　　二、若是你在使用 vc6.0 (ATL 3.0)請閱讀本回內容；

　　三、若是你在使用 vc.net(ATL 7.0)請閱讀下回內容；(固然讀讀本文內容也不錯)

　　四、這第一個組件，除了全部 COM 組件必須的 IUnknown 接口外，咱們再實現一個本身定義的接口 IFun，它有兩個函數： Add()完成兩個數值的加法，Cat()完成兩個字符串的鏈接。

　　五、下面......好好聽講! 開始了:-)

　　2、創建 ATL 工程

　　步驟2.1：創建一個工做區(WorkSpace)。

　　步驟2.2：在工做區中，創建一個 ATL 工程(Project)。示例程序叫 Simple1，並選擇DLL方式，見圖一。

　　圖1、創建 ATL DLL 工程

　　Dynamic Link Library(DLL) 表示創建一個 DLL 的組件程序。

　　Executable(EXE) 表示創建一個 EXE 的組件程序。

　　Service(EXE) 表示創建一個服務程序，系統啓動後就會加載並執行的程序。

　　Allow merging of proxy/stub code 選擇該項表示把「代理/存根」代碼合併到組件程序中，不然須要單獨編譯，單獨註冊代理存根程序。代理/存根，這個是什麼概念？還記得咱們在上回書中介紹的嗎？當調用者調用進程外或遠程組件功能的時候，實際上是代理/存根負責數據交換的。關於代理/存根的具體變成和操做，之後再說啦......

　　Support MFC 除非有特殊的緣由，咱們寫 ATL 程序，最好不要選擇該項。你可能會說，若是沒有MFC的支持，那CString怎麼辦呀？告訴你個祕密吧，通常人我都不告訴他，我後半輩子就靠着這個祕密活着了：

　　一、你會STL嗎？能夠用 STL 中的 string 代替；

　　二、本身寫個 MyString 類，嘿嘿；

　　三、悄悄地、祕密地、不要告訴別人（特別是別告訴微軟），把 MFC 中的 CString 源碼拿過來用；

　　四、使用 CComBSTR 類，至少也能簡化咱們字符串操做；

　　五、直接用 API 操做字符串，反正咱們你們學習 C 語言的時候，都是從這裏幹起的。（等於沒說，呵呵）

　　Support MTS 支持事務處理，也就是是否支持 COM+ 功能。COM+ 也許在第 99 回介紹吧。

　　3、增長 ATL 對象類

　　步驟3.1：菜單 Insert\New ATL Object...（或者用鼠標右鍵在 ClassView 卡片中彈出菜單）並選擇Object 分類，選中 Simple Object 項目。見圖二。

　　圖2、選擇創建簡單COM對象

　　Category Object 普通組件。其中能夠選擇的組件對象類型不少，但本質上，就是讓嚮導幫咱們默認加上一些接口。好比咱們選 "Simple Object"，則嚮導給咱們的組件加上 IUnknown 接口；咱們選 "Internet Explorer Object"，則嚮導除了加上 IUnknown 接口外，再增長一個給 IE 所使用的 IObjectWithSite 接口。固然了，咱們徹底能夠手工增長任何接口。

　　Category Controls ActiveX 控件。其中能夠選擇的 ActiveX 類型也不少。咱們在後續的專門介紹 ActiveX 編程中再討論。

　　Category Miscellaneous 輔助雜類組件。

　　Categroy Data Access 數據庫類組件(我最討厭數據庫編程了，因此我也不會)。

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

　　圖3、輸入類中的各項名稱

　　其實，咱們只須要輸入短名(Short Name)，其它的項目會自動填寫。沒什麼多說的，只請你們注意一下 ProgID 項，默認的 ProgID 構造方式爲「工程名.短名」。

　　步驟3.3：填寫接口屬性，見圖四。

　　圖4、接口屬性

　　Threading Model 選擇組件支持的線程模型。COM 中的線程，我認爲是最討厭，最複雜的部分。COM 線程和公寓的概念，留待後續介紹。如今嗎......你們都選 Apartment，它表明什麼那？簡單地說：當在線程中調用組件函數的時候，這些調用會排隊進行。所以，這種模式下，咱們能夠暫時不用考慮同步的問題。(注1)

　　Interface 接口基本類型。Dual 表示支持雙接口(注2)，這個很是 很是重要，很是很是經常使用，但咱們今天不講。Custom 表示自定義藉口。切記！切記！咱們的這第一個 COM 程序中，必定要選擇它！！！！（若是你選錯了，請刪除所有內容，從新來過。）

　　Aggregation 咱們寫的組件，未來是否容許被別人聚合(注3)使用。Only 表示必須被聚合才能使用，有點相似 C++ 中的純虛類，你要是總工程師，只負責設計但不親自寫代碼的話，才選擇它。

　　Support ISupportErrorInfo 是否支持豐富信息的錯誤處理接口。之後就講。

　　Support Connection Points 是否支持鏈接點接口（事件、回調）。之後就講。

　　Free Threaded Marshaler 之後也不講，就算打死你，我也不說！(注4)

　　4、添加接口函數

　　圖5、調出增長接口方法的菜單

　　圖6、增長接口函數 Add

　　圖7、增長接口函數 Cat

　　請嚴格按照圖六的方式，增長Add()函數；因爲圖七中增長Cat()函數的參數比較長，我沒有適當的輸入空格，請你們本身輸入的時候注意一下。[in]表示參數方向是輸入；[out]表示參數方向是輸出；[out,retval]表示參數方向是輸出，同時能夠做爲函數運算結果的返回值。一個函數中，能夠有多個[in]、[out]，但[retval]只能有一個，而且要和[out]組合後在最後一個位置。(注5)

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

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

　　因爲 vc6.0 的BUG，致使你們在增長完接口和接口函數後，可能不會向上圖（圖八）所表現的樣式。解決方法：

　　 1 關閉工程，而後從新打開 該方法經常有效
2 關閉 IDE，而後從新運行 　
3 打開 IDL 文件，檢查接口函數是否正確，如不正確請修改 　
4 打開 IDL 文件，隨便修改一下(加一個空格，再刪除這個空格)，而後保存 該方法經常有效
5 打開 h/cpp 文件，檢查函數是否存在或是否正確，有則改之 無則嘉勉，不說完這個成語心理彆扭
6 刪除 IDL/H/CPP 中的接口函數，而後 再來一遍
7 從新創建工程、從新安裝vc、從新安裝windows、砸計算機 砸！

　　5、實現接口函數

　　鼠標雙點圖八中CFun\IFun\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！留做業啦......
　　 一、本身先按照今天講的內容寫出這個組件；
　　 二、無論你懂不懂，必定要去觀察 IDL 文件，CPP 文件；
　　 三、編譯後，看都產生了些什麼文件？若是是文本的文件，就打開看看；
　　 四、下載本文的示例程序(vc6.0版本)編譯運行，看看效果。而後預習一下示例程序中的調用方法；
學生：知道啦，快下課吧，我要上廁所，我都憋的不行了......
老師：下課！別忘了頂個人帖子呀......

6、小結

　　本回介紹第一個ATL組件程序的創建步驟，而如何使用該組件，敬請關注《COM 組件設計與應用(七)》。 　 -------------------------------------------------------------------------------- 注1：Apartment，系統經過隱藏的窗口消息來排隊組件調用，所以咱們能夠暫時不考慮同步問題。注意，是暫時哈。 注2：雙接口表示在一個接口中，同時支持自定義接口和 IDispatch 接口。之後，之後，之後就講。由於雙接口很是重要，咱們之後會每天講、夜夜講、經常講------簡稱「三講」:) 注3：組件的重用方法有2個，聚合和包容。 注4：名稱的功能很好聽，但微軟根本就沒有實現。 注5：這些都是 IDL 文件中的概念，之後用到什麼，就介紹什麼。