Caché数据库Ado.Net纠葛之面向接口编程
什么是Ado.NET
ADO.NET是一种数据访问技术，使得应用程序可以连接到数据存储，并以各种方式操作存储在其中的数据。
该技术基于.NET Framework，与.NET Framework类库的其余部分高度集成。ADO.NET API的设计，使得可以从所有面向.NET Framework的语言中使用该API，如Visual Basic、C#、J#、和Visual C++。ADO.NET软件栈包含两个主要部分：提供者和服务。
ADO.NET的“提供者”是一些组件，这些组件知道如何与特定的数据存储设施交互（例如，有一个提供者与SQL Server交互，另一个提供者与Oracle数据库交互）。所有的提供者都向外提供一个统一的API接口，ADO.NET软件栈中的其他层在此API之上建立。
ADO.NET还包括基于提供者而建立的一些服务，设计这些服务的目的，是为了方便编写应用程序。其中一个服务是内存中的缓存（in-memory cache），缓存保存了数据的关系形式，并执行修改跟踪和约束验证等功能；该服务通过ADO.NET DataSet接口提供，包括一些与提供者层进行交互的组件。
五大对象分别是：
1、Connection（连接数据库）
2、Command（执行T-SQL语句）
3、DataAdapter（用户填充DataSet，断开模式）
4、DataReader（读取数据库，一种只读模式，只向前的）
5、DataSet（数据集，好比电脑的内存）
什么是Caché的Ado.Net
Caché的Ado访问层作为Caché提供给.Net的组件允许我们用统一的Ado操作Caché数据库。在Caché2010和2016表现为“InterSystems.Data.CacheClient.dll”，在IRIS表现为“InterSystems.Data.IRISClient.dll”。.Net程序通过引用该组件使用提供的Connection、Command、DataAdapter、DataReader等操作数据库进行增删改查操作。
Caché的Ado.Net的问题
由于Caché的主要提供语言是M语言，虽然声称支持SQL标准，实际对SQL标准支持的还是比较基本的。在使用过程中碰到由2010库到2016库出现的DataReader在有的类表的查询读取最后一行数据报异常的问题（只能用如下方式解决）。
try
{
//遍历读取数据
while (sdr.Read())
{
//行数加1
rowCount++;
//只取起始范围的数据
if (findAll || ((rowCount > rowFrom) && (rowCount <= rowTo)))
{
if (firstFlag)
{
retLength = sb.Length;
JsonHelper.MakeObjJsonByPropertyArr(sb, properties, sdr, fields);
//置第一条标识为假
firstFlag = false;
}
else
{
retLength = sb.Length;
sb.Append(",");
JsonHelper.MakeObjJsonByPropertyArr(sb, properties, sdr, fields);
}
}
}
//行数
if (adoHelper.RowCount != "")
{
rowCount = Convert.ToInt32(adoHelper.RowCount);
adoHelper.RowCount = "";
}
}
catch (Exception ex)
{
sb.Remove(retLength, sb.Length - retLength);
LIS.Core.Util.LogUtils.WriteExceptionLog("读取数据出现内部已知的异常", ex);
}
还有存储过程返回值莫名多不可见字符的问题（只能特殊处理）。
case DatabaseType.CACHE:
retValue = ((IDbDataParameter)(cmd.Parameters[cmd.Parameters.Count - 1])).Value.ToString();
retValue = retValue.Split((char)1)[0];
retValue = retValue.Split((char)13)[0];
break;
还有连接时间久了释放时物理TCP都已经断开的连接还在连接池一直取处于错误的连接和调用的M切换命名空间没切回来Connection对象一直是切换后的控制导致M调不到的问题（只能清理连接池）。
catch (Exception e)
{
if (cmdType == CommandType.StoredProcedure)
{
//异常就清除连接池
DbFactory.ClearPool(conn);
}
//赋值错误信息
errorInfo = e.Message;
//写入日志
LogUtils.WriteSqlLog(cmdText + ":" + e.Message + ",失败！");
return 0;
}
/// 正常我们只要实现下面个接口就可以确保基于Ado的ORM访问层正常
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using InterSystems.Data.CacheClient;
namespace LIS.DAL.Base
{
///
/// [创建者: zlz]
/// [创建时间: 2015-03-15]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class CacheBase : LIS.DAL.ORM.DBUtility.IDbFactory
{
/// 数据库占位符
public string CreateDbParmCharacter()
{
return "?";
}
/// 数据库连接对象
public IDbConnection CreateDbConnection()
{
CacheConnection connCache = new CacheConnection(ConnectionString);
//测试连接，防止僵尸连接存在连接池中
//声明命令接口
IDbCommand cmd = new CacheCommand();
try
{
cmd.Connection = connCache;
cmd.CommandText = "select * from dbo.SYS_ConnectionTest";
cmd.CommandType = CommandType.Text;
connCache.Open();
cmd.ExecuteScalar();
}
catch
{
//执行简单的测试sql测试连接的可用性
//测试连接可用性，用一个最简单的sql，不可以从连接池移除，创建新的连接
CacheConnection.ClearPool(connCache);
connCache = new CacheConnection(ConnectionString);
}
finally
{
cmd.Dispose();
}
//声明连接接口
IDbConnection conn = connCache;
return conn;
}
/// 数据库命令对象
public IDbCommand CreateDbCommand()
{
//声明命令接口
IDbCommand cmd = new CacheCommand();
return cmd;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter()
{
//声明数据适配器接口
IDbDataAdapter adapter = new CacheDataAdapter();
return adapter;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter(IDbCommand cmd)
{
//声明数据适配器接口
IDbDataAdapter adapter = new CacheDataAdapter((CacheCommand)cmd);
return adapter;
}
/// 参数数组
public IDbDataParameter[] CreateDbParameters(int size)
{
int i = 0;
//声明数据库参数数组
IDbDataParameter[] param = null;
param = new CacheParameter[size];
while (i < size)
{
param[i] = new CacheParameter();
i++;
};
return param;
}
/// 事务对象
public IDbTransaction CreateDbTransaction()
{
//根据连接串创建事务对象
IDbConnection conn = CreateDbConnection();
//如果连接是关闭的，打开连接
if (conn.State == ConnectionState.Closed)
{
conn.Open();
}
//开始事务
return conn.BeginTransaction();
}
/// 处理后的表名称
public string DealTableName(string tableName)
{
return tableName;
}
/// 处理后的属性名称
public string DealPropertyName(string propertyName)
{
return propertyName;
}
/// 然而到了IRIS数据库后连各个对象名称都不同了，还得新写引用新dll的和新类名的适配类（泪奔了）
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using InterSystems.Data.IRISClient;
namespace LIS.DAL.Base
{
///
/// [创建者: zlz]
/// [创建时间: 2015-03-15]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class CacheBaseIRIS : LIS.DAL.ORM.DBUtility.IDbFactory
{
/// 数据库占位符
public string CreateDbParmCharacter()
{
return "?";
}
/// 数据库连接对象
public IDbConnection CreateDbConnection()
{
IRISConnection connCache = new IRISConnection(ConnectionString);
//测试连接，防止僵尸连接存在连接池中
//声明命令接口
IDbCommand cmd = new IRISCommand();
try
{
cmd.Connection = connCache;
cmd.CommandText = "select * from dbo.SYS_ConnectionTest";
cmd.CommandType = CommandType.Text;
connCache.Open();
cmd.ExecuteScalar();
}
catch
{
//执行简单的测试sql测试连接的可用性
//测试连接可用性，用一个最简单的sql，不可以从连接池移除，创建新的连接
IRISConnection.ClearPool(connCache);
connCache = new IRISConnection(ConnectionString);
}
finally
{
cmd.Dispose();
}
//声明连接接口
IDbConnection conn = connCache;
return conn;
}
/// 数据库命令对象
public IDbCommand CreateDbCommand()
{
//声明命令接口
IDbCommand cmd = new IRISCommand();
return cmd;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter()
{
//声明数据适配器接口
IDbDataAdapter adapter = new IRISDataAdapter();
return adapter;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter(IDbCommand cmd)
{
//声明数据适配器接口
IDbDataAdapter adapter = new IRISDataAdapter((IRISCommand)cmd);
return adapter;
}
/// 参数数组
public IDbDataParameter[] CreateDbParameters(int size)
{
int i = 0;
//声明数据库参数数组
IDbDataParameter[] param = null;
param = new IRISParameter[size];
while (i < size)
{
param[i] = new IRISParameter();
i++;
};
return param;
}
/// 事务对象
public IDbTransaction CreateDbTransaction()
{
//根据连接串创建事务对象
IDbConnection conn = CreateDbConnection();
//如果连接是关闭的，打开连接
if (conn.State == ConnectionState.Closed)
{
conn.Open();
}
//开始事务
return conn.BeginTransaction();
}
/// 处理后的表名称
public string DealTableName(string tableName)
{
return tableName;
}
/// 处理后的属性名称
public string DealPropertyName(string propertyName)
{
return propertyName;
}
/// 以上的种种都还不是要紧的，最要命的是这个Ado在没业务量的时候连小机和ECP没差异，在业务量上来之后连小机和ECP进行一个增删改查就是几毫米和上秒级的性能差异，果然还是对M支持最好，Ado机制不堪大用啊o(╥﹏╥)o。
困境探索
我们的程序已经在Ado的路上走得很远了，贸然换访问机制也不是一天两天的事。有什么方式可以不影响业务代码的情况切换访问机制。首先想到是否可以新包装ORM数据访问层，用调用M实现原来一样的接口？（但是ORM封装的功能也很多很深入，重新用M包装原来一样的接口效果工作量也很大，也很难包装的完全一致，所以不合实际）。后面想到从Ado.Net的接口层入手用M实现Ado几个类的接口，然后ORM调我们自己实现的Ado组件就可以确保ORM和上层的稳定性O(∩_∩)O哈哈~。有了思想就开干
首先包装M的执行SQL和存储过程M的方法。
/// w ##Class(LIS.WS.DHCLISService).GetSQLData("$StoredProcedure^LISSP.DHCRPVisitNumber_ReceiveVisitNumber","11$ZLPS$113 C ::1 @ " )
i (Xml'="")
{
d objStream.CopyFrom(Xml)
}
s Err=""
i IsProcedure=0 d
.i exeret'="1" d
..s Err=##Class(LIS.WS.BLL.DHCDataJSON).DealForXML(exeret)
..s exeret=-1
.//返回主键
.e d
..i $zcvt(SQLText,"U")["INSERT " d objStream.Write("" _rset.%RowID_"")
e d
.d objStream.Write("" " _exeret_"" _Err_"" _RowCount_"")
d objStream.Write("")
i IsProcedure=0 s ret=rset.Close()
q objStream
ErrorHandle
s err=$tr("执行SQL异常："_$tr($ZERROR,"^","--")_".错误代码:"_$ECODE,"<>")
s objStream=##Class(LIS.Util.Response).GetReturn("","-1",err)
Quit objStream
}
然后就是实现C#方法调用上面的M方法
/// json串
public static string GetCacheSQLDataXML(string SQLText, string Param, string session, out string errStr)
{
//如果传入的类名为空，直接抛出异常
if (SQLText == string.Empty)
{
throw new LIS.Core.BaseException.BusinessException(LIS.Core.Const.ExcepitionCode.paraNullEx, LIS.Core.Const.ExcepitionCode.paraNullExInfo);
}
string retStr = string.Empty;
errStr = string.Empty;
string retXml = "";
//得到地址
string webServicAddress = GetWebServicAddress();
//绕开信任
if (webServicAddress.Contains("https://"))
{
//类似浏览器确认证书合法方法的绑定
ServicePointManager.ServerCertificateValidationCallback = RemoteCertificateValidationCallback;
}
//有问号认为是2016
if (isCache2016)
{
LISService2016 curservice = Service;
retXml = curservice.GetSQLData(SQLText, Param, session);
pool.Put(curservice);
}
else
{
//创建WebService客户端代理
LISServiceSoapClient web = new LISServiceSoapClient("LISServiceSoap", webServicAddress);
//通过WebService查询数据
retXml = web.GetSQLData(SQLText, Param, session);
}
//返回结果
return retXml;
}
接着就是实现主体了（用M返回的信息实现Ado.Net的接口协议）
LISAdoConnection实现连接接口都是虚操作，实际不连接
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using System.Data.Common;
using LIS.DAL.ORM.DBUtility;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoConnection : IDbConnection, IPageData
{
/// LISAdoCommand实现命令接口用返回xml实现接口约定。逻辑集中在ExecuteNonQuery、ExecuteReader、ExecuteScalar
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data.Common;
using System.Data;
using System.Xml;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoCommand : IDbCommand
{
/// LISAdoDataReader实现DataReader读行数据效果及索引和字符串取结果部分
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using System.Xml;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoDataReader : IDataReader, IDisposable
{
/// LISAdoDataAdapter实现适配器类，主要实现往DataSet塞数据
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data.Common;
using System.Data;
using System.Xml;
using System.IO;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoDataAdapter : DbDataAdapter, IDbDataAdapter
{
/// LISAdoTransaction实现事务对象，虚操作，不管事务，使用都是简单的地方
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoTransaction : IDbTransaction
{
/// 其他对象LISAdoDataParameterCollection、LISAdoParameter、LISAdoUtil
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using System.Collections;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoDataParameterCollection : IDataParameterCollection, IEnumerator
{
/// using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Spring.Data.Common;
using System.Data;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class LISAdoParameter : System.Data.Common.DbParameter, IDbDataParameter
{
/// using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using System.Xml;
namespace WebserviceCacheClient
{
///
/// [创建者: 张联珠]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public static class LISAdoUtil
{
///
/// 创建节点
///
/// xml文档
/// 父节点
/// 节点名
/// 节点值
public static void CreateNode(XmlDocument xmlDoc, XmlNode parentNode, string name, string value)
{
//创建节点
XmlNode node = xmlDoc.CreateNode(XmlNodeType.Element, name, null);
//给节点赋值
node.InnerText = value;
//添加节点
parentNode.AppendChild(node);
}
}
}
以上就实现了居于M调用的Ado组件，再写一个ORM的基本类就可以做到切换Ado通道不影响上层。调用稳定的话也不用随着Caché的Ado组件波动来回折腾。
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Data;
using WebserviceCacheClient;
namespace LIS.DAL.Base
{
///
/// [创建者: zlz]
/// [创建时间: 2019-09-30]
/// <说明>
///
///
/// <修改记录>
/// <修改时间>
/// <修改内容>
///
///
///
///
public class CacheBaseLIS : LIS.DAL.ORM.DBUtility.IDbFactory
{
/// 数据库占位符
public string CreateDbParmCharacter()
{
return "?";
}
/// 数据库连接对象
public IDbConnection CreateDbConnection()
{
LISAdoConnection connCache = new LISAdoConnection(ConnectionString);
//声明连接接口
IDbConnection conn = connCache;
return conn;
}
/// 数据库命令对象
public IDbCommand CreateDbCommand()
{
//声明命令接口
IDbCommand cmd = new LISAdoCommand();
return cmd;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter()
{
//声明数据适配器接口
IDbDataAdapter adapter = new LISAdoDataAdapter();
return adapter;
}
/// 数据库适配器对象
public IDbDataAdapter CreateDataAdapter(IDbCommand cmd)
{
//声明数据适配器接口
IDbDataAdapter adapter = new LISAdoDataAdapter((LISAdoCommand)cmd);
return adapter;
}
/// 参数数组
public IDbDataParameter[] CreateDbParameters(int size)
{
int i = 0;
//声明数据库参数数组
IDbDataParameter[] param = null;
param = new LISAdoParameter[size];
while (i < size)
{
param[i] = new LISAdoParameter();
i++;
};
return param;
}
/// 事务对象
public IDbTransaction CreateDbTransaction()
{
//根据连接串创建事务对象
IDbConnection conn = CreateDbConnection();
//如果连接是关闭的，打开连接
if (conn.State == ConnectionState.Closed)
{
conn.Open();
}
//开始事务
return conn.BeginTransaction();
}
/// 处理后的表名称
public string DealTableName(string tableName)
{
return tableName;
}
/// 处理后的属性名称
public string DealPropertyName(string propertyName)
{
return propertyName;
}
/// 配置使用新访问层
本次分享经验在于面向接口编程，比如我们ORM完全面向Ado的接口实现功能，因而可以做到随数据库访问组件变化波动很小。开发的时候不关心实现细节，只关注别人的接口申明，就算是.Net的Ado一样可以直接实现接口达到一样的Ado效果。平时可以关注别人公布的接口，和自己写代码注意抽取接口公布出去（简化生活：坐公交不用关心司机怎么开到目的在的效果）达到工厂级零件组装效果。（希望有用O(∩_∩)O）