4.1一個簡單的DLL
第2節給出了以靜態連結庫方式提供add函數介面的方法,接下來我們來看看怎樣用動態連結程式庫實現一個同樣功能的add函數。
如
圖6,在VC++中new一個Win32 Dynamic-Link Library工程dllTest(單擊此處下載本工程附件)。注意不要選擇MFC AppWizard(dll),因為用MFC AppWizard(dll)建立的將是第5、6節要講述的MFC 動態連結程式庫。
圖6 建立一個非MFC DLL
在建立的工程中添加lib.h及lib.cpp檔案,原始碼如下:
/* 檔案名稱:lib.h */
#ifndef LIB_H
#define LIB_H
extern "C" int __declspec(dllexport)add(int x, int y);
#endif
/* 檔案名稱:lib.cpp */
#include "lib.h"
int add(int x, int y)
{
return x + y;
}
與第2節對靜態連結庫的調用相似,我們也建立一個與DLL工程處於同一工作區的應用工程dllCall,它調用DLL中的函數add,其原始碼如下:
#include <stdio.h>
#include <windows.h>
typedef int(*lpAddFun)(int, int); //宏定義函數指標類型
int main(int argc, char *argv[])
{
HINSTANCE hDll; //DLL控制代碼
lpAddFun addFun; //函數指標
hDll = LoadLibrary("..//Debug//dllTest.dll");
if (hDll != NULL)
{
addFun = (lpAddFun)GetProcAddress(hDll, "add");
if (addFun != NULL)
{
int result = addFun(2, 3);
printf("%d", result);
}
FreeLibrary(hDll);
}
return 0;
}
分析上述代碼,dllTest工程中的lib.cpp檔案與第2節靜態連結庫版本完全相同,不同在於lib.h對函數add的聲明前面添加了__declspec(dllexport)語句。這個語句的含義是聲明函數add為DLL的匯出函數。DLL內的函數分為兩種:
(1)DLL匯出函數,可供應用程式調用;
(2) DLL內建函式,只能在DLL程式使用,應用程式無法調用它們。
而應用程式對本DLL的調用和對第2節靜態連結庫的調用卻有較大差異,下面我們來逐一分析。
首先,語句typedef int ( * lpAddFun)(int,int)定義了一個與add函數接受參數類型和傳回值均相同的函數指標類型。隨後,在main函數中定義了lpAddFun的執行個體addFun;
其次,在函數main中定義了一個DLL HINSTANCE控制代碼執行個體hDll,通過Win32 Api函數LoadLibrary動態載入了DLL模組並將DLL模組控制代碼賦給了hDll;
再次,在函數main中通過Win32 Api函數GetProcAddress得到了所載入DLL模組中函數add的地址並賦給了addFun。經由函數指標addFun進行了對DLL中add函數的調用;
最後,應用工程使用完DLL後,在函數main中通過Win32 Api函數FreeLibrary釋放了已經載入的DLL模組。
通過這個簡單的例子,我們獲知DLL定義和調用的一般概念:
(1)DLL中需以某種特定的方式聲明匯出函數(或變數、類);
(2)應用工程需以某種特定的方式調用DLL的匯出函數(或變數、類)。
下面我們來對“特定的方式進行”闡述。
4.2 聲明匯出函數
DLL中匯出函數的聲明有兩種方式:一種為4.1節例子中給出的在函式宣告中加上__declspec(dllexport),這裡不再舉例說明;另外一種方式是採用模組定義(.def) 檔案聲明,.def檔案為連結器提供了有關被連結程式的匯出、屬性及其他方面的資訊。
下面的代碼示範了怎樣同.def檔案將函數add聲明為DLL匯出函數(需在dllTest工程中添加lib.def檔案):
; lib.def : 匯出DLL函數
LIBRARY dllTest
EXPORTS
add @ 1
.def檔案的規則為:
(1)LIBRARY語句說明.def檔案相應的DLL;
(2)EXPORTS語句後列出要匯出函數的名稱。可以在.def檔案中的匯出函數名後加@n,表示要匯出函數的序號為n(在進行函數調用時,這個序號將發揮其作用);
(3).def 檔案中的注釋由每個注釋行開始處的分號 (;) 指定,且注釋不能與語句共用一行。
由此可以看出,例子中lib.def檔案的含義為產生名為“dllTest”的動態連結程式庫,匯出其中的add函數,並指定add函數的序號為1。
4.3 DLL的調用方式
在4.1節的例子中我們看到了由“LoadLibrary-GetProcAddress-FreeLibrary”系統Api提供的三位一體“DLL載入-DLL函數地址擷取-DLL釋放”方式,這種調用方式稱為DLL的動態調用。
動態調用方式的特點是完全由編程者用 API 函數載入和卸載 DLL,程式員可以決定 DLL 檔案何時載入或不載入,顯式連結在運行時決定載入哪個 DLL 檔案。
與動態調用方式相對應的就是靜態調用方式,“有動必有靜”,這來源於物質世界的對立統一。“動與靜”,其對立與統一竟無數次在技術領域裡得到驗證,譬如靜態IP與DHCP、靜態路由與動態路由等。從前文我們已經知道,庫也分為靜態庫與動態庫DLL,而想不到,深入到DLL內部,其調用方式也分為靜態與動態。“動與靜”,無處不在。《周易》已認識到有動必有靜的動靜平衡觀,《易.繫辭》曰:“動靜有常,剛柔斷矣”。哲學意味著一種普遍的真理,因此,我們經常可以在枯燥的技術領域看到哲學的影子。
靜態調用方式的特點是由編譯系統完成對DLL的載入和應用程式結束時 DLL 的卸載。當調用某DLL的應用程式結束時,若系統中還有其它程式使用該 DLL,則Windows對DLL的應用記錄減1,直到所有使用該DLL的程式都結束時才釋放它。靜態調用方式簡單實用,但不如動態調用方式靈活。
下面我們來看看靜態調用的例子(單擊此處下載本工程附件),將編譯dllTest工程所產生的.lib和.dll檔案拷入dllCall工程所在的路徑,dllCall執行下列代碼:
#pragma comment(lib,"dllTest.lib")
//.lib檔案中僅僅是關於其對應DLL檔案中函數的重定位資訊
extern "C" __declspec(dllimport) add(int x,int y);
int main(int argc, char* argv[])
{
int result = add(2,3);
printf("%d",result);
return 0;
}
由上述代碼可以看出,靜態調用方式的順利進行需要完成兩個動作:
(1)告訴編譯器與DLL相對應的.lib檔案所在的路徑及檔案名稱,#pragma comment(lib,"dllTest.lib")就是起這個作用。
程式員在建立一個DLL檔案時,連接器會自動為其產生一個對應的.lib檔案,該檔案包含了DLL 匯出函數的符號名及序號(並不含有實際的代碼)。在應用程式裡,.lib檔案將作為DLL的替代檔案參與編譯。
(2)聲明匯入函數,extern "C" __declspec(dllimport) add(int x,int y)語句中的__declspec(dllimport)發揮這個作用。
靜態調用方式不再需要使用系統API來載入、卸載DLL以及擷取DLL中匯出函數的地址。這是因為,當程式員通過靜態連結方式編譯產生應用程式時,應用程式中調用的與.lib檔案中匯出符號相匹配的函數符號將進入到產生的EXE 檔案中,.lib檔案中所包含的與之對應的DLL檔案的檔案名稱也被編譯器儲存在 EXE檔案內部。當應用程式運行過程中需要載入DLL檔案時,Windows將根據這些資訊發現並載入DLL,然後通過符號名實現對DLL 函數的動態連結。這樣,EXE將能直接通過函數名調用DLL的輸出函數,就象調用程式內部的其他函數一樣。
4.4 DllMain函數
Windows在載入DLL的時候,需要一個入口函數,就如同控制台或DOS程式需要main函數、WIN32程式需要WinMain函數一樣。在前面的例子中,DLL並沒有提供DllMain函數,應用工程也能成功引用DLL,這是因為Windows在找不到DllMain的時候,系統會從其它運行庫中引入一個不做任何操作的預設DllMain函數版本,並不意味著DLL可以放棄DllMain函數。
根據編寫規範,Windows必須尋找並執行DLL裡的DllMain函數作為載入DLL的依據,它使得DLL得以保留在記憶體裡。這個函數並不屬於匯出函數,而是DLL的內建函式。這意味著不能直接在應用工程中引用DllMain函數,DllMain是自動被調用的。
我們來看一個DllMain函數的例子(單擊此處下載本工程附件)。
BOOL APIENTRY DllMain( HANDLE hModule,
DWORD ul_reason_for_call,
LPVOID lpReserved
)
{
switch (ul_reason_for_call)
{
case DLL_PROCESS_ATTACH:
printf("/nprocess attach of dll");
break;
case DLL_THREAD_ATTACH:
printf("/nthread attach of dll");
break;
case DLL_THREAD_DETACH:
printf("/nthread detach of dll");
break;
case DLL_PROCESS_DETACH:
printf("/nprocess detach of dll");
break;
}
return TRUE;
}
DllMain函數在DLL被載入和卸載時被調用,在單個線程啟動和終止時,DLLMain函數也被調用,ul_reason_for_call指明了被調用的原因。原因共有4種,即PROCESS_ATTACH、PROCESS_DETACH、THREAD_ATTACH和THREAD_DETACH,以switch語句列出。
來仔細解讀一下DllMain的函數頭BOOL APIENTRY DllMain( HANDLE hModule, WORD ul_reason_for_call, LPVOID lpReserved )。
APIENTRY被定義為__stdcall,它意味著這個函數以標準Pascal的方式進行調用,也就是WINAPI方式;
進程中的每個DLL模組被全域唯一的32位元組的HINSTANCE控制代碼標識,只有在特定的進程內部有效,控制代碼代表了DLL模組在進程虛擬空間中的起始地址。在Win32中,HINSTANCE和HMODULE的值是相同的,這兩種類型可以替換使用,這就是函數參數hModule的來曆。
執行下列代碼:
hDll = LoadLibrary("..//Debug//dllTest.dll");
if (hDll != NULL)
{
addFun = (lpAddFun)GetProcAddress(hDll, MAKEINTRESOURCE(1));
//MAKEINTRESOURCE直接使用匯出檔案中的序號
if (addFun != NULL)
{
int result = addFun(2, 3);
printf("/ncall add in dll:%d", result);
}
FreeLibrary(hDll);
}
我們看到輸出順序為:
process attach of dll
call add in dll:5
process detach of dll
這一輸出順序驗證了DllMain被調用的時機。
代碼中的GetProcAddress ( hDll, MAKEINTRESOURCE ( 1 ) )值得留意,它直接通過.def檔案中為add函數指定的順序號訪問add函數,具體體現在MAKEINTRESOURCE ( 1 ),MAKEINTRESOURCE是一個通過序號擷取函數名的宏,定義為(節選自winuser.h):
#define MAKEINTRESOURCEA(i) (LPSTR)((DWORD)((WORD)(i)))
#define MAKEINTRESOURCEW(i) (LPWSTR)((DWORD)((WORD)(i)))
#ifdef UNICODE
#define MAKEINTRESOURCE MAKEINTRESOURCEW
#else
#define MAKEINTRESOURCE MAKEINTRESOURCEA
4.5 __stdcall約定
如果通過VC++編寫的DLL欲被其他語言編寫的程式調用,應將函數的調用方式聲明為__stdcall方式,WINAPI都採用這種方式,而C/C++預設的調用方式卻為__cdecl。__stdcall方式與__cdecl對函數名最終產生符號的方式不同。若採用C編譯方式(在C++中需將函式宣告為extern "C"),__stdcall呼叫慣例在輸出函數名前面加底線,後面加“@”符號和參數的位元組數,形如_functionname@number;而__cdecl呼叫慣例僅在輸出函數名前面加底線,形如_functionname。
Windows編程中常見的幾種函數型別宣告宏都是與__stdcall和__cdecl有關的(節選自windef.h):
#define CALLBACK __stdcall //這就是傳說中的回呼函數
#define WINAPI __stdcall //這就是傳說中的WINAPI
#define WINAPIV __cdecl
#define APIENTRY WINAPI //DllMain的入口就在這裡
#define APIPRIVATE __stdcall
#define PASCAL __stdcall
在lib.h中,應這樣聲明add函數:
int __stdcall add(int x, int y);
在應用工程中函數指標類型應定義為:
typedef int(__stdcall *lpAddFun)(int, int);
若在lib.h中將函式宣告為__stdcall調用,而應用工程中仍使用typedef int (* lpAddFun)(int,int),運行時將發生錯誤(因為類型不符,在應用工程中仍然是預設的__cdecl調用),彈出7所示的對話方塊。
圖7 呼叫慣例不匹配時的運行錯誤
圖8中的那段話實際上已經給出了錯誤的原因,即“This is usually a result of …”。
單擊此處下載__stdcall調用例子工程原始碼附件。
4.6 DLL匯出變數
DLL定義的全域變數可以被調用進程訪問;DLL也可以訪問調用進程的全域資料,我們來看看在應用工程中引用DLL中變數的例子(單擊此處下載本工程附件)。
/* 檔案名稱:lib.h */
#ifndef LIB_H
#define LIB_H
extern int dllGlobalVar;
#endif
/* 檔案名稱:lib.cpp */
#include "lib.h"
#include <windows.h>
int dllGlobalVar;
BOOL APIENTRY DllMain(HANDLE hModule, DWORD ul_reason_for_call, LPVOID lpReserved)
{
switch (ul_reason_for_call)
{
case DLL_PROCESS_ATTACH:
dllGlobalVar = 100; //在dll被載入時,賦全域變數為100
break;
case DLL_THREAD_ATTACH:
case DLL_THREAD_DETACH:
case DLL_PROCESS_DETACH:
break;
}
return TRUE;
}
;檔案名稱:lib.def
;在DLL中匯出變數
LIBRARY "dllTest"
EXPORTS
dllGlobalVar CONSTANT
;或dllGlobalVar DATA
GetGlobalVar
從lib.h和lib.cpp中可以看出,全域變數在DLL中的定義和使用方法與一般的程式設計是一樣的。若要匯出某全域變數,我們需要在.def檔案的EXPORTS後添加:
變數名 CONSTANT //過時的方法
或
變數名 DATA //VC++提示的新方法
在主函數中引用DLL中定義的全域變數:
#include <stdio.h>
#pragma comment(lib,"dllTest.lib")
extern int dllGlobalVar;
int main(int argc, char *argv[])
{
printf("%d ", *(int*)dllGlobalVar);
*(int*)dllGlobalVar = 1;
printf("%d ", *(int*)dllGlobalVar);
return 0;
}
特別要注意的是用extern int dllGlobalVar聲明所匯入的並不是DLL中全域變數本身,而是其地址,應用程式必須通過強制指標轉換來使用DLL中的全域變數。這一點,從*(int*)dllGlobalVar可以看出。因此在採用這種方式引用DLL全域變數時,千萬不要進行這樣的賦值操作:
dllGlobalVar = 1;
其結果是dllGlobalVar指標的內容發生變化,程式中以後再也引用不到DLL中的全域變數了。
在應用工程中引用DLL中全域變數的一個更好方法是:
#include <stdio.h>
#pragma comment(lib,"dllTest.lib")
extern int _declspec(dllimport) dllGlobalVar; //用_declspec(dllimport)匯入
int main(int argc, char *argv[])
{
printf("%d ", dllGlobalVar);
dllGlobalVar = 1; //這裡就可以直接使用, 無須進行強制指標轉換
printf("%d ", dllGlobalVar);
return 0;
}
通過_declspec(dllimport)方式匯入的就是DLL中全域變數本身而不再是其地址了,筆者建議在一切可能的情況下都使用這種方式。
4.7 DLL匯出類
DLL中定義的類可以在應用工程中使用。
下面的例子裡,我們在DLL中定義了point和circle兩個類,並在應用工程中引用了它們(單擊此處下載本工程附件)。
//檔案名稱:point.h,point類的聲明
#ifndef POINT_H
#define POINT_H
#ifdef DLL_FILE
class _declspec(dllexport) point //匯出類point
#else
class _declspec(dllimport) point //匯入類point
#endif
{
public:
float y;
float x;
point();
point(float x_coordinate, float y_coordinate);
};
#endif
//檔案名稱:point.cpp,point類的實現
#ifndef DLL_FILE
#define DLL_FILE
#endif
#include "point.h"
//類point的預設建構函式
point::point()
{
x = 0.0;
y = 0.0;
}
//類point的建構函式
point::point(float x_coordinate, float y_coordinate)
{
x = x_coordinate;
y = y_coordinate;
}
//檔案名稱:circle.h,circle類的聲明
#ifndef CIRCLE_H
#define CIRCLE_H
#include "point.h"
#ifdef DLL_FILE
class _declspec(dllexport)circle //匯出類circle
#else
class _declspec(dllimport)circle //匯入類circle
#endif
{
public:
void SetCentre(const point ¢rePoint);
void SetRadius(float r);
float GetGirth();
float GetArea();
circle();
private:
float radius;
point centre;
};
#endif
//檔案名稱:circle.cpp,circle類的實現
#ifndef DLL_FILE
#define DLL_FILE
#endif
#include "circle.h"
#define PI 3.1415926
//circle類的建構函式
circle::circle()
{
centre = point(0, 0);
radius = 0;
}
//得到圓的面積
float circle::GetArea()
{
return PI *radius * radius;
}
//得到圓的周長
float circle::GetGirth()
{
return 2 *PI * radius;
}
//設定圓心座標
void circle::SetCentre(const point ¢rePoint)
{
centre = centrePoint;
}
//設定圓的半徑
void circle::SetRadius(float r)
{
radius = r;
}
類的引用:
#include "../circle.h"//包含類聲明標頭檔
#pragma comment(lib,"dllTest.lib");
int main(int argc, char *argv[])
{
circle c;
point p(2.0, 2.0);
c.SetCentre(p);
c.SetRadius(1.0);
printf("area:%f girth:%f", c.GetArea(), c.GetGirth());
return 0;
}
從上述原始碼可以看出,由於在DLL的類實現代碼中定義了宏DLL_FILE,故在DLL的實現中所包含的類聲明實際上為:
class _declspec(dllexport) point //匯出類point
{
…
}
和
class _declspec(dllexport) circle //匯出類circle
{
…
}
而在應用工程中沒有定義DLL_FILE,故其包含point.h和circle.h後引入的類聲明為:
class _declspec(dllimport) point //匯入類point
{
…
}
和
class _declspec(dllimport) circle //匯入類circle
{
…
}
不錯,正是通過DLL中的
class _declspec(dllexport) class_name //匯出類circle
{
…
}
與應用程式中的
class _declspec(dllimport) class_name //匯入類
{
…
}
匹對來完成類的匯出和匯入的!
我們往往通過在類的聲明標頭檔中用一個宏來決定使其編譯為class _declspec(dllexport) class_name還是class _declspec(dllimport) class_name版本,這樣就不再需要兩個標頭檔。本程式中使用的是:
#ifdef DLL_FILE
class _declspec(dllexport) class_name //匯出類
#else
class _declspec(dllimport) class_name //匯入類
#endif
實際上,在MFC DLL的講解中,您將看到比這更簡便的方法,而此處僅僅是為了說明_declspec(dllexport)與_declspec(dllimport)匹對的問題。
由此可見,應用工程中幾乎可以看到DLL中的一切,包括函數、變數以及類,這就是DLL所要提供的強大能力。只要DLL釋放這些介面,應用程式使用它就將如同使用本工程中的程式一樣!
本章雖以VC++為平台講解非MFC DLL,但是這些普遍的概念在其它語言及開發環境中也是相同的,其思維方式可以直接過渡。
接下來,我們將要研究MFC規則DLL(待續...)