MFC多個dll同時操作時導致資源出錯問題

在MFC使用過程中，遇到DLL資源與主EXE資源衝突問題。

出現這樣的Bug，一時無從下手。

報錯位置在覈心代碼中dlgcore.cpp。

BOOL AFXAPI _AfxCheckDialogTemplate(LPCTSTR lpszResource, BOOL bInvisibleChild)
{
    ASSERT(lpszResource != NULL);
    HINSTANCE hInst = AfxFindResourceHandle(lpszResource, RT_DIALOG);
    HRSRC hResource = ::FindResource(hInst, lpszResource, RT_DIALOG);
    if (hResource == NULL)
    {
        if (DWORD_PTR(lpszResource) > 0xffff)
            TRACE(traceAppMsg, 0, _T("ERROR: Cannot find dialog template named '%s'.\n"),
                lpszResource);
        else
            TRACE(traceAppMsg, 0, "ERROR: Cannot find dialog template with IDD 0x%04X.\n",
                LOWORD((DWORD_PTR)lpszResource));
        return FALSE;
    }

        ......

        return TRUE;
}

AfxFindResourceHandle查找資源文件時，本應在exe中的資源，結果返回了dll的句柄。

解決方法：

//記錄當前資源句柄
HINSTANCE hCurInstance = AfxGetResourceHandle();

//設置主模塊資源句柄
AfxSetResourceHandle(theApp.m_hInstance);

Create(CTestDlg::IDD, GetDesktopWindow());
ShowWindow(SW_HIDE);
ShowWindow(SW_SHOWNOACTIVATE);

//恢復當前模塊句柄
AfxSetResourceHandle(hCurInstance);

參照一篇文章，終於弄清楚了其中的來龍去脈。

文章來源：http://blog.sina.com.cn/s/blog_62bb83b10100jbdj.html。

AFX_MANAGE_STATE(AfxGetStaticModuleState())

先看一個例子：

1、創建一個動態鏈接到MFC DLL的規則DLL，其內部包含一個對話框資源。指定該對話框ID如下：
              #define IDD_DLL_DIALOG 2000

2、創建一個基於對話框的mfc應用程序，它包含兩個對話框資源，IDD_UI_DIALOG和IDD_EXE_DIALOG。並將後者的ID指定如下：
              #define IDD_EXE_DIALOG 2000
其中前者是這個應用程序的用戶界面，單擊上面的按鈕，將彈出一個對話框。部分代碼如下：
// in DLL
void CDLL::ShowDlg(void)
{
       CDialog dlg(IDD_DLL_DIALOG); //打開ID爲2000的對話框
       dlg.DoModal();
}
// in EXE
void CEXE::OnButtonClick()
{
       ShowDlg();
}

3、單擊按鈕，彈出的不是期望的DLL中的對話框IDD_DLL_DIALOG，而是應用程序中的對話框IDD_EXE_DIALOG。

解釋：

1、應用程序進程本身及其調用的每個DLL模塊都具有一個全局唯一的HINSTANCE句柄，它們代表了EXE或DLL模塊在進程虛擬空間中的起始地址。（進程本身的模塊句柄一般爲0x400000，而DLL模塊的缺省句柄爲0x10000000。如果程序同時加載了多個DLL，則每個DLL模塊都會有不同的HINSTANCE。應用程序在加載DLL時對其進行了重定位）。
2、共享MFC DLL（或MFC擴展DLL）的規則DLL涉及到HINSTANCE句柄問題，HINSTANCE句柄對於加載資源特別重要。EXE和DLL都有其自己的資源，而且這些資源的ID可能重複，如果應用程序與規則DLL共享MFC DLL（或MFC擴展DLL），那麼將總是默認使用EXE的資源。
3、因此應用程序需要通過資源模塊的切換來找到正確的資源。如果應用程序需要來自於DLL的資源，就應將資源模塊句柄指定爲DLL的模塊句柄；如果需要EXE文件中包含的資源，就應將資源模塊句柄指定爲EXE的模塊句柄。

解決辦法：

1、在DLL中改進：

方法1。

// in DLL
void CDLL::ShowDlg(void)
{
       AFX_MANAGE_STATE(AfxGetStaticModuleState());
       CDialog dlg(IDD_DLL_DIALOG); //打開ID爲2000的對話框
       dlg.DoModal();
}

注：AFX_MANAGE_STATE(AfxGetStaticModuleState());一定是作爲接口函數的第一條語句。
       其功能是在棧上（這意味着其作用域是局部的）創建一個AFX_MODULE_STATE類的實例，並將其指   針pModuleState返回。
       AFX_MODULE_STATE類利用其構造函數和析構函數進行存儲模塊狀態現場及恢復現場的工作。
       該宏用於將pModuleState設置爲當前的有效模塊狀態。當離開該宏的作用域時（也就離開了pModuleState所指棧上對象的作用域），先前的模塊狀態將由類AFX_MODULE_STATE的析構函數恢復。（即自動恢復）

方法2。

// in DLL
void CDLL::ShowDlg(void)
{
       HINSTANCE save_hInstance = AfxGetResourceHandle();
       AfxSetResourceHandle(theApp.m_hInstance);
       CDialog dlg(IDD_DLL_DIALOG); //打開ID爲2000的對話框
       dlg.DoModal();
       AfxSetResourceHandle(save_hInstance);    
}

注：AfxGetResourceHandle：獲取當前資源模塊句柄；AfxSetResourceHandle：設置程序目前要使用的資源模塊句柄。
       同方法1比較，方法2能夠靈活地設置程序的資源模塊句柄，而方法1則只能在DLL接口函數退出的時候纔會恢復模塊句柄。

2、在應用程序中改進：

// in EXE
void CEXE::OnButtonClick()
{
       HINSTANCE exe_hInstance = GetModuleHandle(NULL);
      HINSTANCE dll_hInstance = GetModuleHandle("SharedDll.dll");
      AfxSetResourceHandle(dll_hInstance); //切換狀態
       ShowDlg();
      AfxSetResourceHandle(exe_hInstance); //恢復狀態
}

注：使用狀態切換的情況：當DLL導出函數包含MFC資源、類或者需要創建窗口時。