VC++动态链接库编程之非MFC DLL

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 &centrePoint);
　　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 &centrePoint)
{
　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。