.NET对存储过程的调用抽象封装
最近一边参与公司的项目开发，一边还肩负着基础库的创建和维护。真真切切的体会到写框架的不容易，写出好的，方便使用的框架更不容易，需要考虑的东西太多，需要掌握的东西太多。不过不要紧我们正在前进的道路上。同志们一起加油！
最近在使用存储过程的时候总觉得有点麻烦，尽管在前期对ORM和统一数据源接口封装已经下了很多功夫，对IDataParameter之类的接口已经进行了很好的封装，但是还是觉得麻烦。 [王清培版权所有，转载请给出署名]
经过与DBA的沟通，他认为对存储过程的封装是有必要的，以他十几年的经验看，存储过程后期的移植是必不可少的。现在的项目是用SQLSERVER2008开发的，后期可能会移植到ORACLE上去，那么对存储过程的编写DBA考虑很周全。但是对于程序员来说，经验稍微丰富点的可能会通过某种工厂将具体对象脱耦，或者使用依赖倒置的原则来解决更换数据源问题。但是考虑到统一的使用方法，这里还是真的有必要进行封装的。那么如何封装？
代码生成器的重要性
这里为什么要牵扯到代码生成器呢？从我刚开始准备编写基础库的时候我就意识到代码生成器的重要性，当时的想法就是能为了完全的控制代码生成器。如果使用第三方的代码生成器可能在初期是可以满足要求，但是如果想把它做成成熟的开发平台是行不通的。借助代码生成器的功能，基础库的使用将变的更加流畅(后面将看到效果)。很明显的就是ORM和一些IDE中内置的代码生成，结合的很完美，让人痴迷。 [王清培版权所有，转载请给出署名]
我们假设没有代码生成器，那些诸如通用的代码将需要我们程序员手动的敲，那个工作即枯燥也容易出错。所以需要代码生成器去帮我们生成我们想要的，符合某种规则的重复性的代码。比较典型的就是我们三层架构中必不可少的Model集合(有个概念要纠正一下，常常有程序员将Model对象集读成Model层，它并非层中的“层”，而是层中传递数据的结构)。
有了自己公司的代码生成器之后，就可以按照公司的开发框架去不断的增强功能，使其逐渐变成开发平台，成熟了之后可能就是一套符合行业要求的快速开发框架。这也是个慢慢积累的过程，急不来。
存储过程的使用分析
我假设我们已经对IDataParameter对象进行了封装，我想对它简单的封装基本也都能满足日常要求了。一般都是根据当前项目链接数据库的类型字符串进行判断，然后生成相对应如：SqlParameter、OracleParameter、 OleDbParameter 等等，可能还包括一些开源的数据库扩展框架中的对象，这里的创建工厂可能是抽象工厂，当然方法很多种，实现效果就行。 [王清培版权所有，转载请给出署名]
对其简单的封装我们在使用的时候需要使用工厂方法创建IDataParameter数组，如：
Dictionary< string , object > parameter = new Dictionary< string , object >();
parameter.Add( "PurchaseID" , Purchase.TempSerialNo); //单据流水号
parameter.Add( "WarehouseId" , Purchase.InWarehouseID); //仓库ID
parameter.Add( "UserID" , Purchase.UserID); //操作ID
parameter.Add( "UserName" , Purchase.UserName); //操作人名称
parameter.Add( "PurchaseDate" , DBNull.Value); //采购日期
parameter.Add( "BuyUserID" , DBNull.Value); //采购人编号
parameter.Add( "BuyUserName" , DBNull.Value); //采购人名称
parameter.Add( "BuyDate" , DBNull.Value); //采购日期
parameter.Add( "Memo" , Purchase.Memo); //备注说明
IDataParameter[] parameterDic = IDataParameterFactory.CreateDbDataParameter(parameter);
List<IDataParameter> listparameter = IDataParameterHelper.IDataParameterArrayToList(parameterDic);
listparameter.Add(WL.DAL.DAL_TB_WLPurchase.GetErrIDParametere());
using (Fast.Orm.IDataSourceOperation operation = Fast.Orm.IDataSourceOperationFactory.Create())
{
operation.ExecuteNonQuery(CommandType.StoredProcedure, "prc_WLPurchaseTmpAdd" , listparameter.ToArray());
if (listparameter[listparameter.Count - 1].Value.ToString() == "0" )
return true ;
return false ;
}
一般性的封装基本都这样或者在 IDataParameterFactory.CreateDbDataParameter(Entity)中加入根据实体的属性动态的创建IDataParameter[]对象，如果你的创建始终是使用反射的话那么将是不可取的。有兴趣的朋友可以参见本人的另一篇文章“ 利用抽象、多态实现无反射的绿色环保 ORM 框架 ”对实体的使用如果不能摆脱反射，那么在以后的基础库扩展中将面临着很多性能问题，这里需三思。
由于很少存储过程的参数名称都是对应的实体的属性名称，这种对应关系很难做到，或者说是做到的话需要 DBA花点时间呢，在命名上也是个约束。
如果存储过程有 N个参数的话我们需要对照数据库设计文档来编写IDictionary项，在一般的项目中都将复杂的业务逻辑封装在存储过程中实现，所以存储过程的数量也是不少的。这样一来也算是一个比较浪费时间的工作。
那么如果减少编码量，让存储过程的调用变的简单，而且对用户来说是透明的？
抽象存储过程的参数使其变成参数实体抽象
由于在设计绿色ORM的过程中总结了很多好的想法，也确实能感觉到对简单实体的抽象能使后期的扩展变的更加自如。比如，不需要那么费力的使用反射获取属性元数据，直接使用字典集合就能得到属性的名称和值。那么我也使用类似的设计思路来设计了参数实体对象。
首先需要抽象的基类，用来保存对存储过程的一个简单的对应关系，请看代码：
/// <summary>
/// 存储过程实体（参数信息类）基类
/// </summary>
public abstract class BaseStoredprocedureObject : DictionaryBase
{
/// <summary>
/// 受保护的字段-存储过程名称
/// </summary>
protected string procedurename = string .Empty;
/// <summary>
/// 受保护的字段-命令参数集合
/// </summary>
protected List<IDataParameter> parameterlist = new List<IDataParameter>();
/// <summary>
/// 获取命令参数集合
/// </summary>
public List<IDataParameter> ParameterList
{
get { return parameterlist; }
}
/// <summary>
/// 添加IDataParameter对象到基类parameterlist对象
/// </summary>
public abstract void AddParameterToBaseParameterObject();
/// <summary>
/// 获取存储过程名称
/// </summary>
public string ProcedureName
{
get { return procedurename; }
}
/// <summary>
/// 获取对应参数名称的值
/// </summary>
/// <param name="keyname">参数名称</param>
/// <returns>object：参数值</returns>
public object this [ string keyname]
{
get { return this .Dictionary[keyname]; }
internal set { this .Dictionary[keyname] = value; }
}
/// <summary>
/// 获取所有参数信息
/// </summary>
public IDictionary GetProcedureEntity
{
get { return this .Dictionary; }
}
/// <summary>
/// 存储过程返回的数据集
/// </summary>
public DataTable Source
{
get ;
internal set ;
}
}
具体的属性都有注释，我就不解释了。可能这个对象在初期也是比较简单的，随着使用范围的变大或者使用复杂，那么这个类还需要其他的东西。
这是抽象的对象，那么在具体的子类当中是如何的呢？还是看代码比较直观；
using System;
using System.Collections.Generic;
using System.Text;
using System.Data;
using Fast.Orm;
namespace Fast.WL.Parmeter
{
[Serializable()]
public class Init_prc_WLOrderTmpAdd : BaseStoredprocedureObject
{
public Init_prc_WLOrderTmpAdd()
{
this .procedurename = "prc_WLOrderTmpAdd" ;
this .Dictionary.Add( "OrderID" , null );
this .Dictionary.Add( "StationID" , null );
this .Dictionary.Add( "UserID" , null );
this .Dictionary.Add( "UserName" , null );
this .Dictionary.Add( "OrderDate" , null );
this .Dictionary.Add( "DeliveryAddress" , null );
this .Dictionary.Add( "OrderType" , null );
this .Dictionary.Add( "APNumber" , null );
this .Dictionary.Add( "Memo" , null );
this .Dictionary.Add( "ErrID" , DBNull.Value);
}
public override void AddParameterToBaseParameterObject()
{
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"OrderID" , base .Dictionary[ "OrderID" ],
ParameterDirection.Input, DbType.String, 14));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"StationID" , base .Dictionary[ "StationID" ],
ParameterDirection.Input, DbType.String, 36));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"UserID" , base .Dictionary[ "UserID" ],
ParameterDirection.Input, DbType.String, 36));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"UserName" , base .Dictionary[ "UserName" ],
ParameterDirection.Input, DbType.String, 10));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"OrderDate" , base .Dictionary[ "OrderDate" ],
ParameterDirection.Input, DbType.DateTime, 8));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"DeliveryAddress" , base .Dictionary[ "DeliveryAddress" ],
ParameterDirection.Input, DbType.String, 50));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"OrderType" , base .Dictionary[ "OrderType" ],
ParameterDirection.Input, DbType.Int16, 2));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"APNumber" , base .Dictionary[ "APNumber" ],
ParameterDirection.Input, DbType.String, 20));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"Memo" , base .Dictionary[ "Memo" ],
ParameterDirection.Input, DbType.String, 220));
base .parameterlist.Add(IDataParameterFactory.CreateDbDataParameter(
"ErrID" , base .Dictionary[ "ErrID" ],
ParameterDirection.Output, DbType.Int32, 4));
}
}
public class prc_WLOrderTmpAdd : Init_prc_WLOrderTmpAdd
{
public object OrderID
{
get { return this .Dictionary[ "OrderID" ] as object ; }
set { this .Dictionary[ "OrderID" ] = value; }
}
public object StationID
{
get { return this .Dictionary[ "StationID" ] as object ; }
set { this .Dictionary[ "StationID" ] = value; }
}
public object UserID
{
get { return this .Dictionary[ "UserID" ] as object ; }
set { this .Dictionary[ "UserID" ] = value; }
}
public object UserName
{
get { return this .Dictionary[ "UserName" ] as object ; }
set { this .Dictionary[ "UserName" ] = value; }
}
public object OrderDate
{
get { return this .Dictionary[ "OrderDate" ] as object ; }
set { this .Dictionary[ "OrderDate" ] = value; }
}
public object DeliveryAddress
{
get { return this .Dictionary[ "DeliveryAddress" ] as object ; }
set { this .Dictionary[ "DeliveryAddress" ] = value; }
}
public object OrderType
{
get { return this .Dictionary[ "OrderType" ] as object ; }
set { this .Dictionary[ "OrderType" ] = value; }
}
public object APNumber
{
get { return this .Dictionary[ "APNumber" ] as object ; }
set { this .Dictionary[ "APNumber" ] = value; }
}
public object Memo
{
get { return this .Dictionary[ "Memo" ] as object ; }
set { this .Dictionary[ "Memo" ] = value; }
}
public object ErrID
{
get { return this .Dictionary[ "ErrID" ] as object ; }
set { this .Dictionary[ "ErrID" ] = value; }
}
}
}
在Init_prc_WLOrderTmpAdd构造函数中我们设置所有的参数名称和默认的值，这里可以会是 DbNull.Value。 [王清培版权所有，转载请给出署名]
在 AddParameterToBaseParameterObject重写方法中我们用来创建所有的IDataParameter对象的具体实例，由于不同的参数名称，不同的数据类型，不同的输入输出。所以我们需要这么一个创建IDataParameter对象的工厂方法，这个方法应该在前期就已经存在了，这里我假设它已经被创建了。
那么在使用的时候我们不需要关心太多的细节，只需要对将该对象当作执行存储过程的参数对象即可。
prc_WLOrderTmpAdd ordertmp = new prc_WLOrderTmpAdd();
ordertmp.OrderID = order.OrderID; //订单流水号
ordertmp.StationID = order.StationID; //站点ID
ordertmp.UserID = order.UserID;
ordertmp.UserName = order.UserName;
ordertmp.OrderDate = DBNull.Value;
ordertmp.DeliveryAddress = order.DeliveryAddress;
ordertmp.OrderType = order.OrderType;
ordertmp.APNumber = string .IsNullOrEmpty(order.APNumber) ? DBNull.Value : ( object )order.APNumber;
ordertmp.Memo = DBNull.Value; //备注
Fast.Orm.ProcedureHelper.ProcedureOperation<prc_WLOrderTmpAdd>(ordertmp);
return int .Parse(ordertmp.ErrID.ToString()) == 0 ? true : false ;
这样保证我们写的代码都围绕着数据实体来进行数据库的操作。
只需要封装一个简单的执行存储过程的方法就行了。
Fast.Orm.ProcedureHelper.ProcedureOperation<prc_WLOrderTmpAdd>(ordertmp);
这里我就不贴出代码了。
使用上是变的简单了，那么数据实体怎么来呢？这里就是我文章开头小结讲到的，代码生成器对基础框架的重要性。 [王清培版权所有，转载请给出署名]
有了专业的代码生成器之后，一切就变的简单多了，我们按照自己的要求设计开发代码生成器来配合基础框架的使用，那么我们的开发效率将大大提高了。
总结：这里只是本人在封装存储过程的使用时的一些小小的经验，与大家分享一下，也算是一个抛砖引玉吧，可能大面积的使用会存在点未知的问题，不过框架就是这样才变的稳定的，希望对大家有点用，谢谢。
分类: C# , 基本应用 , 企业架构、设计模式 , 系统架构设计 , 应用框架设计 , 组件、中间件开发
作者： Leo_wl
出处： http://www.cnblogs.com/Leo_wl/
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。
版权信息查看更多关于.NET对存储过程的调用抽象封装的详细内容...