如何初始化同COM交互的線程?
通常如果沒有初始化線程會顯示如下的錯誤信號:"CoInitialize has not been called" (800401F0 ) 。
問題在于每個同COM交互的線程必須使自身初始化并進入一個Apartment??梢酝ㄟ^加入一個單線程的 Apartment (STA)獲得,也可以進入一個多線程的Apartment (MTA)。
STA是基于Windows的消息隊列實現(xiàn)系統(tǒng)同步的。當COM對象或線程是依賴于線程相關的對象時,比如界面元素,就應該使用STA,下面演示如何初始化一個線程進入STA:
procedure FooThreadFunc;
Begin
CoInitializeEx (NIL, COINIT_APARTMENTTHREADED);
... ...
CoUninitialize;
end;
處于MTA的對象則可以隨時隨地收到用戶的調用,對象同界面元素無關時應該使用MTA模式,但一定要小心地控制同步,下面是演示如何初始化一個進入MTA的線程:
procedure FooThreadFunc;
begin
CoInitializeEx (NIL, COINIT_MULTITHREADED);
... ...
CoUninitialize;
end;
實現(xiàn)、跨越Apartment列集接口指針
在運行COM Server時經常會遇到"The application called an interface that was marshaled for a different thread" (8001010E)這類錯誤,它是如何產生的呢?
在Apartment之間傳遞接口指針的時候,如果沒有執(zhí)行Marshal(列集),就會破壞COM的線程規(guī)則,引起這個錯誤。列集接口指針需要使用CoMarshalInterface 和CoUnmarshalInterface函數(shù)。但實際使用時,我們更多的是用更簡單的CoMarshalInterThreadInterfaceInStream 和 CoGetInterfaceAndReleaseStream API。
下面的代碼演示了如何在基于不同Aparment的Foo1和Foo2線程之間列集一個接口指針:
var MarshalStream : pointer;
//源線程
procedure Foo1ThreadFunc; //或者TFoo1.Execute
var Foo : IFoo;
begin
//假設Foo2Thread正處于暫停狀態(tài)
CoInitializeEx (...);
Foo := CoFoo.Create;
//列集
CoMarshalInterThreadInterfaceInStream (IFoo, Foo, IStream (MarshalStream));
//告訴Foo2Thread 列集完畢
Foo2Thread.Resume;
CoUninitialize;
end;
//用戶線程
procedure Foo2ThreadFunc; //或TFoo2.Execute
var Foo : IFoo;
begin
CoInitializeEx (...);
//逆列集
CoGetInterfaceAndReleaseStream (IStream (MarshalStream), IFoo, Foo);
MarshalStream := NIL;
//使用Foo
Foo.Bar;
CoUninitialize;
end;
上面的列集技術是列集一次然后逆列集一次。如果我們想列集一次然后多次逆列集的話,可以使用(NT 4 SP3) COM提供的全局接口表(Global Interface Table,GIT)。GIT允許列集一個接口指針到一個cookie,然后使用這個Cookie來多次逆列集。使用GIT的話,上面的例子要修改為:
const
CLSID_StdGlobalInterfaceTable : TGUID =
'{00000323-0000-0000-C000-000000000046}';
type
IGlobalInterfaceTable = interface(IUnknown)
['{00000146-0000-0000-C000-000000000046}']
function RegisterInterfaceInGlobal (pUnk : IUnknown; const riid: TIID;
out dwCookie : DWORD): HResult; stdcall;
function RevokeInterfaceFromGlobal (dwCookie: DWORD): HResult; stdcall;
function GetInterfaceFromGlobal (dwCookie: DWORD; const riid: TIID; out ppv): HResult; stdcall;
end;
function GIT : IGlobalInterfaceTable;
const
cGIT : IGlobalInterfaceTable = NIL;
begin
if (cGIT = NIL) then
OleCheck (CoCreateInstance (CLSID_StdGlobalInterfaceTable, NIL, CLSCTX_ALL,
IGlobalInterfaceTable, cGIT));
Result := cGIT;
end;
var MarshalCookie : dword;
//源線程
procedure Foo1ThreadFunc;
var Foo : IFoo;
begin
CoInitializeEx (...);
Foo := CoFoo.Create;
//列集
GIT.RegisterInterfaceInGlobal (Foo, IFoo, MarshalCookie)
//告訴Foo2Thread MarshalCookie已經準備好了
Foo2Thread.Resume;
CoUninitialize;
end;
//用戶線程
procedure Foo2ThreadFunc;
var Foo : IFoo;
begin
CoInitializeEx (...);
//逆列集
GIT.GetInterfaceFromGlobal (MarshalCookie, IFoo, Foo)
//調用Foo
Foo.Bar;
CoUninitialize;
end;
另外當不需要列集的時候,不要忘了從GIT中刪除指針:
GIT.RevokeInterfaceFromGlobal (MarshalCookie);
MarshalCookie := 0;
下面實現(xiàn)了一個TGIP類可以簡化調用:
{ TGlobalInterfacePointer
用法:假定有一個接口指針pObject1,想使接口Iobject1全局化可以使用下面的代碼
var
GIP1: TGIP;
begin
GIP1 := TGIP.Create (pObject1, IObject1);
end;
如果想使pObject1本地化,需要直接存取GIP1 對象變量:
var
pObject1: IObject1;
begin
GIP1.GetIntf (pObject1);
pObject1.DoSomething;
end;
}
下面是TGIP類的實現(xiàn):
TGIP = class
protected
FCookie: DWORD;
FIID: TIID;
function IsValid: boolean;
public
constructor Create (const pUnk: IUnknown; const riid: TIID);
destructor Destroy; override;
procedure GetIntf (out pIntf);
procedure RevokeIntf;
procedure SetIntf (const pUnk: IUnknown; const riid: TIID);
property Cookie: dword read FCookie;
property IID: TGUID read FIID;
end;
{ TGIP }
function TGIP.IsValid: boolean;
begin
Result := (FCookie <> 0);
end;
constructor TGIP.Create (const pUnk: IUnknown; const riid: TIID);
begin
inherited Create;
SetIntf (pUnk, riid);
end;
destructor TGIP.Destroy;
begin
RevokeIntf;
inherited;
end;
procedure TGIP.GetIntf (out pIntf);
begin
Assert (IsValid);
OleCheck (GIT.GetInterfaceFromGlobal (FCookie, FIID, pIntf));
end;
procedure TGIP.RevokeIntf;
begin
if not (IsValid) then Exit;
OleCheck (GIT.RevokeInterfaceFromGlobal (FCookie));
FCookie := 0;
FIID := GUID_NULL;
end;
procedure TGIP.SetIntf (const pUnk: IUnknown; const riid: TIID);
begin
Assert ((pUnk <> NIL) and not (IsEqualGuid (riid, GUID_NULL)));
RevokeIntf;
OleCheck (GIT.RegisterInterfaceInGlobal (pUnk, riid, FCookie));
FIID := riid;
end;
實現(xiàn)正確的錯誤處理
在COM中,每個接口方法必須返回一個錯誤代碼給客戶端,錯誤代碼是標準的32位數(shù)值,也就是我們所熟悉的HRESULT。HRESULT數(shù)值可以分為幾部分:一位用于表示成功或失敗,幾位用于表示錯誤分類,剩下幾位用于表示錯誤代號(COM推薦錯誤代碼應該在0200到FFFF 范圍內。
雖然HRESULT可以用來指示錯誤,但是它也有很大的局限性,因為除了錯誤代碼,我們可能還想讓COM服務器告訴客戶端錯誤的詳細描述、發(fā)生位置以及客戶在哪兒可以得到更多的相關幫助(通過指定幫助上下文來調用幫助文件)。因此,COM引入了IErrorInfo接口,客戶端可以通過這個接口來獲得額外的錯誤信息。同時如果COM服務器支持IErrorInfo,COM同時建議服務器實現(xiàn)ISupportErrorInfo接口,雖然這個接口不是必須實現(xiàn)的,但一些客戶端,比如Visual Basic將會向服務器請求這個接口。
Delphi本身已經為我們提供了安全調用處理。當在對象內部產生一個異常時,Delphi會自動俘獲異常并把它轉化為一個COM HRESULT,同時提供一個IErrorInfo 接口用于傳遞給客戶端。這些是通過ComObj單元中的HandleSafeCallException函數(shù)實現(xiàn)的。此外,VCL 類也為我們實現(xiàn)了ISupportErrorInfo 接口。
下面舉例來說,當在服務器內部產生一個Ewhatever的異常時,它總會被客戶端認為是EOleException異常,EOleException異常包括HRESULT 和IErrorInfo 所包含的所有信息,比如錯誤代號、描述、發(fā)生位置以及上下文相關幫助。而為了提供客戶端所需要信息,服務器必須把EWhatever轉化為EoleSysError異常,同時要確保錯誤代碼為格式化好的HRESULT。比如,假設有一個TFoo對象,它有一個Bar方法。在Bar方法中我們想產生一個異常,異常的錯誤代號為5,描述="錯誤消息",幫助文件="HelpFile.hlp",幫助上下文= 1,代碼示意如下:
uses ComServ;
const
CODE_BASE = $200; //推薦代碼在0200 – FFFF之間
procedure TFoo.Bar;
begin
//幫助文件
ComServer.HelpFileName := 'HelpFile.hlp';
//引發(fā)異常
raise EOleSysError.Create (
'錯誤消息', ErrorNumberToHResult (5 + CODE_BASE), //格式化HRESULT
1 //幫助上下文
);
end;
//格式化Hresult
function ErrorNumberToHResult (ErrorNumber : integer) : HResult;
const
SEVERITY_ERROR = 1;
FACILITY_ITF = 4;
Begin
Result := (SEVERITY_ERROR shl 31) or (FACILITY_ITF shl 16) or word (ErrorNumber);
end;
上面的ErrorNumberToHResult函數(shù)就是簡單的把錯誤代號轉化為標準的HRESULT。同時給錯誤代號加上了CODE_BASE (0x200),以便遵循COM的建議,就是使錯誤代碼位于0200到 FFFF之間。
下面是客戶端利用EOleException俘獲錯誤的代碼:
const
CODE_BASE = $200;
procedure CallFooBar;
var
Foo : IFoo;
Begin
Foo := CoFoo.Create;
Try
Foo.Bar;
Except
on E : EOleException do
ShowMessage ('錯誤信息: ' + E.Message + #13 +
'錯誤代號: ' + IntToStr (HResultToErrorNumber (E.ErrorCode) - CODE_BASE) + #13 +
'發(fā)生位置: ' + E.Source + #13 +
'幫助文件: ' + E.HelpFile + #13 +
'幫助上下文: ' + IntToStr (E.HelpContext)
);
end;
end;
function HResultToErrorNumber (hr : HResult) : integer;
begin
Result := (hr and $FFFF);
end;
上述過程其實就是服務器的逆過程,就是從HRESULT中提取錯誤代碼,并顯示額外錯誤信息的過程。
如何實現(xiàn)多重接口
其實非常非常簡單,比如想建立一個COM對象,它已經支持IFooBar接口了,我們還想實現(xiàn)兩個外部接口IFoo和IBar。IFoo和IBar 接口定義如下:
IFoo = interface
procedure Foo; //隱含返回HRESULT
end;
IBar = interface
procedure Bar;
end;
實現(xiàn)部分:
type
TFooBar = class (TAutoObject, IFooBar, IFoo, IBar)
Protected
//IfooBar
... IFooBar methods here ...
//IFoo methods
procedure Foo;
//IBar methods
procedure Bar;
...
end;
procedure TFooBar.Foo;
begin
end;
procedure TFooBar.Bar;
begin
end;
是不是很簡單啊,要注意的是如果IfooBar、IFoo和IBar都是基于IDispatch接口的,TAutoObject 將只會為IFooBar實現(xiàn)IDispatch,基于腳本的客戶端只能看到IFooBar接口方法。
Delphi中定義的COM基類的用途
Delphi提供了很多基類用于COM開發(fā):TInterfacedObject、TComObject、TTypedComObject、TAutoObject、TAutoIntfObject、TComObjectFactory、TTypedComObjectFactory、TAutoObjectFactory等。那么這些類適用于哪些條件下呢?
(1)TInterfacedObject
TInterfacedObject 只提供對IUnknown接口的實現(xiàn),如果想創(chuàng)建一個內部對象來實現(xiàn)內部接口的話,TInterfacedObject 就是一個最好的基類。
(2)TComObject
TComObject實現(xiàn)了IUnknown、ISupportErrorInfo、標準的COM聚集支持和一個對應的類工廠支持。如果我們想創(chuàng)建一個輕量級的可連接客戶端的基于IUnknown接口的COM對象的話,COM對象就應該從TComObject 類繼承。
(3)TComObjectFactory
TComObjectFactory 是同TComObject對象配合工作的。它把對應的TComObject 公開為coclass。TComObjectFactory 提供了coclass 的注冊功能(根據(jù)CLSIDs、ThreadingModel、ProgID等)。還實現(xiàn)了IClassFactory 和 IClassFactory2 接口以及標準的COM 對象許可證支持。簡單地說如果要想創(chuàng)建TComObject對象,就會同時需要TComObjectFactory對象。
(4)TTypedComObject
TTypedComObject等于TComObject + 對IProvideClassInfo接口的支持。IProvideClassInfo 是自動化的標準接口用來公開一個對象的類型信息的(比如可獲得的名字、方法、支持的接口等,類型信息儲存在相關的類型庫中)。TTypedComObject 可以用來支持那些在運行時能夠瀏覽類型信息的客戶端,比如Visual Basic的TypeName 函數(shù)期望一個對象能夠實現(xiàn)IProvideClassInfo 接口,以便通過類型信息確定對象的文檔名稱(documented name)。
(5)TTypedComObjectFactory
TTypedComObjectFactory 是和TTypedComObject配合工作的。就等于TComObjectFactory + 提供緩存了的TTypedComObject類型信息(ITypeInfo)引用。一句話,創(chuàng)建TTypedComObject必然會同時創(chuàng)建TypedComObjectFactory 類工廠。
(6)TAutoObject
TAutoObject 等于TTypedComObject + 實現(xiàn)IDispatch接口。TAutoObject適用于實現(xiàn)支持自動化控制的COM對象。
(7)TAutoObjectFactory
TAutoObjectFactory顯然是同TAutoObject密不可分的。它等于TTypedComObjectFactory + 提供了TAutoObject的接口和連接點事件接口的緩存類型信息 (ITypeInfo)。
(8)TAutoIntfObject
TAutoIntfObject等于TInterfacedObject +實現(xiàn)了IDispatch接口。同TAutoObject相比, TAutoIntfObject 沒有對應的類工廠支持,這意味著外部客戶端無法直接實例化一個TAutoIntfObject的衍生類。然而,TAutoIntfObject 非常適合作為基于IDispatch接口的下層對象或屬性對象,客戶端可以通過最上層的自動化對象得到對它們的引用。
理解列集的概念
在進行COM調用的時候,最經常碰到的錯誤恐怕就是"Interface not supported/registered" (80004002)錯誤了。這通常是由于沒有在客戶端機器上注冊類型庫導致的。
圖1.115 |
COM的位置透明性是通過代理和存根對象來實現(xiàn)的。當一個客戶端調用一個遠程機器上的COM對象(或是另一個Apartment中的COM對象)時,客戶端的請求首先通過代理,然后代理再通過COM,然后再通過存根才到達真正的對象,其關系如圖1.115所示。
每當客戶端調用COM對象的方法時,代理都會把方法參數(shù)整理為一個平直數(shù)組然后再傳遞給COM,而COM再把數(shù)組傳遞給存根,由存根負責解包數(shù)組還原參數(shù),最后服務器對象才會按參數(shù)調用方法,整個過程就成為列集。
注意代理和存根同樣是COM對象,系統(tǒng)提供了一個缺省的存根和代理,它們實現(xiàn)在 oleaut32.dll 中,對于大多數(shù)的列集處理來說,缺省的存根和代理已經足夠用了,但它只能列集那些自動化兼容的數(shù)據(jù)類型的參數(shù)。
在類型庫中,必須注釋接口定義的[oleautomation]標識,表明我們希望使用類型庫列集器來列集我們的接口。[oleautomation]標識適用于任意接口(只要方法參數(shù)全是自動化兼容的),認為它只使用于IDispatch類型接口的想法是不正確的。
由于不能像Visual C++那樣簡單地創(chuàng)建用戶定制的代理-存根DLL,所以Delphi嚴重依賴于類型庫列集器實現(xiàn)列集。同時由于類型庫列集器的列集依賴于類型庫中的信息,所以必須在服務器和客戶端的機器上同時注冊類型庫,否則調用時就會碰到"Interface not supported/registered" 錯誤。
另外,要注意只有當我們使用前期綁定時才需要注冊類型庫。如果使用后期綁定(比如variant或雙接口綁定),COM會調用IDispatch 接口早已注冊在系統(tǒng)中的代理-存根DLL,因此后期綁定時不需要注冊類型庫文件。
如何實現(xiàn)一個支持Visual Basic的For Each調用的COM對象
熟悉Visual Basic和ASP開發(fā)的人一定會很熟悉用Visual Basic的For Each語法調用COM集合對象。
For Each允許一個VB的客戶端很方便地遍歷一個集合中的元素:
Dim Items as Server.IItems //聲明集合變量
Dim Item as Server.IItem //聲明集合元素變量
Set Items = ServerObject.GetItems //獲得服務器的集合對象
//用 For Each循環(huán)遍歷集合元素
For Each Item in Items
Call DoSomething (Item)
Next
那么什么樣的COM對象支持For Each語法呢?答案就是實現(xiàn)IEnumVARIANT COM接口,它的定義如下:
IEnumVARIANT = interface (IUnknown)
function Next (celt; var rgvar; pceltFetched): HResult;
function Skip (celt): HResult;
function Reset: HResult;
function Clone(out Enum): HResult;
end;
For Each語法知道如何調用IEnumVARIANT 接口的方法(特別是Next方法)來遍歷集合中的全部元素。那么如何才能向客戶端公開IEnumVARIANT 接口呢,下面是一個集合接口:
//集合元素
IFooItem = interface (IDispatch);
//元素集合
IFooItems = interface (IDispatch)
property Count : integer;
property Item [Index : integer] : IFoo;
end;
要想使用IEnumVARIANT接口,我們的集合接口首先必須支持自動化(也就是基于IDispatch接口),同時集合元素也必須是自動化兼容的(比如byte、BSTR、long、IUnknown、IDispatch等)。
然后,我們利用類型庫編輯器添加一個名為_NewEnum的只讀屬性到集合接口中,_NewEnum 屬性必須返回IUnknown 接口,同時dispid = -4 (DISPID_NEWENUM)。修改的IFooItems定義如下:
IFooItems = interface (IDispatch)
property Count : integer;
property Item [Index : integer] : IFoo;
property _NewEnum : IUnknown; dispid -4;
end;
接下來我們要實現(xiàn)_NewEnum屬性來返回IEnumVARIANT 接口指針:
下面是一個完整的例子,它創(chuàng)建了一個ASP組件,有一個集合對象用來維護一個email地址列表:
unit uenumdem;
interface
uses
Windows, Classes, ComObj, ActiveX, AspTlb, enumdem_TLB, StdVcl;
type
IEnumVariant = interface(IUnknown)
['{00020404-0000-0000-C000-000000000046}']
function Next(celt: LongWord; var rgvar : OleVariant;
pceltFetched: PLongWord): HResult; stdcall;
function Skip(celt: LongWord): HResult; stdcall;
function Reset: HResult; stdcall;
function Clone(out Enum: IEnumVariant): HResult; stdcall;
end;
TRecipients = class (TAutoIntfObject, IRecipients, IEnumVariant)
protected
PRecipients : TStringList;
Findex : Integer;
Function Get_Count: Integer; safecall;
Function Get_Items(Index: Integer): OleVariant; safecall;
procedure Set_Items(Index: Integer; Value: OleVariant); safecall;
function Get__NewEnum: IUnknown; safecall;
procedure AddRecipient(Recipient: OleVariant); safecall;
function Next(celt: LongWord; var rgvar : OleVariant;
pceltFetched: PLongWord): HResult; stdcall;
function Skip(celt: LongWord): HResult; stdcall;
function Reset : HResult; stdcall;
function Clone (out Enum: IEnumVariant): HResult; stdcall;
public
constructor Create;
constructor Copy(slRecipients : TStringList);
destructor Destroy; override;
end;
TEnumDemo = class(TASPObject, IEnumDemo)
protected
FRecipients : IRecipients;
procedure OnEndPage; safecall;
procedure OnStartPage(const AScriptingContext: IUnknown); safecall;
function Get_Recipients: IRecipients; safecall;
end;
implementation
uses ComServ,
SysUtils;
constructor TRecipients.Create;
begin
inherited Create (ComServer.TypeLib, IRecipients);
PRecipients := TStringList.Create;
FIndex := 0;
end;
constructor TRecipients.Copy(slRecipients : TStringList);
begin
inherited Create (ComServer.TypeLib, IRecipients);
PRecipients := TStringList.Create;
FIndex := 0;
PRecipients.Assign(slRecipients);
end;
destructor TRecipients.Destroy;
begin
PRecipients.Free;
inherited;
end;
function TRecipients.Get_Count: Integer;
begin
Result := PRecipients.Count;
end;
function TRecipients.Get_Items(Index: Integer): OleVariant;
begin
if (Index >= 0) and (Index < PRecipients.Count) then
Result := PRecipients[Index]
else
Result := '';
end;
procedure TRecipients.Set_Items(Index: Integer; Value: OleVariant);
begin
if (Index >= 0) and (Index < PRecipients.Count) then
PRecipients[Index] := Value;
end;
function TRecipients.Get__NewEnum: IUnknown;
begin
Result := Self;
end;
procedure TRecipients.AddRecipient(Recipient: OleVariant);
var
sTemp : String;
begin
PRecipients.Add(Recipient);
sTemp := Recipient;
end;
function TRecipients.Next(celt: LongWord; var rgvar : OleVariant;
pceltFetched: PLongWord): HResult;
type
TVariantList = array [0..0] of olevariant;
var
i : longword;
begin
i := 0;
while (i < celt) and (FIndex < PRecipients.Count) do
begin
TVariantList (rgvar) [i] := PRecipients[FIndex];
inc (i);
inc (FIndex);
end; { while }
if (pceltFetched <> nil) then
pceltFetched^ := i;
if (i = celt) then
Result := S_OK
else
Result := S_FALSE;
end;
function TRecipients.Skip(celt: LongWord): HResult;
begin
if ((FIndex + integer (celt)) <= PRecipients.Count) then
begin
inc (FIndex, celt);
Result := S_OK;
end
else
begin
FIndex := PRecipients.Count;
Result := S_FALSE;
end; { else }
end;
function TRecipients.Reset : HResult;
begin
FIndex := 0;
Result := S_OK;
end;
function TRecipients.Clone (out Enum: IEnumVariant): HResult;
begin
Enum := TRecipients.Copy(PRecipients);
Result := S_OK;
end;
procedure TEnumDemo.OnEndPage;
begin
inherited OnEndPage;
end;
procedure TEnumDemo.OnStartPage(const AScriptingContext: IUnknown);
begin
inherited OnStartPage(AScriptingContext);
end;
function TEnumDemo.Get_Recipients: IRecipients;
begin
if FRecipients = nil then
FRecipients := TRecipients.Create;
Result := FRecipients;
end;
initialization
TAutoObjectFactory.Create(ComServer, TEnumDemo, Class_EnumDemo,
ciMultiInstance, tmApartment);
end.
下面是用來測試ASP組件的ASP腳本:
Set DelphiASPObj = Server.CreateObject("enumdem.EnumDemo")
DelphiASPObj.Recipients.AddRecipient "windows@ms.ccom"
DelphiASPObj.Recipients.AddRecipient "borland@hotmail.com"
DelphiASPObj.Recipients.AddRecipient "delphi@hotmail.com"
Response.Write "使用For Next 結構"
for i = 0 to DelphiASPObj.Recipients.Count-1
Response.Write "DelphiASPObj.Recipients.Items[" & i & "] = " & _
DelphiASPObj.Recipients.Items(i) & ""
next
Response.Write "使用 For Each 結構"
for each sRecipient in DelphiASPObj.Recipients
Response.Write "收信人 : " & sRecipient & ""
next
Set DelphiASPObj = Nothing
上面這個例子中,集合對象儲存的是字符串數(shù)據(jù),其實它可以儲存任意的COM對象,對于COM對象可以用Delphi定義的TInterfaceList 類來管理集合中的COM對象元素。
下面是一個可重用的類TEnumVariantCollection,它隱藏了IEnumVARIANT接口的實現(xiàn)細節(jié)。為了插入TEnumVariantCollection 類到集合對象中去,我們需要實現(xiàn)一個有下列三個方法的接口:
IVariantCollection = interface
//使用枚舉器來鎖定列表擁有者
function GetController : IUnknown; stdcall;
//使用枚舉器來確定元素數(shù)
function GetCount : integer; stdcall;
//使用枚舉器來返回集合元素
function GetItems (Index : olevariant) : olevariant; stdcall;
end;
修改后的TFooItem的定義如下:
type
//Foo items collection
TFooItems = class (TSomeBaseClass, IFooItems, IVariantCollection)
Protected
{ IVariantCollection }
function GetController : IUnknown; stdcall;
function GetCount : integer; stdcall;
function GetItems (Index : olevariant) : olevariant; stdcall;
protected
FItems : TInterfaceList; //內部集合元素列表;
...
end;
function TFooItems.GetController: IUnknown;
begin
//always return Self/collection owner here
Result := Self;
end;
function TFooItems.GetCount: integer;
begin
//always return collection count here
Result := FItems.Count;
end;
function TFooItems.GetItems(Index: olevariant): olevariant;
begin
//獲取IDispatch 接口
Result := FItems.Items [Index] as IDispatch;
end;
最后,我們來實現(xiàn)_NewEnum 屬性:
function TFooItems.Get__NewEnum: IUnknown;
begin
Result := TEnumVariantCollection.Create (Self);
end;
這就是全部要做的工作。
客戶端如何實現(xiàn)對基于IEnumVARIANT-接口的集合對象的枚舉?
前面提到了在Visual Basic中,我們可以用For Each結構很簡單地實現(xiàn)對基于IEnumVARIANT-接口的集合對象的枚舉。那么在Delphi中有沒有辦法實現(xiàn)類似的操作呢?
答案是有兩種方法可以做到,第一種比較困難,它需要我們非常熟悉IEnumVARIANT接口方法的調用,特別是reset和next方法。第二種簡單的則是使用TEnumVariant類,它使用起來非常簡單,代碼示意如下:
uses ComLib;
var
Foo : IFoo;
Item : olevariant;
Enum : TEnumVariant;
Begin
Foo := CreateOleObject ('FooServer.Foo') as IFoo; //or CoFoo.Create
Enum := TEnumVariant.Create (Foo.Items);
while (Enum.ForEach (Item)) do
DoSomething (Item);
Enum.Free;
end;
看起來確實和For Each區(qū)別不大了。
如何使用聚集和包含
COM聚集和包含是兩種重用COM對象的技術。為了弄清為什么需要使用聚集或包含技術,考慮一下下面的情況:假設現(xiàn)在有兩個COM對象Foo (IFoo)和Bar (IBar)。我們想創(chuàng)建一個新的對象FooBar,它提供Foo和Bar兩者的功能。那么我們可以這樣定義新類:
IFoo = interface
procedure Foo;
end;
IBar = interface
procedure Bar;
end;
type
FooBar = class (BaseClass, IFoo, IBar)
end;
然后就是當實現(xiàn)IFoo接口的方法時重用Foo,當實現(xiàn)Ibar接口的時候重用Ibar。這時就需要聚集和包含了。
1. 包含
包含實際上就是初始化一個內部對象,然后把對接口方法的調用請求都傳遞給內部對象,如下為實現(xiàn)對IFoo的包含:
type
TFooBar = class (TComObject, IFoo)
Protected
//IFoo methods
procedure Foo;
protected
FInnerFoo : IFoo;
function GetInnerFoo : IFoo;
end;
procedure TFooBar.Foo;
var
Foo : IFoo;
Begin
//獲得內部Foo對象
Foo := GetInnerFoo;
//傳遞方法請求給內部的Foo對象
Foo.Foo;
end;
function TFooBar.GetInnerFoo : IFoo;
begin
//創(chuàng)建內部的Foo對象
if (FInnerFoo = NIL) then
FInnerFoo := CreateComObject (Class_Foo) as IFoo;
Result := FInnerFoo;
end;
如果我們按下面定義實現(xiàn)類的話,由于沒有代理接口請求,所以不能認為是包含:
type
TFooBar = class (TComObject, IFoo)
Protected
function GetInnerFoo : IFoo;
property InnerFoo : IFoo read GetInnerFoo implements IFoo;
end;
先前的實現(xiàn)和現(xiàn)在的不同在于代理的問題,前者必須公開了IFoo接口,然后通過Foo方法代理對接口的請求給內部對象,而后者是客戶端直接請求InnerFoo提供的IFoo接口方法,沒有代理請求的發(fā)生,所以不是包含。
2. 聚集
實現(xiàn)包含有時會變得非常煩瑣,因為如果內部對象的接口支持大量的方法時,我們必須重復大量的編碼工作來實現(xiàn)代理請求。還有很多其他原因使得我們需要聚集,簡單地說聚集就是一種直接公開內部對象的機制。
聚集的首要規(guī)則是只能聚集那些支持聚集的內部對象,也就是說內部對象知道如何實現(xiàn)代理和非代理的接口請求。
要想了解更多關于代理和非代理的接口請求,參見Dale Rogerson寫的《COM奧秘》一書。
第二條規(guī)則是當外部對象構建內部對象時,我們需要:
(1)把外部對象的IUnknown 接口作為CoCreateInstance調用的參數(shù)傳遞給內部對象。
(2)請求內部對象的IUnknown接口,而且是要IUnknown接口。
假設Foo對象是支持聚集的,下面讓我們把Foo集成到TFooBar對象中。對IFoo的接口請求是通過Delphi的 implements 關鍵字實現(xiàn)的。代碼示意如下:
Type
TFooBar = class (TComObject, IFoo)
Protected
function GetControllingUnknown : IUnknown;
function GetInnerFoo : IFoo;
property InnerFoo : IFoo read GetInnerFoo implements IFoo; //exposes IFoo directly from InnerFoo
protected
FInnerFoo : IUnknown;
end;
function TFoo.GetControllingUnknown : IUnknown;
begin
//返回正確的IUnknown接口
Result := Controller
Else
Result := Self as IUnknown;
end;
function TFooBar.GetInnerFoo : IFoo;
begin
//創(chuàng)建內部Foo對象 object if not yet initialized
if (FInnerFoo = NIL) then
CoCreateInstance (
CLASS_Foo, //Foo的CLSID
GetControllingUnknown, //傳遞Iunknown接口給內部對象
CLSCTX_INPROC, //假設Foo是進程內的
IUnknown, //請求Foo的Iunknown接口
FInnerFoo //輸出內部Foo對象
);
//返回內部Foo對象
Result := FInnerFoo as IFoo;
end;
Delphi的TComObject 已經實現(xiàn)了內建的聚集特性,同時任何從TComObject繼承的COM對象也支持聚集。同時不要忘記如果內部對象不支持聚集,那么這時我們只能使用包含。
理解類工廠的實例屬性(SingleInstance, MultiInstance)
(1)類工廠的實例屬性只對EXE類型的Server有作用。
(2)實例屬性并不是EXE Server的屬性也不是COM對象的屬性而是類工廠的屬性。它決定的是類工廠如何響應客戶端的請求來創(chuàng)建對象的方式。所以所謂“一個Server生成一個對象和一個Server創(chuàng)建多個對象”的說法是完全錯誤的。
實例屬性的真正意義其實是:
每一個COM服務器中的對象都會有一個相應的類工廠,每當客戶端請求創(chuàng)建服務器中的對象時,COM將會要求對象的類工廠來創(chuàng)建這個對象。當EXE型的Server運行時會注冊類工廠(當Server結束時又會被注銷),類工廠的注冊有三種實例模式:SingleUse、MultiUse和MultiSeparateUse。這里我們只討論SingleUse和MultiUse這兩種最常用的模式。
SingleUse意味著類工廠只創(chuàng)建最多一個相應對象的實例。在一個SingleUse的類工廠創(chuàng)建完它的一個實例后,COM將會注銷它。因此,當下一個客戶端請求創(chuàng)立一個對象時,COM 無法找到已注冊的類工廠,它就會啟動另一個EXE Server來獲得新的類工廠,這就意味著如果前一個EXE Server運行沒有結束,這時系統(tǒng)中會有兩個EXE Server在同時運行。
MultiUse則意味著可以創(chuàng)建任意多個類工廠的實例。這意味著只要EXE Server不終止運行,則COM就不會注銷類工廠,也就是說同時只可能有一個EXE Server運行并響應客戶端創(chuàng)建相應對象的請求。
對于Delphi來說,實例模式相當于:
ciSingleInstance = SingleUse
ciMultiInstance = MultiUse
如何實現(xiàn)支持GetActiveObject函數(shù)的COM服務器
對于Microsoft Office來說,可以通過GetActiveObject函數(shù)獲得系統(tǒng)中激活的Office程序:
var
Word : variant;
Begin
//連接到正在運行的Word實例,
//如果沒有運行的實例,會產生異常
Word := GetActiveOleObject ('Word.Application');
end;
那么GetActiveOleObject函數(shù)是如何知道word是否正在運行的呢?又該如何實現(xiàn)支持GetActiveOleObject函數(shù)的COM Server呢?
需要把我們的COM Server注冊到COM的運行對象表中去(Running Object Table,ROT),這可以通過調用RegisterActiveObject API實現(xiàn):
function RegisterActiveObject (
unk: IUnknown; //要注冊的對象
const clsid: TCLSID; //對象的CLSID
dwFlags: Longint; //注冊標志通常使用ACTIVEOBJECT_STRONG
out dwRegister: Longint //成功注冊后返回的句柄
): HResult; stdcall;
有注冊自然就應該有撤消注冊,撤消注冊可以使用RevokeActiveObject API:
function RevokeActiveObject (
dwRegister: Longint; //先前調用RegisterActiveObject時返回的句柄
pvReserved: Pointer //保留參數(shù),須設為nil
): HResult; stdcall;
要注意的是把一個COM對象注冊到ROT中去,意味著只有當服務器從ROT撤消注冊后,服務器才能終止運行,顯然當不需要Server時,應該從ROT中把COM對象撤消,那么誰以及什么時候應該從ROT中撤消COM對象呢?
比較合適的辦法是當客戶端發(fā)出Quit或Exit命令時由服務器自己進行撤銷。
詳細的解決方案可參見Microsoft的自動化程序員參考。
另外下面要談到的ROT的內容主要針對EXE類型的Server,對于進程內的DLL型Server來說,決定何時注冊/撤消ROT比較復雜,因為DLL Server的生命期是依賴于客戶端的。
假設我們想讓一個全局的Foo對象注冊到ROT中,代碼如下:(在DPR文件中)
begin
Application.Initialize;
RegisterGlobalFoo;
Application.CreateForm(TForm1, Form1);
Application.Run;
end.
Var
GlobalFooHandle : longint = 0;
procedure RegisterGlobalFoo;
var
GlobalFoo : IFoo;
Begin
//創(chuàng)建Foo的實例
GlobalFoo := CoFoo.Create;
//注冊到ROT
OleCheck (RegisterActiveObject (
GlobalFoo, //Foo的實例
Class_Foo, //Foo的CLSID
ACTIVEOBJECT_STRONG,
GlobalFooHandle //注冊后返回句柄
));
end;
然后我們?yōu)?/span>Foo (IFoo) 添加一個Quit方法:
procedure TFoo.Quit;
begin
RevokeGlobalFoo;
end;
procedure RevokeGlobalFoo;
begin
if (GlobalFooHandle <> 0) then
begin
//撤銷
OleCheck (RevokeActiveObject (
GlobalFooHandle, NIL
));
GlobalFooHandle := 0;
end;
end;
下面是一個客戶端使用GetActiveOleObject API調用服務器的例子:
var
FooUnk : IUnknown;
Foo : IFoo;
Begin
if (Succeeded (GetActiveObject (
Class_Foo, //Foo的CLSID
NIL, //保留參數(shù),這里用NIL
FooUnk //從ROT返回Foo )))
then begin
//請求IFoo接口
Foo := FooUnk as IFoo;
//......
//終止全局的Foo,從ROT撤銷
Foo.Quit;
end;
end;
Delphi本身還有一個GetActiveOleObject函數(shù)使用對象的PROGID作為參數(shù)而不是對象的CLSID。GetActiveOleObject內部叫GetActiveObject,只工作于自動化對象。
如何實現(xiàn)支持自動化缺省屬性語法的屬性
假設我們要創(chuàng)建下面這樣一個自動化接口:
ICollection = interface (IDispatch)
property Item [Index : variant] : variant;
end;
那么客戶端則可以通過ICollection 接口指針像下面這樣獲得集合中的項目:
Collection.Item [Index]
但我們有時會很懶,希望能按下面的方式調用:
Collection [Index]
允許客戶端使用這種簡化的語法會帶來很大的方便,特別是要調用很深層次的子對象的方法時,比較一下下面兩種調用方法的方便程度:
Collection.Item [Index].SubCollection.Item [Index].SubsubCollection.Item [Index]
Collection [Index].SubCollection [Index].SubsubCollection [Index]
顯然是后者要方便得多,實現(xiàn)缺省的屬性語法支持同樣非常方便,在類型庫編輯器中,只要簡單地標記Item [] 屬性的dispid值為0 (DISPID_VALUE)就可以了。
因為缺省屬性支持是基于dispids的,它只能在自動化接口中有作用。對于純的虛方法表接口,不提供這方面的支持。
COM 組件分類
很多時候我們需要枚舉一些功能類似的COM對象,例如假設想利用COM來提供插件的功能,那么宿主程序如何才能知道哪個COM對象可以作為插件呢?有沒有什么標準的方法來實現(xiàn)COM識別呢?
在Windows 98/2000下可以通過組件分類來解決這個問題。簡單地說,組件分類就是把實現(xiàn)一些通用功能的COM對象分為一組??蛻舳顺绦蚩梢苑奖愕卮_定要使用的COM對象。同其他COM對象類似,每個分類也要用一個唯一的標識符GUID來表示,這就是CATID (類別ID)。
Windows定義了ICatRegister和ICatInformation這兩個接口來提供組件分類服務。實現(xiàn)了ICatRegister和ICatInformation接口組件的類GUID是CLSID_StdComponentCategoryMgr。我們可以使用ICatRegister接口的RegisterCategories方法來注冊一個或多個類別。RegisterCategories方法需要兩個參數(shù),第一個參數(shù)確定有多少個類別將被注冊,第二個參數(shù)是一個TCategoryInfo 類型的指針數(shù)組。TCategoryInfo聲明如下:
TCATEGORYINFO = record
catid: TGUID; //類別 ID
lcid: UINT; //本地化 ID, 用于多語言支持
szDescription: array[0..127] of WideChar; //類別描述
end;
要想注冊一個COM對象的類別,可以使用ICatRegister接口的RegisterClassImplCategories方法。RegisterClassImplCategories方法使用兩個參數(shù),一個是要注冊的COM對象的CLSID,一個是要注冊的類別數(shù)及類別記錄(TcategoryInfo)的數(shù)組。對于客戶端來說,為了掃描所有某一類別的COM對象,可以使用ICatInformation 接口的EnumClassesOfCategories方法。EnumClassesOfCategories方法需要五個參數(shù),但通常只需要提供其中的三個參數(shù)就可以了,一個參數(shù)用來表明我們感興趣的類別數(shù),第二個參數(shù)是類別數(shù)組,最后一個參數(shù)是用來匹配COM對象的CLSID/GUID的枚舉器。示意代碼如下:
unit uhdshake;
interface
uses
Windows,
ActiveX,
ComObj;
type
TImplementedClasses = array [0..255] of TCLSID;
function GetImplementedClasses (var ImplementedClasses : TImplementedClasses) : integer;
procedure RegisterClassImplementation (const CATID, CLSID : TCLSID; const sDescription : String; bRegister : boolean);
implementation
function GetImplementedClasses (CategoryInfo : TCategoryInfo; var ImplementedClasses : TImplementedClasses) : integer;
var
CatInfo : ICatInformation;
Enum : IEnumGuid;
Fetched : UINT;
begin
Result := 0;
CatInfo := CreateComObject (CLSID_StdComponentCategoryMgr) as ICatInformation;
OleCheck (CatInfo.EnumClassesOfCategories (1, @CategoryInfo,0,nil,Enum));
if (Enum <> nil) then
begin
OleCheck (Enum.Reset);
OleCheck (Enum.Next (High (ImplementedClasses), ImplementedClasses [1], Fetched));
Result := Fetched;
end;
end;
procedure RegisterClassImplementation (const CATID, CLSID : TCLSID; const sDescription : String; bRegister : boolean);
var
CatReg : ICatRegister;
CategoryInfo : TCategoryInfo;
begin
CoInitialize (nil);
CategoryInfo.CATID := CATID;
CategoryInfo.LCID := LOCALE_SYSTEM_DEFAULT; //dummy
StringToWideChar(sDescription, CategoryInfo.szDescription, Length(sDescription) + 1);
CatReg := CreateComObject (CLSID_StdComponentCategoryMgr) as ICatRegister;
if (bRegister) then
begin
OleCheck (CatReg.RegisterCategories (1, @CategoryInfo));
OleCheck (CatReg.RegisterClassImplCategories (CLSID, 1, @CategoryInfo));
end
else
begin
OleCheck(CatReg.UnregisterClassImplCategories(CLSID,1,@CategoryInfo));
DeleteRegKey ('CLSID\' + GuidToString (CLSID) + '\' + 'Implemented Categories');
end;
CatReg := nil;
CoUninitialize;
end;
end.
客戶端可以使用GetImplementedClasses方法來獲得所有符合某一類別的COM對象的CLSID。注意這里使用TImplementedClasses 類型作為所有獲得的CLSID的容器。TImplementedClasses 類型簡單的定義為256個CLSID的數(shù)組,對于大多數(shù)情況來說已經足夠了。封裝的RegisterClassImplementation方法是用來按類別注冊或撤消COM對象的。
Delphi下的COM編程
岑 03/9(轉載需征得作者同意)
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
Delphi通過向導可以非常迅速和方便的直接建立實現(xiàn)COM對象的代碼,但是整個COM實現(xiàn)的過程被完全的封裝,甚至沒有VCL那么結構清晰可見。一個沒有C++下COM開發(fā)經驗甚至沒有接觸過COM開發(fā)的Delphi程序員,也能夠很容易的按照教程設計一個接口,但是,恐怕深入一想,連生成的代碼代表何種意義,哪些能夠定制都不清楚。前幾期 “DELPHI下的COM編程技術”一文已經初步介紹了COM的一些基本概念,我則想談一些個人的理解,希望能給對Delphi下COM編程有疑惑的朋友帶來幫助。
COM (組件對象模型 Component Object Model)是一個很龐大的體系。簡單來說,COM定義了一組API與一個二進制的標準,讓來自不同平臺、不同開發(fā)語言的獨立對象之間進行通信。COM對象只有方法和屬性,并包含一個或多個接口。這些接口實現(xiàn)了COM對象的功能,通過調用注冊的COM對象的接口,能夠在不同平臺間傳遞數(shù)據(jù)。
COM光標準和細節(jié)就可以出幾本大書。這里避重就輕,僅僅初步的解釋Delphi如何進行COM的封裝及實現(xiàn)。對于上述COM技術經驗不足的Delphi程序開發(fā)者來說,Delphi通過模版生成的代碼就像是給你一幅抽象畫照著畫一樣,畫出來了卻不一定知道畫的究竟是什么,也不知該如何下手畫自己的東西。本文能夠幫助你解決這類疑惑。
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
再次講解一些概念
<!--[if !supportEmptyParas]--> <!--[endif]-->
“DELPHI下的COM編程技術”一文已經介紹了不少COM的概念,比如GUID、CLSID、IID,引用計數(shù),IUnKnown接口等,下面再補充一些相關內容:
<!--[if !supportEmptyParas]--> <!--[endif]-->
COM與DCOM、COM+、OLE、ActiveX的關系
DCOM(分布式COM)提供一種網絡上訪問其他機器的手段,是COM的網絡化擴展,可以遠程創(chuàng)建及調用。COM+是Microsoft對COM進行了重要的更新后推出的技術,但它不簡單等于COM的升級,COM+是向后兼容的,但在某些程度上具有和COM不同的特性,比如無狀態(tài)的、事務控制、安全控制等等。
以前的OLE是用來描述建立在COM體系結構基礎上的一整套技術,現(xiàn)在OLE僅僅是指與對象連接及嵌入有關的技術;ActiveX則用來描述建立在COM基礎上的非COM技術,它的重要內容是自動化(Automation),自動化允許一個應用程序(稱為自動化控制器)操縱另一個應用程序或庫(稱為自動化服務器)的對象,或者把應用程序元素暴露出來。
由此可見COM與以上的幾種技術的關系,并且它們都是為了讓對象能夠跨開發(fā)工具跨平臺甚至跨網絡的被使用。
<!--[if !supportEmptyParas]--> <!--[endif]-->
Delphi下的接口
Delphi中的接口概念類似C++中的純虛類,又由于Delphi的類是單繼承模式(C++是多繼承的),即一個類只能有一個父類。接口在某種程度上可以實現(xiàn)多繼承。接口類的聲明與一般類聲明的不同是,它可以象多重繼承那樣,類名 = class (接口類1,接口類2… ),然后被聲明的接口類則重載繼承類的虛方法,來實現(xiàn)接口的功能。
以下是IInterface、IUnknown、IDispatch的聲明,大家看出這幾個重要接口之間是什么樣的聯(lián)系了嗎?任何一個COM對象的接口,最終都是從IUnknown繼承的,而Automation對象,則還要包含IDispatch,后面DCOM部分我們會看到它的作用。
IInterface = interface
['{00000000-0000-0000-C000-000000000046}']
function QueryInterface(const IID: TGUID; out Obj): HResult; stdcall;
function _AddRef: Integer; stdcall;
function _Release: Integer; stdcall;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
IUnknown = IInterface;
<!--[if !supportEmptyParas]--> <!--[endif]-->
IDispatch = interface(IUnknown)
['{00020400-0000-0000-C000-000000000046}']
function GetTypeInfoCount(out Count: Integer): HResult; stdcall;
function GetTypeInfo(Index, LocaleID: Integer; out TypeInfo): HResult; stdcall;
function GetIDsOfNames(const IID: TGUID; Names: Pointer;
NameCount, LocaleID: Integer; DispIDs: Pointer): HResult; stdcall;
function Invoke(DispID: Integer; const IID: TGUID; LocaleID: Integer;
Flags: Word; var Params; VarResult, ExcepInfo, ArgErr: Pointer): HResult; stdcall;
end;
對照“DELPHI下的COM編程技術”一文,可以明白IInterface中的定義,即接口查詢及引用記數(shù),這也是訪問和調用一個接口所必須的。QueryInterface可以得到接口句柄,而AddRef與Release則負責登記調用次數(shù)。
COM和接口的關系又是什么呢?COM通過接口進行組件、應用程序、客戶和服務器之間的通信。COM對象需要注冊,而一個GUID則是作為識別接口的唯一名字。
假如你創(chuàng)建了一個COM對象,它的聲明類似 Txxxx= class(TComObject, Ixxxx),前面是COM對象的基類,后面這個接口的聲明則是:Ixxxx = interface(IUnknown)。所以說IUnknown是Delphi中COM對象接口類的祖先。到這一步,我想大家對接口類的來歷已經有初步了解了。
<!--[if !supportEmptyParas]--> <!--[endif]-->
聚合
接口是COM實現(xiàn)的基礎,接口也是可繼承的,但是接口并沒有實現(xiàn)自己,僅僅只有聲明。那么怎么使COM對象對接口的實現(xiàn)得到重用呢?答案就是聚合。聚合就是一個包含對象(外部對象)創(chuàng)建一個被包含對象(內部對象),這樣內部對象的接口就暴露給外部對象。
簡單來說,COM對象被注冊后,可以找到并調用接口。但接口不是僅僅有個定義嗎,它必然通過某種方式找到這個定義的實現(xiàn),即接口的“實現(xiàn)類”的方法,這樣才最終通過外部的接口轉入進行具體的操作,并通過接口返回執(zhí)行結果。
<!--[if !supportEmptyParas]--> <!--[endif]-->
進程內與進程外(In-Process, Out-Process)
進程內的接口的實現(xiàn)基礎是一個DLL,進程外的接口則是建立在應用程序(EXE)上的。通常我們建立進程外接口的目的主要是為了方便調試(跟蹤DLL是件很麻煩的事),然后在將代碼改為進程內發(fā)布。因為進程內比進程外的執(zhí)行效率會高一些。
COM對象創(chuàng)建在服務器的進程空間。如果是EXE型服務器,那么服務器和客戶端不在同一進程;如果是DLL型服務器,則服務器和客戶端就是一個進程。所以進程內還能節(jié)省內存空間,并且減少創(chuàng)建實例的時間。
<!--[if !supportEmptyParas]--> <!--[endif]-->
StdCall與SafeCall
Delphi生成的COM接口默認的方法函數(shù)調用方式是stdcall而不是缺省的Register。這是為了保證不同語言編譯器的接口兼容。
雙重接口(在后面講解自動化時會提到雙重接口)中則默認的是SafeCall。它的意義除了按SafeCall約定方式調用外,還將封裝方法以便向調用者返回HResult值。SafeCall的好處是能夠捕獲所有異常,即使是方法中未被代碼處理的異常,也可以被外套處理并通過HResult返回給調用者。
<!--[if !supportEmptyParas]--> <!--[endif]-->
WideString等一些有差異的類型
接口定義中缺省的字符參數(shù)或返回值將不再是String而是WideString。WideString 是Delphi中符合OLE 32-bit版本的Unicode類型,當是字符時,WideString與String幾乎等同,當處理Unicode字符時,則會有很大差別。聯(lián)想到COM本身是為了跨平臺使用,可以很容易的理解為什么數(shù)據(jù)通信時需要使用WideString類型。
同樣的道理,integer類型將變成SYSINT或者Int64、SmallInt或者Shortint,這些細微的變化都是為了符合規(guī)范。
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
通過向導生成基礎代碼
<!--[if !supportEmptyParas]--> <!--[endif]-->
打開創(chuàng)建新工程向導(菜單“File-New-Other”或“New Items按鈕”),選擇ActiveX頁。先建立一個ActiveX Library。編譯后即是個DLL文件(進程內)。然后在同樣的頁面再建立一個COM Object。
<!--[if !vml]--><!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
實例模式與線程模式
接著你將看到如下向導,除了填寫類名外(接口名會自動根據(jù)類名填充),還有實例創(chuàng)建方式(Instancing)和線程模式(Threading Model)的選項。
<!--[if !vml]--><!--[endif]-->
實例模式決定客戶端請求后,COM對象如何創(chuàng)建實例:
<!--[if !supportLists]-->(1) <!--[endif]-->Internal:供COM對象內部使用,不會響應客戶端請求,只能通過COM對象內部的其他方法來建立;
<!--[if !supportLists]-->(2) <!--[endif]-->Single Instance:不論當前系統(tǒng)內部是否存在相同COM對象,都會建立一個新的程序及獨立的對象實例;
<!--[if !supportLists]-->(3) <!--[endif]-->Mulitple Instance:如果有多個相同的COM對象,只會建立一個程序,多個COM對象的實例共享公共代碼,并擁有自己的數(shù)據(jù)空間。
<!--[if !supportEmptyParas]--> <!--[endif]-->
Single/ Mulitple Instance有各自的優(yōu)點,Mulitple雖然節(jié)省了內存但更加費時。即Single模式需要更多的內存資源,而Mulitple模式需要更多的CPU資源,且Single的實例響應請求的負荷較為平均。該參數(shù)應根據(jù)服務器的實際需求來考慮。
<!--[if !supportEmptyParas]--> <!--[endif]-->
線程模式有五種:
<!--[if !supportLists]-->(1) <!--[endif]-->Single:僅單線程,處理簡單,吞吐量最低;
<!--[if !supportLists]-->(2) <!--[endif]-->Apartment:COM程序多線程,COM對象處理請求單線程;
<!--[if !supportLists]-->(3) <!--[endif]-->Free:一個COM對象的多個實例可以同時運行。吞吐量提高的同時,也要求對COM對象進行必要的保護,以避免多個實例沖突;
<!--[if !supportLists]-->(4) <!--[endif]-->Both:同時支持Aartment和Free兩種線程模式。
<!--[if !supportLists]-->(5) <!--[endif]-->Neutral:只能在COM+下使用。
<!--[if !supportEmptyParas]--> <!--[endif]-->
雖然Free和Both的效率得到提高,但是要求較高的技巧以避免沖突(這是很不容易調試的),所以一般建議使用Delphi的缺省方式。
<!--[if !supportEmptyParas]--> <!--[endif]-->
類型庫編輯器(Type Library)
假設我們建立一個叫做TSample的類和ISample的接口(如圖),然后使用類型庫編輯器創(chuàng)建一個方法GetCOMInfo(在右邊樹部分點擊右鍵彈出菜單選擇New-Method或者點擊上方按鈕),并于左邊Parameters頁面建立兩個參數(shù)(ValInt : Integer , ValStr : String),返回值為BSTR。如圖:
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !vml]--><!--[endif]-->
可以看到,除了常用類型外,參數(shù)和返回值還可以支持很多指針、OLE對象、接口類型。建立普通的COM對象,其Returen Type是可以任意的,這是和DCOM的一個區(qū)別。
雙擊Modifier列彈出窗口,可以選擇參數(shù)的方式:in、out分別對應const、out定義,選擇Has Default Value可設置參數(shù)缺省值。
<!--[if !vml]--><!--[endif]-->
Delphi生成代碼詳解
<!--[if !supportEmptyParas]--> <!--[endif]-->
點擊刷新按鈕刷新后,上面類型庫編輯器對應的Delphi自動生成的代碼如下:
unit uCOM;
<!--[if !supportEmptyParas]--> <!--[endif]-->
{$WARN SYMBOL_PLATFORM OFF}
<!--[if !supportEmptyParas]--> <!--[endif]-->
interface
<!--[if !supportEmptyParas]--> <!--[endif]-->
uses
Windows, ActiveX, Classes, ComObj, pCOM_TLB, StdVcl;
<!--[if !supportEmptyParas]--> <!--[endif]-->
type
TSample = class(TTypedComObject, ISample)
protected
function GetCOMInfo(ValInt: SYSINT; const ValStr: WideString): WideString;
stdcall;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
implementation
<!--[if !supportEmptyParas]--> <!--[endif]-->
uses ComServ;
<!--[if !supportEmptyParas]--> <!--[endif]-->
function TSample.GetCOMInfo(ValInt: SYSINT;const ValStr: WideString): WideString;
begin
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
initialization
TTypedComObjectFactory.Create(ComServer, TSample, Class_Sample,
ciMultiInstance, tmApartment);
end.
<!--[if !supportEmptyParas]--> <!--[endif]-->
引用單元
有三個特殊的單元被引用:ComObj,ComServ和pCOM_TLB。ComObj里定義了COM接口類的父類TTypedComObject和類工廠類TTypedComObjectFactory(分別從TComObject和TComObjectFactory繼承,早期版本如Delphi4建立的COM,就直接從TcomObject繼承和使用TComObjectFactory了); ComServ單元里面定義了全局變量ComServer: TComServer,它是從TComServerObject繼承的,關于這個變量的作用,后面將會提到。
這幾個類都是delphi實現(xiàn)COM對象的比較基礎的類,TComObject(COM對象類)和TComObjectFactory(COM對象類工廠類)本身就是IUnknown的兩個實現(xiàn)類,包含了一個COM對象的建立、查詢、登記、注冊等方面的代碼。TComServerObject則用來注冊一個COM對象的服務信息。
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
接口定義說明
再看接口類定義TSample = class(TTypedComObject, ISample)。到這里,已經可以通過涉及的父類的作用大致猜測到TSample是如何創(chuàng)建并注冊為一個標準的COM對象的了。那么接口ISample又是怎么來的呢?pCOM_TLB單元是系統(tǒng)自動建立的,其名稱加上了_TLB,它里面包含了ISample = interface(IUnknown)的接口定義。前面提到過,所有COM接口都是從IUnknown繼承的。
在這個單元里我們還可以看到三種ID(類型庫ID、IID及COM注冊所必須的CLSID)的定義:LIBID_pCOM,IID_ISample和CLASS_Sample。關鍵是這時接口本身僅僅只有定義代碼而沒有任何的實現(xiàn)代碼,那接口創(chuàng)建又是在何處執(zhí)行的?_TLB單元里還有這樣的代碼:
CoSample = class
class function Create: ISample;
class function CreateRemote(const MachineName: string): ISample;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
class function CoSample.Create: ISample;
begin
Result := CreateComObject(CLASS_Sample) as ISample;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
class function CoSample.CreateRemote(const MachineName: string): ISample;
begin
Result := CreateRemoteComObject(MachineName, CLASS_Sample) as ISample;
end;
由Delphi的向導和類型編輯器幫助生成的接口定義代碼,都會綁定一個“Co+類名”的類,它實現(xiàn)了創(chuàng)建接口實例的代碼。CreateComObject和CreateRemoteComObject函數(shù)在ComObj單元定義,它們就是使用CLSID創(chuàng)建COM/DCOM對象的函數(shù)!
<!--[if !supportEmptyParas]--> <!--[endif]-->
初始化:注冊COM對象的類工廠
類工廠負責接口類的統(tǒng)一管理——實際上是由支持IClassFactory接口的對象來管理的。類工廠類的繼承關系如下:
IClassFactory = interface(IUnknown)
TComObjectFactory=class(TObject,IUnknown,IClassFactory,IClassFactory2) TTypedComObjectFactory = class(TComObjectFactory)
我們知道了接口ISample是怎樣被創(chuàng)建的,接口實現(xiàn)類TSample又是如何被定義為COM對象的實現(xiàn)類?,F(xiàn)在解釋它是怎么被注冊,以及何時創(chuàng)建的。這一切的小把戲都在最后initialization的部分,這里有一條類工廠建立的語句。
Initialization是Delphi用于初始化的特殊部分,此部分的代碼將在整個程序啟動的時候首先執(zhí)行。回顧前面的內容并觀察一下TTypedComObjectFactory的參數(shù):ComServer是用于注冊/撤消注冊COM服務的對象,TSample是接口實現(xiàn)類,Class_Sample是接口唯一對應的GUID,ciMultiInstance是實例模式,tmApartment是線程模式。一個COM對象應該具備的特征和要素都包含在了里面!
那么COM對象的管理又是怎么實現(xiàn)的呢?在ComObj單元里面可以見到一條定義function ComClassManager: TComClassManager;
這里TComClassManager顧名思義就是COM對象的管理類。任何一個祖先類為TComObjectFactory的對象被建立時,其Create里面會執(zhí)行這樣一句:
ComClassManager.AddObjectFactory(Self);
AddObjectFactory方法的原形為procedure TComClassManager.AddObjectFactory(Factory: TComObjectFactory);相對應的還有RemoveObjectFactory方法。具體的代碼我就不貼出來了,相信大家已經猜測到了它的作用——將當前對象(self)加入到ComClassManager管理的對象鏈(FFactoryList)中。
<!--[if !supportEmptyParas]--> <!--[endif]-->
封裝的秘密
讀者應該還有最后一個疑問:假如服務器通過類工廠的注冊以及GUID確定一個COM對象,那當客戶端調用的時候,服務器是如何啟動包含COM對象的程序的呢?
當你建立ActiveX Library的工程的時候,將發(fā)現(xiàn)一個和普通DLL模版不同的地方——它定義了四個輸出例程:
exports
DllGetClassObject,
DllCanUnloadNow,
DllRegisterServer,
DllUnregisterServer;
這四個例程并不是我們編寫的,它們都在ComServ單元例實現(xiàn)。單元還定義了類TComServer,并且在初始化部分創(chuàng)建了類的實例,即前面提到過的全局變量ComServer。
例程DllGetClassObject通過CLSID得到支持IClassFactory接口的對象;例程DllCanUnloadNow判斷DLL是否可從內存卸載;DllRegisterServer和DllUnregisterServer負責DLL的注冊和解除注冊,其具體的功能由ComServer實現(xiàn)。
<!--[if !supportEmptyParas]--> <!--[endif]-->
接口類的具體實現(xiàn)
好了,現(xiàn)在自動生成代碼的來龍去脈已經解釋清楚了,下一步就是由我們來添加接口方法的實現(xiàn)代碼。在function TSample.GetCOMInfo的部分添加如下代碼。我寫的例子很簡單,僅僅是根據(jù)傳遞的參數(shù)組織一條字符串并返回。以此證明接口正確調用并執(zhí)行了該代碼:
function TSample.GetCOMInfo(ValInt: SYSINT;const ValStr: WideString): WideString;
const
Server1 = 1; Server2 = 2; Server3 = 3;
var
s : string;
begin
s := 'This is COM server : ';
case ValInt of
Server1: s := s + 'Server1';
Server2: s := s + 'Server2';
Server3: s := s + 'Server3';
end;
s := s + #13 + #10 + 'Execute client is ' + ValStr;
Result := s;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
注冊、創(chuàng)建COM對象及調用接口
隨便建立一個Application用于測試上面的COM。必要的代碼很少,創(chuàng)建一個接口的實例然后執(zhí)行它的方法。當然我們得先行注冊COM,否則調用根據(jù)CLSID找不接口的話,將報告“無法向注冊表寫入項”。如果接口定義不一致,則會報告“Interface not supported”。
編譯上面的這個COM工程,然后選擇菜單“Run – Register ActiveX Server”,或者通過Windows下system/system32目錄中的regsvr32.exe程序注冊編譯好的DLL文件。regsvr32的具體參數(shù)可以通過regsvr32/?來獲得。對于進程外(EXE型)的COM對象,執(zhí)行一次應用程序就注冊了。
提示DLL注冊成功后,就應該可以正確執(zhí)行下列客戶端程序了:
uses ComObj, pCOM_TLB;
<!--[if !supportEmptyParas]--> <!--[endif]-->
procedure Ttest.Button1Click(Sender: TObject);
var
COMSvr : ISample;
retStr : string;
begin
COMSvr := CreateComObject(CLASS_Sample) as ISample;
if COMSvr <> nil then begin
retStr := COMSvr.GetCOMInfo(2,'client 2');
showmessage(retStr);
COMSvr := nil;
end
else showmessage('接口創(chuàng)建不成功');
end;
最終值是從當前程序外的一個“接口”返回的,我們甚至可以不知道這個接口的實現(xiàn)!第一次接觸COM的人,成功執(zhí)行此程序并彈出對話框后,也許會體會到一種技術如斯奇妙的感覺,因為你僅僅調用了“接口”,就可以完成你猜測中的東西。
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
創(chuàng)建一個分布式DCOM(自動化接口)
<!--[if !supportEmptyParas]--> <!--[endif]-->
IDispatch
在delphi6之前的版本中,所有接口的祖先都是IUnknown,后來為了避免跨平臺操作中接口概念的模糊,又引入了IInterface接口。
使用向導生成DCOM的步驟和COM幾乎一致。而生成的代碼僅將接口類的父類換為TAutoObject,類工廠類換為TAutoObjectFactory。這其實沒有太大的不同,因為TAutoObject等于是一個標準COM外加IDispatch接口,而TAutoObjectFactory是從TTypedComObjectFactory直接繼承的:
TAutoObject = class(TTypedComObject, IDispatch)
TAutoObjectFactory = class(TTypedComObjectFactory)
自動化服務器支持雙重接口,而且必須實現(xiàn)IDispatch。因討論范疇限制,本文只能簡單提出,IDispatch是DCOM和COM技術實現(xiàn)上的一個重要區(qū)別。打開_TLB.pas單元,可以找到Ixxx = interface(IDispatch)和Ixxx = dispinterface的定義,這在前面COM的例子里面是沒有的。
<!--[if !supportEmptyParas]--> <!--[endif]-->
創(chuàng)建過程中的差異
<!--[if !vml]--><!--[endif]-->
使用類型庫編輯器的時候,有兩處和COM不同的地方。首先Return Type必須選擇HRESULT,否則會提示錯誤,這是為了滿足雙重接口的需要。當Return Type選擇HRESULT后,你會發(fā)現(xiàn)方法定義將變成procedure(過程)而不是預想中的function(函數(shù))。
怎么才能讓方法有返回值呢?還需要在Parameters最后多添加一個參數(shù),然后將該參數(shù)改名與方法名一致,設置參數(shù)類型為指針(如果找不到某種類型的指針類型,可以直接在類型后面加*,如圖,BSTR*是BSTR的指針類型)。最后在Modifier列設置Parameter Flags為RetVal,同時Out將被自動選中,而In將被取消。
<!--[if !vml]--><!--[endif]-->
刷新后,得到下列代碼。添加方法的具體實現(xiàn),大功告成:
TSampleAuto = class(TAutoObject, ISampleAuto)
protected
function GetAutoSerInfo(ValInt: SYSINT;const ValStr: WideString): WideString; safecall;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
遠程接口調用
遠程接口的調用需要使用CreateRemoteComObject函數(shù),其它如接口的聲明等等與COM接口調用相同。CreateRemoteComObject函數(shù)比CreateComObject 多了一個參數(shù),即服務器的計算機名稱,這樣就比COM多出了遠程調用的查詢能力。前面“接口定義說明”一節(jié)的代碼可以對照CreateComObject、CreateRemoteComObject的區(qū)別。
<!--[if !supportEmptyParas]--> <!--[endif]-->
<!--[if !supportEmptyParas]--> <!--[endif]-->
自定義COM的對象
<!--[if !supportEmptyParas]--> <!--[endif]-->
接口一個重要的好處是:發(fā)布一個接口,可以不斷更新其功能而不用升級客戶端。因為不論應用升級還是業(yè)務改變,客戶端的調用方式都是一致的。
既然我們已經弄清楚Delphi是怎樣實現(xiàn)一個接口的,那能否不使用向導,自己定義接口呢?這樣做可以用一個接口繼承出不同的接口實現(xiàn)類,來完成不同的功能。同時也方便了小組開發(fā)、客戶端開發(fā)、進程內/外同步編譯以及調試。
<!--[if !supportEmptyParas]--> <!--[endif]-->
接口單元:xxx_TLB.pas
前面略講了接口的定義需要注意的方面。接口除了沒有實例化外,它與普通類還有以下區(qū)別:接口中不能定義字段,所有屬性的讀寫必須由方法實現(xiàn);接口沒有構造和析構函數(shù),所有成員都是public;接口內的方法不能定義為virtual,dynamic,abstract,override。
首先我們要建立一個接口。前面講過接口的定義只存在于一個地方,即xxx_TLB.pas單元里面。使用類型庫編輯器可以產生這樣一個單元。還是在新建項目的ActiveX頁,選擇最后一個圖標(Type Library)打開類型庫編輯器,按F12鍵就可以看到TLB文件(保存為.tlb)了。沒有定義任何接口的時候,TLB文件里除了一大段注釋外只定義了LIBID(類型庫的GUID)。假如關閉了類型庫編輯器也沒有關系,可以隨時通過菜單View – Type Library打開它。
先建立一個新接口(使用向導的話這步已經自動完成了),然后如前面操作一樣建立方法、屬性…生成的TLB文件內容與向導生成_TLB單元大致相同,但僅有定義,缺乏“co+類名”之類的接口創(chuàng)建代碼。
再觀察代碼,將發(fā)現(xiàn)接口是從IDispatch繼承的,必須將這里的IDispatch改為IUnknown。保存將會得到.tlb文件,而我們想要的是一個單元(.pas)文件,僅僅為了聲明接口,所以把代碼拷貝復制并保存到一個新的Unit。
<!--[if !supportEmptyParas]--> <!--[endif]-->
自定義CLSID
從注冊和調用部分可以看出CLSID的重要作用。CLSID是一個GUID(全局唯一接口表示符),用來標識對象。GUID是一個16個字節(jié)長的128位二進制數(shù)據(jù)。Delphi聲明一個GUID常量的語法是:
Class_XXXXX : TGUID = '{xxxxxxxx-xxxxx-xxxxx-xxxxx-xxxxxxxx}';
在Delphi的編輯界面按Ctrl+Shift+G鍵可以自動生成等號后的數(shù)據(jù)串。GUID的聲明并不一定在_TLB單元里面,任何地方都可以聲明并引用它。
<!--[if !supportEmptyParas]--> <!--[endif]-->
接口類聲明與實現(xiàn)
新建一個ActiveX Library工程,加入剛才定義的TLB單元,再新建一個Unit。我的TLB單元取名為MyDef_TLB.pas,定義了一個接口IMyInterface = interface(IUnknown),以及一個方法function SampleMethod(val: Smallint): SYSINT; safecall;現(xiàn)在讓我們看看全部接口類聲明及實現(xiàn)的代碼:
unit uMyDefCOM;
<!--[if !supportEmptyParas]--> <!--[endif]-->
interface
<!--[if !supportEmptyParas]--> <!--[endif]-->
uses
ComObj, Comserv, ActiveX, MyDef_TLB;
<!--[if !supportEmptyParas]--> <!--[endif]-->
const
Class_MySvr : TGUID = '{1C0E5D5A-B824-44A4-AF6C-478363581D43}';
<!--[if !supportEmptyParas]--> <!--[endif]-->
type
<!--[if !supportEmptyParas]--> <!--[endif]-->
TMyIClass = class(TComObject, IMyInterface)
procedure Initialize; override;
destructor Destroy; override;
private
FInitVal : word;
public
function SampleMethod(val: Smallint): SYSINT; safecall;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
TMySvrFactory = class(TComObjectFactory)
procedure UpdateRegistry(Register:Boolean);override;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
implementation
<!--[if !supportEmptyParas]--> <!--[endif]-->
{ TMyIClass }
<!--[if !supportEmptyParas]--> <!--[endif]-->
procedure TMyIClass.Initialize;
begin
inherited;
FInitVal := 100;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
destructor TMyIClass.Destroy;
begin
inherited;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
function TMyIClass.SampleMethod(val: Smallint): SYSINT;
begin
Result := val + FInitVal;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
{ TMySvrFactory }
<!--[if !supportEmptyParas]--> <!--[endif]-->
procedure TMySvrFactory.UpdateRegistry(Register: Boolean);
begin
inherited;
<!--[if !supportEmptyParas]--> <!--[endif]-->
if Register then begin
CreateRegKey('MyApp\'+ClassName, 'GUID', GUIDToString(Class_MySvr));
end else begin
DeleteRegKey('MyApp\'+ClassName);
end;
end;
<!--[if !supportEmptyParas]--> <!--[endif]-->
initialization
<!--[if !supportEmptyParas]--> <!--[endif]-->
TMySvrFactory.Create(ComServer, TMyIClass, Class_MySvr,
'MySvr', '', ciMultiInstance, tmApartment);
<!--[if !supportEmptyParas]--> <!--[endif]-->
end.
Class_MySvr是自定義的CLSID,TMyIClass是接口實現(xiàn)類,TMySvrFactory是類工廠類。
<!--[if !supportEmptyParas]--> <!--[endif]-->
COM對象的初始化
procedure Initialize是接口的初始化過程,而不是常見的Create方法。當客戶端創(chuàng)建接口后,將首先執(zhí)行里面的代碼,與Create的作用一樣。一個COM對象的生存周期內,難免需要初始化類成員或者設置變量的初值,所以經常需要重載這個過程。
相對應的,destructor Destroy則和類的標準析構過程一樣,作用也相同。
<!--[if !supportEmptyParas]--> <!--[endif]-->
類工廠注冊
在代碼的最后部分,假如使用TComObjectFactory來注冊,就和前面所講的完全一樣了。我在這里刻意用類TMySvrFactory繼承了一次,并且重載了UpdateRegistry 方法,以便向注冊表中寫入額外的內容。這是種小技巧,希望大家根據(jù)本文的思路,摸清COM/DCOM對象的Delphi實現(xiàn)結構后,可以舉一反三。畢竟隨心所欲的控制COM對象,能提供的功能遠不如此。
<!--[if !supportEmptyParas]--> <!--[endif]-->
(本文所有代碼在Delphi6、Delphi7下編譯執(zhí)行通過
聯(lián)系客服