初探Delphi中的插件编程实用指南

平时做技术实践时，很多问题不是概念不会，而是细节没串起来。拿“初探Delphi中的插件编程”来说，它看着像小点，放到项目里常会牵出环境、配置、兼容性和维护成本。下面按实际采用顺序，把思路、关键写法和容易踩坑的地方讲清楚，便于大家直接对照操作。

从实现思路看，插件结构的编程需一个插件容器来控制各DLL的运行情况，将划分好的每个子系统安排到一个DLL库文件中。对每个DLL程序需为容器预留接口函数，一般接口函数包括：启动调用DLL库的函数、关闭DLL库的函数。借助接口函数，插件容器能够向DLL模块传递参数实现动态控制。具体实现细节我将在下文说明同时给出响应代码。

从实现思路看，您可能需先了解一下DELPHI中UNIT的结构，工程的结构。本文没有深入讨论DLL编程的理论细节，只是演示了一些实用的代码，我当时学习的是刘艺老师的《DELPHI深入编程》一书。

实际处理时，我也处于DELPHI的入门阶段，只是觉得这次的DLL开发有一些值得讨论的地方，所以写这篇文章，希望各位能对我做的不好的地方慷慨建议。

示例程序简介

在这个场景下，为了便于阅读我将采用一个MIS系统的部分程序代码演示插件编程的一些方法。示例程序是典型的C/S结构DBMS应用程序，我们关注的部分将是框架程序（下文简称Hall）的控制语句和dll插件程序的响应控制。

1、程序结构

结合项目来看，插件容器Hall采用一个独立的工程新建，Hall的主窗口的作用相当于MDI程序中的MDI容器窗体，Hall中将显式调用Dll中的接口函数。
实际处理时，每个插件程序独立采用各自的工程，与普通工程不同的是，DLL工程新建的是Dll Wizard，相应编译生成的文件是以DLL为后缀。






2、接口设计

实例程序Narcissus中我们预留两个接口函数：

ShowDLLForm

落到代码里，该函数将应用程序的句柄传递给DLL子窗口，DLL程序将动态新建DLL窗体的实例。还能够将一些业务逻辑用参数的形式传递给DLL子窗口，比如窗体名称、当前登陆的用户名等。初次调用一个DLL窗体实例时采用此函数新建。

FreeDLLForm

落到代码里，该函数将显示释放DLL窗口实例，在退出应用程序时调用每个DLL窗体的FreeDLLForm方法来释放新建的实例，不然会引起内存只读错误。同样，也能够将一些在释放窗体时需做的业务逻辑用参数的形式传递给DLL窗体。

3、调试方式

在这个场景下，DLL窗体程序无法直接执行，需有一个插件容器来调用。应此我们需先实现一个基本的Hall程序，随后将Hall.exe保存在一个固定的目录中。对每个DLL工程做如下所示设置：

1) 打开DLL工程

2) 选择菜单 Run – Parameters

3) 在弹出的窗口中浏览到我们的容器Hall.exe

落到代码里，这样在调试DLL程序时将会自动调用Hall程序，借助Hall中预留的调用接口调试DLL程序。

插件程序的基础实现

从实现思路看，DLL程序的设计方式和普通WINAPP没有很大的区别，只是所有的窗口都是作为一种特殊的“资源”保存在DLL库中，需手动调用，而不像WINAPP中会有工程自动新建。声明接口函数的方法很轻松

1) 在Unit的Implementation部分中声明函数

2) 在函数声明语句的尾部加上stdcall标记

实际处理时，3) 在工程代码（Project – View Source）的begin语句之前，用exports语句声明函数接口

理解这一步时，为便于使代码简洁，我个人喜欢在工程中独立添加一个Unit单元（File – New -- Unit），然后将所有要输出的函数体定义在此单元中，不要忘记将引用到的窗体的Unit也uses进来。我命名这个单元为UnitEntrance，在ShowDLLForm函数中初始化了要显示的窗口同时调用Show方法显示，HALL会将登陆的用户名用参数传递过来，得到用户名后就能够进行一些权限控制，表现在界面初始化上。

其代码如下所示

unit UnitOfficeEntrance;

interface
uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms;
function ShowDLLForm(AHandle: THandle; ACaption: string; AUserID: string):boolean;stdcall;
function FreeDLLForm(AHandle: THandle; ACaption: string; AUserID: string):boolean;stdcall;
implementation
uses UnitOfficialMainForm; // 改成MAINFORM的unit
var
DLL_Form:TFormOfficialMain; //改成MAINFORM的NAME

