天涯一飘絮

导航

 

SqlCommandGenerator类的设计

SqlCommandGEnerator类的设计思路就是通过反射得到方法的参数,使用被SqlCommandParameterAttribute标记的参数来装配一个Command实例。

引用的命名空间:

//SqlCommandGenerator.csusing System;using System.Reflection;using System.Data;using System.Data.SqlClient;using Debug = System.Diagnostics.Debug;using StackTrace = System.Diagnostics.StackTrace;  类代码:
namespace DataAccess{   public sealed class SqlCommandGenerator   {      //私有构造器,不允许使用无参数的构造器构造一个实例      private SqlCommandGenerator()      {         throw new NotSupportedException();      }      //静态只读字段,定义用于返回值的参数名称      public static readonly string ReturnValueParameterName = "RETURN_VALUE";      //静态只读字段,用于不带参数的存储过程      public static readonly object[] NoValues = new object[] {};               public static SqlCommand GenerateCommand(SqlConnection connection,                                  MethodInfo method, object[] values)      {         //如果没有指定方法名称,从堆栈帧得到方法名称         if (method == null)             method = (MethodInfo) (new StackTrace().GetFrame(1).GetMethod());         // 获取方法传进来的SqlCommandMethodAttribute         // 为了使用该方法来生成一个Command对象,要求有这个Attribute。         SqlCommandMethodAttribute commandAttribute =             (SqlCommandMethodAttribute) Attribute.GetCustomAttribute(method, typeof(SqlCommandMethodAttribute));         Debug.Assert(commandAttribute != null);         Debug.Assert(commandAttribute.CommandType == CommandType.StoredProcedure ||       commandAttribute.CommandType == CommandType.Text);         // 创建一个SqlCommand对象,同时通过指定的attribute对它进行配置。         SqlCommand command = new SqlCommand();         command.Connection = connection;         command.CommandType = commandAttribute.CommandType;               // 获取command的文本,如果没有指定,那么使用方法的名称作为存储过程名称          if (commandAttribute.CommandText.Length == 0)         {            Debug.Assert(commandAttribute.CommandType == CommandType.StoredProcedure);            command.CommandText = method.Name;         }         else         {            command.CommandText = commandAttribute.CommandText;         }         // 调用GeneratorCommandParameters方法,生成command参数,同时添加一个返回值参数         GenerateCommandParameters(command, method, values);         command.Parameters.Add(ReturnValueParameterName, SqlDbType.Int).Direction                               =ParameterDirection.ReturnValue;         return command;      }      private static void GenerateCommandParameters(                           SqlCommand command, MethodInfo method, object[] values)      {         // 得到所有的参数,通过循环一一进行处理。                  ParameterInfo[] methodParameters = method.GetParameters();         int paramIndex = 0;         foreach (ParameterInfo paramInfo in methodParameters)         {            // 忽略掉参数被标记为[NonCommandParameter ]的参数                     if (Attribute.IsDefined(paramInfo, typeof(NonCommandParameterAttribute)))               continue;                        // 获取参数的SqlParameter attribute,如果没有指定,那么就创建一个并使用它的缺省设置。            SqlParameterAttribute paramAttribute = (SqlParameterAttribute) Attribute.GetCustomAttribute(     paramInfo, typeof(SqlParameterAttribute));         if (paramAttribute == null)         paramAttribute = new SqlParameterAttribute();            //使用attribute的设置来配置一个参数对象。使用那些已经定义的参数值。如果没有定义,那么就从方法       // 的参数来推断它的参数值。      SqlParameter sqlParameter = new SqlParameter();      if (paramAttribute.IsNameDefined)         sqlParameter.ParameterName = paramAttribute.Name;      else         sqlParameter.ParameterName = paramInfo.Name;            if (!sqlParameter.ParameterName.StartsWith("@"))               sqlParameter.ParameterName = "@" + sqlParameter.ParameterName;                     if (paramAttribute.IsTypeDefined)               sqlParameter.SqlDbType = paramAttribute.SqlDbType;                        if (paramAttribute.IsSizeDefined)               sqlParameter.Size = paramAttribute.Size;            if (paramAttribute.IsScaleDefined)               sqlParameter.Scale = paramAttribute.Scale;                        if (paramAttribute.IsPrecisionDefined)               sqlParameter.Precision = paramAttribute.Precision;                        if (paramAttribute.IsDirectionDefined)            {               sqlParameter.Direction = paramAttribute.Direction;            }            else            {               if (paramInfo.ParameterType.IsByRef)               {                  sqlParameter.Direction = paramInfo.IsOut ?                               ParameterDirection.Output :                               ParameterDirection.InputOutput;               }               else               {                  sqlParameter.Direction = ParameterDirection.Input;               }            }                     // 检测是否提供的足够的参数对象值     Debug.Assert(paramIndex < values.Length);                      //把相应的对象值赋于参数。           sqlParameter.Value = values[paramIndex];           command.Parameters.Add(sqlParameter);                                               paramIndex++;         }               //检测是否有多余的参数对象值         Debug.Assert(paramIndex == values.Length);      }   }}必要的工作终于完成了。SqlCommandGenerator中的代码都加上了注释,所以并不难读懂。下面我们进入最后的一步,那就是使用新的方法来实现上一节我们一开始显示个那个AddCustomer的方法。

重构新的AddCustomer代码:

[ SqlCommandMethod(CommandType.StoredProcedure) ]public void AddCustomer( [NonCommandParameter] SqlConnection connection,                    [SqlParameter(50)] string customerName,                    [SqlParameter(20)] string country,                    [SqlParameter(20)] string province,                    [SqlParameter(20)] string city,                    [SqlParameter(60)] string address,                    [SqlParameter(16)] string telephone,                   out int customerId ){   customerId=0; //需要初始化输出参数  //调用Command生成器生成SqlCommand实例   SqlCommand command = SqlCommandGenerator.GenerateCommand( connection, null, new object[]{customerName,country,province,city,address,telephone,customerId } );                            connection.Open();   command.ExecuteNonQuery();   connection.Close();   //必须明确返回输出参数的值   customerId=(int)command.Parameters["@CustomerId"].Value;}代码中必须注意的就是out参数,需要事先进行初始化,并在Command执行操作以后,把参数值传回给它。受益于Attribute,使我们摆脱了那种编写大量枯燥代码编程生涯。 我们甚至还可以使用Sql存储过程来编写生成整个方法的代码,如果那样做的话,可就大大节省了你的时间了,上一节和这一节中所示的代码,你可以把它们单独编译成一个组件,这样就可以在你的项目中不断的重用它们了。从下一节开始,我们将更深层次的介绍Attribute的应用,请继续关注。(待续)


 

posted on 2010-01-28 16:48  冰云  阅读(320)  评论(0编辑  收藏  举报