在DLL中使用資源（一）
yuwei - 轉載 （2004-12-10 14:02:00） .Net控件開發 ActiveX/COM開發 CLX/VCL開發 Java組件開發 VC/MFC 控件使用經驗談 DHtml/Script 控件開發基礎 數據庫 編程規范 單元測試 可重用軟件技術理論 其 它
在DLL中使用資源（一）
現在最常看見的關于DLL的問題就是如何在DLL中使用對話框，這是一個很普遍的關于如何在DLL中使用資源的問題。這里我們從Win32 DLL和MFC DLL兩個方面來分析并解決這個問題。
1．Win32 DLL
在Win32 DLL中使用對話框很簡單，你只需要在你的DLL中添加對話框資源，而且可以在對話框上面設置你所需要的控件。然后使用DialogBox或者CreateDialog這兩個函數（或相同作用的其它函數）來創建對話框，并定義你自己的對話框回調函數處理對話框收到的消息。下面通過一個具體實例來學習如何在Win32 DLL中使用對話框，可以按照以下步驟來完成這個例子：
1）在VC菜單中File->New新建一個命名為UseDlg的Win32 Dynamic-Link Library工程，下一步選擇A simple DLL project。
2）在VC菜單中Insert->Resource添加一個ID為IDD_DLG_SHOW的Dialog資源，將此Dialog上的Cancel按鈕去掉，僅保留OK按鈕。再添加一個ID為IDD_ABOUTBOX的對話框，其Caption為About。保存此資源，將資源文件命名為UseDlg.rc。并將resource.h和UseDlg.rc加入到工程里面。
3）在UseDlg.app中包含resource.h，并添加如下代碼：
HINSTANCE hinst = NULL;
HWND hwndDLG = NULL;
BOOL CALLBACK DlgProc(HWND hDlg, UINT message,
WPARAM wParam, LPARAM lParam);
BOOL CALLBACK AboutProc(HWND hDlg, UINT message,
WPARAM wParam, LPARAM lParam);
extern "C" __declspec(dllexport) void ShowDlg();
BOOL APIENTRY DllMain( HANDLE hModule,
DWORD ul_reason_for_call,
LPVOID lpReserved
)
{
switch(ul_reason_for_call)
{
case DLL_PROCESS_ATTACH:
hinst = (HINSTANCE)hModule;
case DLL_PROCESS_DETACH:
break;
}
return TRUE;
}
extern "C" __declspec(dllexport) void ShowDlg()
{
hwndDLG = CreateDialog(hinst,MAKEINTRESOURCE(IDD_DLG_SHOW),
NULL,(DLGPROC)DlgProc);
ShowWindow(hwndDLG, SW_SHOW);
}
BOOL CALLBACK DlgProc(HWND hDlg, UINT message,
WPARAM wParam, LPARAM lParam)
{
switch(message)
{
case WM_INITDIALOG:
return TRUE;
case WM_COMMAND:
if(LOWORD(wParam)==IDOK)
DialogBox(hinst,MAKEINTRESOURCE(IDD_ABOUTBOX),
hDlg,(DLGPROC)AboutProc);
return TRUE;
case WM_CLOSE:
DestroyWindow(hDlg);
hwndDLG = NULL;
return TRUE;
}
return FALSE;
}
BOOL CALLBACK AboutProc(HWND hDlg, UINT message,
WPARAM wParam, LPARAM lParam)
{
switch(message)
{
case WM_CLOSE:
EndDialog(hDlg,NULL);
hwndDLG = NULL;
return TRUE;
}
return FALSE;
}
4）編譯生成UseDlg.dll和UseDlg.lib。
接下來我們建立調用此DLL的應用程序，其步驟如下：
1）在VC菜單中File->New新建一個命名為Use的MFC AppWizard(exe)工程，下一步選擇Dialog Based之后點擊Finish按鈕。
2）在主對話框上面添加一個按鈕，之后雙擊此按鈕，會彈出Add Member Function的對話框，直接點擊OK進入void CUseDlg::OnButton1()函數。并在此函數內添加一個函數調用：ShowDlg();。
3）緊跟在#include語句后面加上如下代碼：
extern "C" __declspec(dllexport) void ShowDlg();
#pragma comment(lib,"debug/UseDlg")
4）將上面UseDlg工程中生成的UseDlg.dll和UseDlg.lib兩個文件復制到Use工程的Debug目錄內。
5）編譯生成Use.exe。
運行Use.exe，點擊Button1按鈕，可以看到一個名稱為Dialog的非模態對話框彈出。點擊上面的按鈕，可以彈出模態對話框About。運行成功。
讓我們來回顧一下在Win32 DLL中使用對話框的過程。
在DLL中，我們定義了兩個對話框資源：IDD_DLG_SHOW和IDD_ABOUTBOX，并且導出了函數ShowDlg。在函數ShowDlg之中使用CreateDialog函數創建了非模態對話框IDD_DLG_SHOW，并指定了該對話框的回調函數DlgProc。在DlgProc之中處理了WM_INITDIALOG、WM_COMMAND和WM_CLOSE消息，以響應用戶對對話框所做的動作。在處理按鈕動作的時候，使用DialogBox函數創建IDD_ABOUTBOX這個模態對話框，指定其回調函數為AboutProc，并且在AboutProc中處理其相應消息。
在EXE中，我們使用隱式鏈接的方法來調用DLL，并使用DLL中導出的ShowDlg函數來調用DLL中的對話框。
在Win32 DLL中使用對話框就是這么簡單，下面讓我們來看一下在MFC DLL中如何使用對話框。
2．MFC DLL
在MFC DLL中使用對話框不像Win32 DLL中那么簡單，主要是因為MFC程序中存在一個模塊狀態（Module State）的問題，也就是資源重復的問題。（此處的術語模塊是指一個可執行程序，或指其操作不依賴于應用程序的其余部分但使用MFC運行庫的共享副本的一個DLL（或一組DLL）。我們所創建的MFC DLL就是這種模塊的一個典型實例。）
在每個模塊（EXE或DLL）中，都存在一種全局的狀態數據，MFC依靠這種全局的狀態數據來區分不同的模塊，以執行正確的操作。這種數據包括：Windows實例句柄（用于加載資源），指向應用程序當前的CWinApp和CWinThread對象的指針，OLE模塊引用計數，以及維護Windows對象句柄與相應的MFC對象實例之間連接的各種映射等。但當應用程序使用多個模塊時，每個模塊的狀態數據不是應用程序范圍的。相反，每個模塊具有自已的MFC狀態數據的私有副本。這種全局的狀態數據就叫做MFC模塊狀態。
模塊的狀態數據包含在結構中，并且總是可以通過指向該結構的指針使用。當代碼在執行時進入了某一個模塊時，只有此模塊的狀態為“當前”或“有效”狀態時，MFC才能正確的區分此模塊并執行正確的操作。
例如，MFC應用程序可以使用下面代碼從資源文件中加載字符串：
CString str;
str.LoadString(IDS_MYSTRING);
使用這種代碼非常方便，但它掩蓋了這樣一個事實：即此程序中IDS_MYSTRING可能不是唯一的標識符。一個程序可以加載多個DLL，某些DLL可能也用IDS_MYSTRING標識符定義了一個資源。MFC怎樣知道應該加載哪個資源呢？MFC使用當前模塊狀態查找資源句柄。如果當前模塊不是我們要使用的正確模塊，那么就會產生不正確的調用或者錯誤。
按照MFC庫的鏈接方法，一個MFC DLL有兩種使用MFC庫的方法：靜態鏈接到MFC的DLL和動態鏈接到MFC的DLL。下面我們就按照這兩種類型的MFC DLL來介紹如何切換當前模塊狀態以正確的在MFC DLL中使用資源。
1、靜態鏈接到MFC的DLL
靜態鏈接到MFC的規則DLL與MFC庫靜態鏈接，則此時MFC庫不能共享，所以MFC總是使用它所鏈接的DLL的模塊狀態。這樣也就不存在管理模塊狀態的問題。但使用這種方法的缺點是DLL程序將會變大，而且會在程序中留下重復代碼。下面給出的例子驗證了這一點。本例可以按照以下步驟來完成：
1）在VC菜單中File->New新建一個命名為DLLStatic的MFC AppWizard的工程，下一步選擇Regular DLL with MFC statically linked。
2）在工程中添加一個對話框資源，其ID為：IDD_ABOUTBOX。并在resource.h之中將IDD_ABOUTBOX 的數值改為100。
3）在DLLStatic.cpp中定義如下函數：
void ShowDlg()
{
CDialog dlg(IDD_ABOUTBOX);
dlg.DoModal();
}
4）在DLLStatic.def文件中的EXPORTS語句中添加一行：ShowDlg，以導出ShowDlg函數。
5）編譯生成DLLStatic.dll和DLLStatic.lib。
繼續使用上一節中的Use工程，將前面生成的DLLStatic.dll和DLLStatic.lib兩個文件復制到工程的Debug目錄內，并將
extern "C" __declspec(dllexport) void ShowDlg();
#pragma comment(lib,"debug/UseDlg")
這兩行改為：
void ShowDlg();
#pragma comment(lib,"debug/DLLStatic")
編譯并運行Use.exe。點擊按鈕，可以看到DLLStatic中的模態對話框彈出。
本例中，可以注意到DLL中所定義的About對話框資源與EXE中所定義的About對話框資源ID完全相同，但是當我們點擊Use.exe上面的按鈕時，彈出的是DLL中的模態對話框。說明，當使用靜態鏈接到MFC的規則DLL時，不存在管理模塊狀態的問題。
2、動態鏈接到MFC的DLL
在討論關于動態鏈接到MFC的DLL的模塊狀態問題之前，先來看一個例子。本例可以通過如下步驟來完成：
1）在VC菜單中File->New新建一個命名為DLLShared的MFC AppWizard的工程，下一步選擇Regular DLL using shared MFC DLL。
2）在工程中添加一個對話框資源，其ID為：IDD_ABOUTBOX。并在resource.h之中將IDD_ABOUTBOX 的數值改為100。
3）在DLLShared.cpp中定義如下函數：
void ShowDlg()
{
CDialog dlg(IDD_ABOUTBOX);
dlg.DoModal();
}
4）在DLLShared.def文件中的EXPORTS語句中添加一行：ShowDlg，以導出ShowDlg函數。
5）編譯生成DLLShared.dll和DLLShared.lib。
繼續使用上面的Use工程，將前面生成的DLLShared.dll和DLLShared.lib兩個文件復制到工程的Debug目錄內，并將
extern "C" __declspec(dllexport) void ShowDlg();
#pragma comment(lib,"debug/DLLStatic")
這兩行改為：
void ShowDlg();
#pragma comment(lib,"debug/DLLShared")
編譯并運行Use.exe。點擊按鈕，這次你看到了什么？對，沒錯，這次彈出的是Use.exe的關于對話框。將上述例子的DLL類型換成MFC Extension DLL(using shared MFC DLL)也會出現相同的問題。
為什么會出現上面的問題？這是因為在使用了MFC共享庫的時候，默認情況下，MFC使用主應用程序的資源句柄來加載資源模板。雖然我們調用的是DLL中的函數來顯示DLL中的對話框，并且對應的對話框模板是存儲在DLL中的，但MFC仍舊在主應用程序也就是Use.exe中尋找相應的對話框模板。由于在DLL中所定義的對話框資源ID與主應用程序中所定義的關于對話框的資源ID相同，所以MFC就把主應用程序中的關于對話框顯示了出來。如果二者不同，則MFC就認為DLL中所定義的對話框資源不存在，dlg.DoModal會返回0，也就是什么都不會顯示。
那么如何解決上述問題呢？解決辦法就是在適當的時候進行模塊狀態切換，以保證具有當前狀態的模塊是我們所需要的模塊從而使用正確的資源。MFC提供了下列函數和宏來完成這些工作：
AfxGetStaticModuleState：這是一個函數，其函數原型為：
AFX_MODULE_STATE* AFXAPI AfxGetStaticModuleState( );
此函數在堆棧上構造AFX_MODULE_STATE類的實例pModuleState并對其賦值后將其返回。在AFX_MODULE_STATE類的構造函數中，該類獲取指向當前模塊狀態的指針并將其存儲在成員變量中，然后將pModuleState設置為新的有效模塊狀態。在它的析構函數中，該類將存儲在其成員變量中的指針還原為存貯的前一個模塊狀態。
AFX_MANAGE_STATE：這是一個宏，其原型為：
AFX_MANAGE_STATE( AFX_MODULE_STATE* pModuleState )
該宏用于將pModuleState（指向包含模塊全局數據也就是模塊狀態的AFX_MODULE_STATE結構的指針）設置為當前的即時作用空間中（the remainder of the immediate containing scope）的有效模塊狀態。在離開包含該宏的作用空間時，前一個有效的模塊狀態自動還原。
AfxGetResourceHandle：這個函數的原型為：
HINSTANCE AfxGetResourceHandle( );
該函數返回了一個保存了HINSTANCE類型的、應用程序默認所加載資源的模塊的句柄。
AfxSetResourceHandle：這個函數的原型為：
void AfxSetResourceHandle( HINSTANCE hInstResource );
該函數將hInstResource所代表的模塊設置為具有當前狀態的模塊。
通過使用上述四個函數或宏就可以正確的在動態鏈接到MFC的DLL中切換模塊狀態。接下來我們將通過修改上面出現問題的那個例子來介紹如何使用上述四個函數或宏。先來看看Regular DLL using shared MFC DLL類型：
在上述例子的第三步的ShowDlg函數的第一條語句前加上如下語句（要確保該語句在函數實現的第一行）：
AFX_MANAGE_STATE(AfxGetStaticModuleState());
之后重新編譯生成DLLShared.dll和DLLShared.lib，并將這兩個文件重新拷貝到Use工程的Debug目錄內。這次編譯生成Use.exe并運行，點擊按鈕，可以看到彈出的時我們在DLL中所加入的那個對話框，而不再是Use.exe的關于對話框了。
通過上面的講解，相信你已經知道該語句的作用了。在函數ShowDlg的第一行加上這么一句后，每次調用DLL的應用程序使用該函數的時候，MFC庫都會自動切換當前模塊狀態，這樣就保證了資源讀取的正確性。
AFX_MANAGE_STATE(AfxGetStaticModuleState());是自動切換當前模塊狀態，也可以通過使用AfxGetResourceHandle和AfxSetResourceHandle來手動切換當前模塊狀態。具體使用方法如下：
在上述例子的第三步的ShowDlg函數的第一條語句前加上如下語句（要確保該語句在函數實現的第一行）：
HINSTANCE save_hInstance = AfxGetResourceHandle();
AfxSetResourceHandle(theApp.m_hInstance);
在調用對話框成功之后，也就是dlg.DoModal();之后，添加：
AfxSetResourceHandle(save_hInstance);
這種方法在進入ShowDlg函數之后，通過AfxGetResourceHandle來獲得并保存當前狀態模塊的句柄。然后獲得DLL模塊的句柄theApp.m_hInstance（當然，也可以使用GetModuleHandle函數來獲得DLL模塊的句柄），并使用AfxSetResourceHandle函數來將其設置為當前狀態狀態。最后在調用對話框成功之后再用恢復AfxSetResourceHandle資源句柄，將當前模塊狀態恢復。
這樣做有些麻煩，但是有一點好處是可以在完成使用資源的任務之后就可以立即恢復資源句柄。而AFX_MANAGE_STATE(AfxGetStaticModuleState());的方法只能等函數的作用空間結束之后才恢復資源句柄。由于可執行文件必須重畫工具條等原因，因此建議只要有可能就必須恢復資源句柄，否則可能會遇到許多問題。比如說，如果用戶移動DLL的對話框，而此時資源句柄仍然為DLL的資源，那么程序就會崩潰。最好的恢復句柄的時機在對話框響應WM_INITDIALOG消息的時候，因為這時對話框的模板等已經讀出了。
對于MFC Extension DLL(using shared MFC DLL)類型的MFC DLL，切換當前模塊狀態的方法與Regular DLL using shared MFC DLL類型的MFC DLL所使用的方法很相似，這里不再舉例實現。二者不同的地方如下：
在MFC擴展DLL中使用AFX_MANAGE_STATE(AfxGetStaticModuleState());時，會產生如下錯誤：
mfcs42d.lib(dllmodul.obj) : error LNK2005: __pRawDllMain already defined in dllextend.obj
mfcs42d.lib(dllmodul.obj) : error LNK2005: _DllMain@12 already defined in dllextend.obj
mfcs42d.lib(dllmodul.obj) : error LNK2005: __pRawDllMain already defined in dllextend.obj
因此在MFC擴展DLL中需要將AFX_MANAGE_STATE(AfxGetStaticModuleState());換成AFX_MANAGE_STATE(AfxGetAppModuleState());才能正確切換當前模塊狀態。
在MFC擴展DLL中使用AfxGetResourceHandle和AfxSetResourceHandle的方法與在Regular DLL using shared MFC DLL類型的MFC DLL中所使用的方法相同。并且，DLL模塊的句柄可以通過MFC提供的DlgextentDLL這個結構的hModule成員來獲得。即使用AfxSetResourceHandle(DlgextentDLL.hModule);語句。
當然，對于動態鏈接到MFC的DLL，也可以在調用該DLL的MFC應用程序中使用AfxGetResourceHandle和AfxSetResourceHandle兩個函數來切換當前狀態模塊。該DLL模塊的句柄可以用GetModuleHandle函數來獲得。在此不再贅述。