//-----------------------------------------
//Name: ShowDLLForm
//Func: DLL插件调用入口函数
//Para: AHandle 挂靠程序句柄; ACaption 本窗体标题
//Rtrn: N/A
//Auth: CST
//Date: 2005-6-3
//-----------------------------------------

function ShowDLLForm(AHandle: THandle; ACaption: string; AUserID: string):boolean;
begin
result:=true;
try
Application.Handle:=AHandle; //挂靠到主程序容器
DLL_Form:=TFormOfficialMain.Create(Application); //改成MAINFORM的NAME
try
with DLL_Form do
begin
Caption := ACaption;
StatusBar.Panels.Items[0].Text := AUserID;
//Configure UI
Show ;
end;
except
on e:exception do
begin
dll_form.Free;
end;
end;
except
result:=false;
end;
end;

//-----------------------------------------
//Name: FreeDLLForm
//Func: DLL插件调用出口函数
//Para: AHandle 挂靠程序句柄
//Rtrn: true/false
//Auth: CST
//Date: 2005-6-11
//-----------------------------------------

function FreeDLLForm(AHandle: THandle; ACaption: string; AUserID: string):boolean;
begin
Application.Handle:=AHandle; //挂靠到主程序容器
if DLL_Form.Showing then DLL_Form.Close; //如果窗口打开先关闭,触发FORM.CLOSEQUERY可取消关闭过程
if not DLL_Form.Showing then
begin
DLL_Form.Free;
result:=true;
end //仍然打开状态,说明CLOSEQUERY.CANCLOSE=FALSE
else
begin
result:=false;
end;
end;
end.

DLL工程文件代码如下所示：

library Official;


{ Important note about DLL memory management: ShareMem must be the

first unit in your library's USES clause AND your project's (select

Project-View Source) USES clause if your DLL exports any procedures or

functions that pass strings as parameters or function results. This

applies to all strings passed to and from your DLL--even those that

are nested in records and classes. ShareMem is the interface unit to

the BORLNDMM.DLL shared memory manager, which must be deployed along

with your DLL. To avoid using BORLNDMM.DLL, pass string information

using PChar or ShortString parameters. }


uses

SysUtils,

Classes,

UnitOfficialDetailForm in 'UnitOfficialDetailForm.pas' {FormOfficialDetail},

UnitOfficialMainForm in 'UnitOfficialMainForm.pas' {FormOfficialMain},

UnitOfficeEntrance in 'UnitOfficeEntrance.pas',

UnitOfficialClass in '....PublicLibraryUnitOfficialClass.pas',

UnitMyDataAdatper in '....PublicLibraryUnitMyDataAdatper.pas',

UnitMyHeaders in '....PublicLibraryUnitMyHeaders.pas';


{$R *.res}

exports ShowDLLForm,FreeDLLForm; //接口函数

begin

end.

理解这一步时，插件程序一旦调用了DLL窗口，窗口实例将会保持在HALL窗口的上层，所以不用担心遮挡的问题。

容器程序的实现

1、接口函数的引入

在这个场景下，调用DLL库中的函数有显式和隐式两种方式，显式调用更灵活，因此我们采用显示调用。在Delphi中需为接口函数申明函数类型，然后实例化函数类型的实例，该实例实际是一个指向函数的指针，借助指针我们能够访问到函数同时传递参数、拿到得到值。在单元文件的Interface部分加入函数类的申明：

type

//定义接口函数类型,接口函数来自DLL接口

TShowDLLForm = Function(AHandle:THandle; ACaption: String; AUserID:string):Boolean;stdcall;

TFreeDLLForm = Function(AHandle:THandle; ACaption: String; AUserID:string):boolean;stdcall;

显示调用库函数需如下所示几个步骤:

1) 载入DLL库文件

2) 获得函数地址

3) 执行函数

4) 释放DLL库

下面我们将详细讨论这几个步骤。

2、载入DLL库文件

结合项目来看，借助调用API函数LoadLibrary能够将DLL库载入到内存中，在此我们不讨论DLL对内存管理的影响。LoadLibrary的参数是DLL文件的地址路径，如果载入成功会得到一个CARDINAL类型的变量作为DLL库的句柄；如果目标文件不存在或其他原因导致载入DLL文件失败会得到一个0。

3、实例化接口函数

