2005-7-13
ObjectARX ADO编程FAQ
From www.mjtd.com
在ObjectARX中使用ADO数据库编程
1、 ADO数据库及ADO类型库
在介绍编程方法前，先简要说说ADO。<这里字数可能相对较少，但可能包括你也许不曾注意到的关于ADO的细节，尤其是对于没有C++数据库编程经验的读者，这里将展示在ADO数据库COM接口全部内容中查找的方法。>
ADO，即ActiveX数据对象，是目前比较新的高层数据库API。(目前最新的数据库API应该是ADO.NET，对它的访问要通过基于WINNT内核的VB.NET、VC.NET或者C#.NET等编程语言。)ADO作为ActiveX对象，提供了两套API编程接口，一套通过OLE自治提供，面向不使用指针的编程语言，例如我们在VB/VBA、VisualLISP或者脚本语言中对ADO的访问。另一套通过定制(vtable)界面为C++提供，本文主要针对这个界面讨论。
ADO的编程模型一般要包含这样一个动作序列：
建立一个到数据源的连接->指定对数据源的查询并执行查询->批查询到的数据放到一个C++类中以便程序访问->读取或者编辑数据源。
当然，ADO还应该提供检测错误的一般方法，只是这种方法与一般C++程序错误处理相似，本文不作介绍。
一般情况，我们要使用到以上提到的ADO编程模型中的所有步骤。但ADO有很强的灵活性，你也可以使用模型的一部分。这一点后面结合编程方法介绍。以下介绍ADO类型库：
ADO实质上与其它COM(组件对象模型)类似，我们可以通过运行VC6的OLE-COM Object Viewer工具来观察ADO类型库所公开的函数和接口。我们要使用的ADO类型库存放在msado15.dll文件中。<看文件名，似乎我们使用的是ADO 1.5，实际上，WIN98以后的版本，这个文件使用的是ADO 2.0。而ADO 1.5是不支持COM接口的，好象不能在ObjectARX应用程序中使用，若你的机器安装的是WIN95，可以从WIN98系统中复制该文件。>现在我们开始运行VC6，去看看ADO类型库。选择VC6 Tools菜单中的Ole View，在弹出的子窗口中选择Files菜单下的View TypeLib ...，找到msado15.dll文件。通常它在X:\Program Files\Common Files\System\ado目录下，这里的X:指你的WINDOWS操作系统安装盘符。OLE-COM Object Viewer窗口的左边树型的元素就是ADO类型库的各个接口。我们打开interface Connection元素，在窗口右边将显示ADO Connection对象的定制COM接口的IDL（接口定义语言）代码，＜这是一个基本上与语言无关的C＋＋头文件代码，与通常的C＋＋语言稍有不同。＞在这列出了_Connection类对象的成员函数及其参数。在函数和参数前的[ ]括号内给出了额外的属性，这里介绍两个常用的：
out：表示该参数用于输出，它应该是一根指针，COM将修改这根指针，程序以后可以使用它。
in：表示该参数用于输入，即调用函数前，应该指定参数值，该参数所使用的资源（内存）由函数调用者分配并释放。
retval：与out参数配合使用，表示该参数为接口函数的返回值。(所有COM接口函数都返回一个HRESULT，从而可以另外定义一个out参数作为返回值。)
optional：表示该参数可以接受一个NULL值。
defaultvalue：为可选参数定义缺省值。
你还可以展开interface Connection，在它的成员函数后，再展开Inherited Interfaces，查看_Connection类对象从它的父对象继承的成员函数及其参数定义。
你可能还注意到了窗口左边的dispinterfaces _Connection元素，这是ADO为没有指针的语言准备的另一套接口。
2、 在ObjectARX中使用ADO数据库的基本方法
(1) 初始化COM库，引入ADO类型库
(2) 用Connection对象连接数据库
(3) 利用建立好的连接，通过Connection、Command对象执行SQL命令，或利用Recordset对象取得结果记录集进行查询、处理。
(4) 使用完毕后关闭连接释放对象。
第一步：初始化COM库，引入ADO类型库：
首先要在DllMain()函数中添加COM库初始化代码：
extern "C" BOOL WINAPI DllMain(HINSTANCE hInstance, DWORD dwReason,)
{
AfxOleInit();
...
然后引入ADO类型库，在stdAfx.h文件中添加以下代码：
#include <comdef.h>
#import "c:\Program files\common files\system\ado\msado15.dll" \
rename_namespace("ARXADO") rename("EOF","AdoEOF") \
rename("EOS","AdoEOS")
#import语句的作用就是引入ADO类型库，编译时，VC将生成msado15.tlh,ado15.tli两个C++头文件来定义ADO类型库。该语句后面使用rename_namespace()给ADO类型库函数指定新的命名空间。我们知道，ARX程序中的ACAD图形也是数据库，其访问方式虽然与ADO有很大的不同，但它们使用了大量相同的关键字定义，我们有必要为ADO类型库指定新的命名空间，以避开ADO与ARX库的命名冲突。修改ADO的EOF（文件结束）和EOS（流结束）关键字也是出于同样的考虑。另外，在编译的时候会出现如下警告，对此微软在MSDN中作了说明，并建议我们不要理会这个警告。
msado15.tlh(405) : warning C4146: unary minus operator applied to unsigned type, result still unsigned
或者你可以在#import语句前加上：
#pragma warning(disable: 4146)
忽略这个警告。
第二步，用Connection对象连接数据库
首先，要声明一个指向Connection类对象的指针为ARX应用程序的全局变量(也就是说，在整个ARX应用程序中我们将要共享这根指针)：
_ConnectionPtr pConn;
ADO数据库编程并不需要MFC，但若你的ARX程序使用了MFC，也可以从Cdialog基类派生一个自己的对话框，并在对话框中完成对ADO数据库的操作。这样可以在自定义对话框类中添加public成员变量：
_ConnectionPtr pConn;
这根指针所指向的对象类型就是我们在ADO类型库接口中看到的_Connection对象，对象名的后缀Ptr表示该对象为智能型指针对象。
在ARX程序中，在你需要使用ADO数据库时添加以下代码建立ADO连接：
...
HRESULT hr;
hr = pConn.CreateInstance("ADODB.Connection"); //创建Connection对象
if(SUCCEEDED(hr))
{
CString strConn = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=";
strConn += YourDataSource; //YourDataSource为数据库的带路径文件名
hr = pConn->Open(_bstr_t(strConn),"","",adModeUnknown); //连接数据库
//上面连接字串中的Provider是针对ACCESS2000环境的，对于
//ACCESS97,需要改为:Provider=Microsoft.Jet.OLEDB.3.51; }
if(SUCCEEDED(hr))
{
acutPrintf("数据库已经连接!\n");
}
}
...
或者将上述代码添加到CMyDialog::OnInitialize()函数中。CMyDialog是从CDialog中派生的自定义对话框类。
在以上代码中Open()函数使用的第一个参数我们将它进行类型转换：
_bstr_t(strConn)
现在我们再次进入VC6的OLE-COM Object Viewer中看看ADO提供的接口中_Connection类的成员函数Open()。这个函数的接口定义在_Connection对象的基类Connection15中，在右边树型控件中展开基类Connection15，找到Open函数。我们可以看到，该函数的第一个参数为BSTR类型的连接字符串。而_bstr_t是VC6的COM支持类，在comdef.h中定义，我们可以把_bstr_t实例作为参数传递给要求给出BSTR的ADO函数。在这只要知道_bstr_t使得在VC中使用BSTR更为容易就行了。类似的我们也能明白Open()函数接口的第二、第三个参数的意义：分别为连接数据库的用户ID和密码字符串。最后一个选项参数在ADO接口中的ConnectModeEnum枚举类中定义，我们也可以展开该枚举的接口看看在Open()函数中可以使用的选项。
第三步，利用建立好的连接，通过Connection、Command对象执行SQL命令，或利用Recordset对象取得结果记录集进行查询、处理。
为了取得结果记录集，我们定义一个指向Recordset对象的指针:
_RecordsetPtr pRcdset;
并为其创建Recordset对象的实例:
pRcdset.CreateInstance("ADODB.Recordset");
SQL命令的执行可以采用多种形式。
(1) 利用Connection对象的Execute()成员函数执行SQL命令
与Open()成员函数一样，Execute()也是从Connection15基类继承的，其接口定义可以在OLE-COM Object Viewer中看到。由于最后一个参数是返回值(即具有retval属性)，真正的函数原型变为：
_RecordsetPtr Connection15::Execute ( _bstr_t CommandText,
VARIANT * RecordsAffected, long Options )
其中CommandText是命令字串，通常是SQL命令。
参数RecordsAffected是操作完成后所影响的行数。
参数Options表示CommandText中内容的类型，见CommandTypeEnum枚举类接口定义。
Execute执行完后返回一个指向记录集的指针，可以结合以下具体代码理解。
_variant_t RecordsAffected; //注意该变量的类型为COM支持类_variant_t
//执行SQL命令：CREATE TABLE创建表格：零件,该表包含四个字段:
//整形：ID,字符串：零件名称,整形：数量,日期型：制造日期
pConn->Execute("CREATE TABLE 零件(ID INTEGER,零件名称 TEXT,数量 INTEGER,
制造日期 DATETIME)",&RecordsAffected,adCmdText);
//往表格里面添加记录
pConn->Execute("INSERT INTO 零件(ID,零件名称,数量,制造日期)
value (1, ''直径25圆柱直齿轮'',12,''2003/9/19'')",
&RecordsAffected,adCmdText);
//执行SQL统计命令得到包含记录条数的记录集
pRcdset = pConn->Execute("SELECT COUNT(*) FROM 零件",
&RecordsAffected,adCmdText);
_variant_t vIndex = (long)0;
_variant_t vCount = Rcdset->GetCollect(vIndex);//取得第一个字段的值放入vCount变量
pRcdset->Close(); //关闭记录集
CString message;
message.Format("共有%d条记录",vCount.lVal);
AfxMessageBox(message); //显示当前记录条数，
//若你的ARX程序没有使用MFC，在这可以使用acutPrintf()输出
(2) 利用Command对象来执行SQL命令
在以下代码中我们用Command对象来执行了SELECT查询语句
_CommandPtr pCmd;
pCmd.CreateInstance("ADODB.Command");
_variant_t vNULL;
vNULL.vt = VT_ERROR;
vNULL.scode = DISP_E_PARAMNOTFOUND; //定义为无参数
pCmd->ActiveConnection = pConn; //非常关键的一句，将建立的连接赋值给它
pCmd->CommandText = "SELECT * FROM 零件"; //命令字符串
pRcdset = pCmd->Execute(&vNULL,&vNULL,adCmdText); //执行命令，取得记录集
注意：以上代码最后一行调用的是_Command的接口函数Execute，该函数是_Command类从Command15基类中继承来的，它返回一个记录集指针对象。
Command对象在进行存储过程的调用中才能真正体现它的作用。在这暂不作深入介绍。
(3) 直接用Recordset对象进行查询取得记录集
例如
pRcdset->Open("SELECT * FROM 零件",
_variant_t((IDispatch *)pConn,true),
adOpenStatic,adLockOptimistic,adCmdText);
Open接口函数是从Recordset15基类继承的:
① Source是数据查询字符串
② ActiveConnection是已经建立好的连接
我们需要将_Connection对象指针转换为OLE接口类型，即为VB/VBA、VisualLISP等提供的另一套接口类型，以支持VARIANT数据类型。最后再转换为_variant_t对象。
③ CursorType光标类型，见CursorTypeEnum枚举类接口
④ LockType锁定类型，见LockTypeEnum枚举类接口
⑤Options与Connection对象的Execute()接口函数类似
第四步，记录集的遍历、更新
根据我们刚才通过执行SQL命令建立好的零件表，它包含四个字段:ID,零件名称,数量,制造日期。以下的代码实现：打开记录集，遍历所有记录，删除第一条记录，添加三条记录，移动光标到第二条记录，更改其数量，保存到数据库。
_variant_t vName,vDate,vID,vNumber;
_RecordsetPtr pRcdset;
pRcdset.CreateInstance("ADODB.Recordset");
pRcdset->Open("SELECT * FROM 零件",
_variant_t((IDispatch*)pConn,true),
adOpenStatic,adLockOptimistic,adCmdText);
while(!pRcdset->adoEOF)
//这里为什么是adoEOF而不是EOF呢?还记得rename("EOF","adoEOF")这一句吗?
{
vID = pRcdset->GetCollect(_variant_t((long)0));
//取得第1列的值,从0开始计数，你也可以直接给出列的名称，如下一行
vName = pRcdset->GetCollect("零件名称"); //取得零件名称字段的值
vNumber = pRcdset->GetCollect("数量");
vDate = pRcdset->GetCollect("制造日期");
//在ACAD命令行输出记录集中的记录
if(vID.vt != VT_NULL && vName.vt != VT_NULL
&& vNumber.vt != VT_NULL && vDate.vt != VT_NULL)
{
acutPrintf("id:%d,零件名称:%s,数量:%d,制造日期:%s\r\n",
vID.lVal,(LPCTSTR)(_bstr_t)vName,vNumber.lVal,(LPCTSTR)(_bstr_t)vDate);
}
pRcdset->MoveNext(); //移到下一条记录
} //End of While
pRcdset->MoveFirst(); //移到第一条记录
pRcdset->Delete(adAffectCurrent); //删除当前记录
//添加三条新记录并赋值
for(int i=0;i<3;i++)
{
pRcdset->AddNew(); //添加新记录
pRcdset->PutCollect("ID",_variant_t((long)(i+10)));
pRcdset->PutCollect("零件名称",_variant_t("M20螺栓"));
pRcdset->PutCollect("数量",_variant_t((long)75));
pRcdset->PutCollect("制造日期",_variant_t("2003-9-25"));
}
//从第一条记录往下移动一条记录,即移动到第二条记录处
pRcdset->Move(1,_variant_t((long)adBookmarkFirst));
pRcdset->PutCollect(_variant_t("数量"),_variant_t((long)45)); //修改其数量
pRcdset->Update(); //保存到库中
第五步，关闭记录集与连接
记录集或连接都可以用各自的Close接口函数来关闭：
pRcdset->Close(); //关闭记录集
pConn->Close(); //关闭连接
至此已经介绍了在VC6和ObjectARX中使用ADO数据库的基本方法，当然，这只能算是ADO数据库编程的最初步的介绍，我也仅仅希望这些文字能起到抛砖引玉的作用。 |