C#教程之自己动手写映射第五节[封装添加]

一、动机

　　我们通常在做项目的时候一般用到的三层结构依赖关系如下：

　　实体作为数据的载体，传输于各个组件之间。当实体到达数据操作层时，我们会把他承载的具体数据解析出来，然后利用SqlHelper.cs[也存放在数据操作层的组件中]把数据插入到数据库中，具体代码如下：

/*
 *
 * 创建人：李林峰
 * 
 * 时  间：2012-08-01
 *
 * 描  述：员工类
 *
 */

using System;
using System.Data;

namespace CSharp.DAL
{
    public class A
    {
        public static void Add(Model.Employee employee)
        {
            string strSQL = string.Format(@"INSERT INTO [A]([Name],[Password],[Department],[Position]) VALUES('{0}' ,'{1}','{2}' ,'{3}')", employee.Name, employee.Password, employee.Department, employee.Position);
            SqlHelper.ExecuteNonQuery(Constant.CONNSTRING, CommandType.Text, strSQL);
        }
    }
    public class B
    {
        public static void Add(Model.Employee employee)
        {
            string strSQL = string.Format(@"INSERT INTO [B]([Name],[Password],[Department]) VALUES('{0}' ,'{1}','{2}' ,'{3}')", employee.Name, employee.Password, employee.Department,);
            SqlHelper.ExecuteNonQuery(Constant.CONNSTRING, CommandType.Text, strSQL);
        }
    }
    public class C
    {
        public static void Add(Model.Employee employee)
        {
            string strSQL = string.Format(@"INSERT INTO [C]([Name],[Password]) VALUES('{0}' ,'{1}','{2}')", employee.Name, employee.Password);
            SqlHelper.ExecuteNonQuery(Constant.CONNSTRING, CommandType.Text, strSQL);
        }
    }
}

 　　如上所示，我们在每个类里如果要实现“添加”操作，都会有一个方法，并且方法体内重复着写着INSERT INTO.....，为了减少我们的工作量，我们对上面的代码进行这样的理解：

 public static void Add("变化的实体")
 {
      string strSQL = string.Format(@"INSERT INTO "变化的列") VALUES("变化的值");
      SqlHelper.ExecuteNonQuery(Constant.CONNSTRING, CommandType.Text, strSQL);
  }

二、构想
　　既然重复的代码这么多，我们能不能把"添加"封装成一个方法呢？想像中的伪代码如下：

 public static bool Add(object "对象")
{
        //搞定添加......
        //返回结果......
}

三、实现
　　我们要实现对"添加"方法的封装以便能够重用，首先我们要改一下我们使用中各个组的依赖关系，把Add方法与SqlHelper类从DAL组件中分离出来放到新的组件中接口类型为object，彻底去除与"具体类型"的依赖关系。修改后的组件图如下：

　　各组件依赖关系依旧，只不过多加了个组件DBUtility。代码如下：

/*
 *
 * 创建人：李林峰
 * 
 * 时  间：2012-08-01
 * 
 * 描  述：员工数据操作层
 *
 */

using System;
using System.Data;
using CSharp.DBUtility;

namespace CSharp.DAL
{
    public class A
    {
        public static bool Add(Model.A a)
        {
            return ORM.Add(a);
        }
    }
    public class B
    {
        public static bool Add(Model.B b)
        {
            return ORM.Add(b);
        }
    }
    public class C
    {
        public static bool Add(Model.C c)
        {
            return ORM.Add(c);
        }
    }
}


/*
 *
 * 创建人：李林峰
 * 
 * 时  间：2012-08-01
 * 
 * 描  述：orm中封装后的添加方法
 *
 */

namespace CSharp.DBUtility
{
    public class ORM
    {
        public static bool Add(object Model)
        {
            //搞定添加......
            return true;
        }
    }
}

　　如上所示，要实现我们的思想，所有的添加操作都必须在"搞定添加......"中实现。

　　引入实体与数据库的映射关系的概念：在Add方法中我们传入的是"带有数据的具体类型的对象"，而我们要实现的add(object)这个实体的数据就应该存储到数据库中了，是具体的数据库插入操作，也就是说我们得到了数据，但不知道往哪个表里插入数据和这些数据应该插入到哪些字段中。这时候我们可以有一种新的想法"新建立一个依赖"对我们需要的信息进行描述以辅助我们完成该功能，如下所图所示：

　　我们再回头看看插入时的SQL语句：

INSERT INTO tableName (Column1,Column2....) VALUES (value1,value2....)

　　通过引入实体与数据库的映射关系，我们得到了得到了插入时拼接SQL的所有信息，(1)tableName 存在于Mapping中。(2)Column存在于Mapping中。(3)value存在于传入的object对象的属性中。(4)具体哪个实体属性的值应该插入到哪个字段存在于Mapping中，如：Password属性值应该存入varPassword字段中。

　　注入映射关系：即然我们的底层DBUtility要应用到这种关系，那么我们必然要把这种关系动态的注入到我们的组件中，这里我提出两种思路：

1. 我们可以修改Add的对外接口为Add(object model,object mapping)，[此时mapping可以是类文件，但不限于类文件，大多数情况下是xml文件，也可以是是文本文件，只要我们能够得到这种关系就可以]。
2. 可以依赖一定的文件命名规则，如：实体类的名称为Employee，存储着么的映射类的名称就必须为EmployeeMapping，在实现的内部我们用反射来得到EmployeeMapping类的实例，并调用其属性或方法得到关系。这样我们就不用像上面一样每次都加上mapping这个参数了。

　　万事俱备只吹东风：前面墨迹了那么多，也不知道能让别人看明白不，反正我是明白了，哈哈，现在写写实现吧，有代码有真相。

　　项目结构如上所示：在DAL里有4个类，Constant是获取Web.config的类，Employee与SqlHelper是我们最初写三层的写法示例，EmployeeORM是我们封装了底层后的新写法，DBUtility是我们新建立的组件，组件的对外接口为ORM类，其他类为辅助类。由于代比较多，这里只贴出DAL中的EmployeeORM类代码与ORM类的代码，其他的实现请自己下载调试吧。

/*
 *
 * 创建人：李林峰
 * 
 * 时  间：2012-08-01
 * 
 * 描  述：员工数据操作层
 *
 */

using System;
using System.Data;
using CSharp.DBUtility;

namespace CSharp.DAL
{
    public class EmployeeORM
    {
        public static bool Add(Model.Employee employee)
        {
            return ORM.Add(employee, Constant.ASSEMBLYPATH, Constant.CONNSTRING);
        }
    }
}



/*
 *
 * 创建人：李林峰
 * 
 * 时  间：2010-08-01
 *
 * 描  述：对象关系映射类
 *
 */

using System;
using System.Collections.Generic;
using System.Reflection;

namespace CSharp.DBUtility
{
    public class ORM
    {
        /// <summary>
        /// 添加一个实体
        /// </summary>
        /// <param name="classObject"></param>
        /// <returns></returns>
        public static bool Add(object classObject, string AssemblyName, string ConnString)
        {
            int intMaxID = 0, intFlag = 0;
            return Add(classObject, out intMaxID, intFlag, AssemblyName, ConnString);
        }

        /// <summary>
        /// 添加一个实体并且返回其ID标识
        /// </summary>
        /// <param name="classObject"></param>
        /// <param name="intMaxID"></param>
        /// <returns></returns>
        public static bool Add(object classObject, out int intMaxID, string AssemblyName, string ConnString)
        {
            intMaxID = 0;
            int intFlag = 1;
            return Add(classObject, out intMaxID, intFlag, AssemblyName, ConnString);
        }

        /// <summary>
        /// 添加实体并判断是否返回最大的编号
        /// </summary>
        /// <param name="classObject"></param>
        /// <param name="intMaxID"></param>
        /// <param name="intFlag">当intFlag=0时，则不去取intMaxID，等于1则相反</param>
        /// <returns></returns>
        private static bool Add(object classObject, out int intMaxID, int intFlag, string AssemblyName, string ConnString)
        {
            //声名输出参数
            intMaxID = 0;

            //获取表名称
            string strTableName = Mapping.GetTableName(classObject, AssemblyName);
            //获取主键字典
            Dictionary<string, string> IdentityMapping = Mapping.GetIdentityMapping(classObject, AssemblyName);
            //获取除主键以外的字段字典
            Dictionary<string, string> BaseFieldMapping = Mapping.GetBaseFieldMapping(classObject, AssemblyName);
            //获取 "属性--值" 字典
            Dictionary<string, string> FieldValueMapping = Model.GetValueMapping(classObject, BaseFieldMapping);

            //创建SQL语句
            string strSQL = SQL.CreateInsert(classObject, strTableName, IdentityMapping, BaseFieldMapping, FieldValueMapping, intFlag);

            //执行SQL
            return SQL.ExecInsert(strSQL, out intMaxID, intFlag, ConnString);
        }
    }
}

四、总结

　　这节内容引入了对象与数据库的映射的思想，这个思想在很多框架中都有应用，我们在平时开发过程中，不光要懂得怎么调用API实现功能，同时了解开发者的意图也是非常必要的，当你理解后你会发现，我们在"思想上还是很有潜力滴"。

五、源码下载
　　06CSharp映射教程_05.rar

六、版权

　　转载请注明出处：http://www.cnblogs.com/iamlilinfeng

七、工作类了，乐喝乐喝

　　今天8月1号，上午一同事果断发图，老着笑了。。。