实际处理时，获得接口函数指针的API函数为GetProcAddress(库文件句柄，函数名称)，如果找到函数则会得到该函数的指针，如果失败则得到NIL。
在这个场景下，采用上文定义的函数类型定义函数指针变量，随后采用@操作符获得函数地址，这样就能够采用指针变量访问函数。主要代码如下所示：

……
var
ShowDLLForm: TShowDLLForm; //DLL接口函数实例
FreeDLLForm: TFreeDLLForm;
begin
try
begin
APlugin.ProcAddr := LoadLibrary(PChar(sPath));
APlugin.FuncFreeAddr := GetProcAddress(APlugin.ProcAddr,'FreeDLLForm');
APlugin.FuncAddr := GetProcAddress(APlugin.ProcAddr ,'ShowDLLForm');

@ShowDLLForm:=APlugin.FuncAddr ;
@FreeDLLForm:=APlugin.FuncFreeAddr;
if ShowDllForm(Self.Handle, APlugin.Caption , APlugin.UserID) then
Result:=True
……

4、一个具体的实现方法

在这个场景下，为便于结构化管理插件，便于今后的系统扩充，我们能够结合数据库记录可用的DLL信息，随后借助查询数据库记录动态访问DLL程序。

1) 系统模块表设计

落到代码里，对于MIS系统，能够借助已有的DBS条件建立一个系统模块表，记录DLL文件及映射到系统模块中的相关信息

字段名 作用 类型
AutoID 索引 INT
modAlias 模块别称 VARCHAR
modName 模块名称 VARCHAR
modWndClass 窗体唯一标识 VARCHAR
modFile DLL路径 VARCHAR
modMemo 备注 TEXT

从实现思路看，·模块别称是用来在编程设计阶段统一命名的规则，特别是团队开发时能够供队员参考。

从实现思路看，·模块名称将作为ACAPTION参数传递给SHOWDLLFORM函数作为DLL窗口的标题。

理解这一步时，·窗体唯一标识是DLL子模块中主窗口的CLASSNAME，用来在运行时确定要控制的窗口。

·DLL路径保存DLL文件名称，程序中将转换为绝对路径。

2) 插件信息数据结构

理解这一步时，定义一个记录插件相关信息的数据接口能够集中控制DLL插件。在Interface部分加入如下所示代码：

type

//定义插件信息类

TMyPlugins = class
Caption:String; //DLL窗体标题
DllFileName:String; //DLL文件路径
WndClass:String; //窗体标识
UserID:string; //用户名
ProcAddr:THandle; //LOADLIBRARY载入的库句柄
FuncAddr:Pointer; //SHOWDLLFORM函数指针
FuncFreeAddr:Pointer; //FREEDLLFORM函数指针
end;

……

理解这一步时，为每个插件新建一个TMyPlugins的实例，下文会讨论对这些实例的初始化方法。

3) 插件载入函数

理解这一步时，在本示例中DLL窗口是在HALL中触发打开子窗口的事件中载入同时显示的。按钮事件触发后，先根据插件结构体实例判断DLL是否已经加载，如果已经加载，则控制窗口的显示或关闭；如果没有加载则访问数据表将字段赋值到插件结构体中，然后执行载入、获得指针的工作。

局部代码如下所示

……
//-----------------------------------------

//Name: OpenPlugin

//Func: 插件信息类控制过程： 初始化＝＝》设置权限＝＝》载入DLL窗口

//Para: APlugin-TMyPlugins; sAlias别名; iFuncValue权限值

//Rtrn: N/A

//Auth: CST

//Date: 2005-6-2

//-----------------------------------------

procedure TFormHall.OpenPlugin(AFromActn: TAction ;APlugin:TMyPlugins; sAlias:string; sUserID:string);
var hWndPlugin:HWnd;
begin
　
//判断插件窗口是否已经载入 hWndPlugin:=FindWindow(PChar(APlugin.WndClass),nil);
if hWndPlugin <> 0 then //插件窗口已经载入
begin
if not IsWindowVisible(hWndPlugin) then
begin
AFromActn.Checked := True;
ShowWindow(hWndPlugin,SW_SHOWDEFAULT); //显示
end
else
begin
AFromActn.checked := False;
ShowWindow(hWndPlugin,SW_HIDE) ;
end;
Exit; //离开新建插件过程
end;

//初始化插件类实例

if not InitializeMyPlugins(APlugin,sAlias) then
begin
showmessage('初始化插件类错误。');
exit;
end;

//获得当前权限值

APlugin.UserID := sUserID;
//载入DLL窗口

if not LoadShowPluginForm(APlugin) then
begin
showmessage('载入中心插件出错。');
exit;
end;
end;

//-----------------------------------------
//Name: InitializeMyPlugins
//Func: 初始化MYPLUGIN实例 (Caption | DllFileName | IsLoaded)
//Para: APlugin-TMyPlugins
//Rtrn: N/A
//Auth: CST
//Date: 2005-6-2
//-----------------------------------------

function TFormHall.InitializeMyPlugins(APlugin:TMyPlugins; sAlias:String):Boolean;
var
strSQL:string;
myDA:TMyDataAdapter;
begin
Result:=False;
myDA:=TMyDataAdapter.Create;
strSQL:='SELECT * FROM SystemModuleList WHERE modAlias='+QuotedStr(sAlias);
try
myDA.RetrieveData(strSQL);
except
on E:Exception do
begin
result:=false;
myDA.Free ;
exit;
end;
end;
try
begin
with myDA.MyDataSet do
begin
if Not IsEmpty then
begin
APlugin.Caption:= FieldByName('modName').Value;
APlugin.DllFileName := FieldByName('modFile').Value;
APlugin.WndClass := FieldByName('modWndClass').Value ;
result:=True;
end;
Close;
end; //end of with...do...
end; //end of try
except
on E:Exception do
begin
Result:=False;
myDA.Free ;
Exit;
end; //end of exception
end; //end of try...except

myDA.Free ;
end;



//-----------------------------------------

//Name: LoadShowPluginForm

//Func: 载入DLL插件并显示窗口

//Para: APlugin-TMyPlugins

//Rtrn: true-新建成功

//Auth: CST

//Date: 2005-6-2

//-----------------------------------------

function TFormHall.LoadShowPluginForm (const APlugin:TMyPlugins):boolean;

var
ShowDLLForm: TShowDLLForm; //DLL接口函数实例
FreeDLLForm: TFreeDLLForm;
sPath:string; //DLL文件的完整路径
begin
try
begin
sPath:=ExtractFilepath(Application.ExeName)+ 'plugins' + APlugin.DllFileName ;
APlugin.ProcAddr := LoadLibrary(PChar(sPath));
APlugin.FuncFreeAddr := GetProcAddress(APlugin.ProcAddr,'FreeDLLForm');
APlugin.FuncAddr := GetProcAddress(APlugin.ProcAddr ,'ShowDLLForm');
@ShowDLLForm:=APlugin.FuncAddr ;
@FreeDLLForm:=APlugin.FuncFreeAddr;
if ShowDllForm(Self.Handle, APlugin.Caption , APlugin.UserID) then
Result:=True
else
Result:=False;
end;
except
on E:Exception do
begin
Result:=False;
结合项目来看，ShowMessage('载入插件模块错误，请检查PLUGINS目录里的文件是否完整。');
end;
end;
end;

……

4) DLL窗口控制

落到代码里，正如3)中的代码说明的那样，DLL窗口的打开和关闭只是在表象层，关闭窗口同时没有真正释放DLL窗口，只是调用API函数FindWindow根据窗口标识（就是Form.name）获得窗体句柄，用SHOWWINDOW函数的nCmdShow参数控制窗口显示/隐藏。

实际处理时，其实这是我这个程序实现的不好的一个地方，如果在DLL窗口中采用Self.close方法会引起内存错误，实在能力有限没有办法解决，所以出此下策。所以每个DLL程序主窗口的关闭按钮都必须隐藏掉。 :-P

5) DLL库的释放

实际处理时，在程序退出时，必须根据插件信息实例逐一释放DLL库。释放DLL库的函数如下所示：

procedure TFormHall.ClosePlugin(aPLG:TMyPlugins);
var
FreeDLLForm:TFreeDLLForm;
begin
if aPLG.ProcAddr = 0 then exit;
if aPLG.FuncFreeAddr = nil then exit;
@FreeDLLForm:=aPLG.FuncFreeAddr;
if not FreeDLLForm(Application.Handle,'','') then
showMessage('err');
end;

小结

本实例程序运行效果如下所示：






落到代码里，我以上的方法中，因为有不少能力有限没有解决的问题，所以采用了一些看起来不太合理的掩饰方法，希望大家能在做了一点尝试后设计出更好的解决方法，我也希望能学到更多的好方法。