基于轻量级ORM框架Dapper的扩展说明

这里简单的介绍一下本人基于Dapper作的一些简单的扩展，供大家参考。

为何要使用这款框架，相信大家看到下面排名就清楚了

其实在各大网站上，我们大概都会看到这样的一个对比效果图，在超过500次poco serialization的过程中所表现的性能，我们发现dapper是第二名，

当然第一名谁也无法超越，越底层的当然久越快，同时也就越麻烦。

至于如何使用进行基本的数据操作，我这里就不再阐述，http://www.cnblogs.com/Sinte-Beuve/p/4231053.html这里介绍了Dapper的基本使用的方法。

一.文件说明，打包的文件如下

SqlMapperExtensions类：ORM扩展类，基于SQLMapper类的扩展。
SqlMapper类--Dapper原始类：一些底层封装代码，使用时可查看其实现原理。
生成实体类_Dapper_模板文件：用于动态生成实体类的模板，配合DOS生成工具使用。

二.扩展类新增的几个方法

SqlMapperExtensions类中新增： UpdateGiven()、InsertGiven()、GetPageList()方法。

UpdateGiven()：更新时只更新赋值的字段

InsertGiven()：插入时只插入赋值的字段

GetPageList()：新增分页查询

另新增数据库环境支持Oracle

三.举栗子

这里用上面的方法来简单的测试一下。

 using System;
 using System.Collections.Generic;
 using System.Data;
 using System.Data.SqlClient;
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
 using Dapper;
 using System.Data.OracleClient;
 using Dapper.Contrib.Extensions;
 using Dapper.Contrib;
 using Dapper.Model;
 namespace ConsoleTest1
 {
     class Program
     {
         static IDbConnection conn = new OracleConnection("Data Source=(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=*.*.*.*)(PORT=1521)))(CONNECT_DATA=(service_name =*)));Persist Security Info=True;User ID=*; Password=*;");
         static void Main(string[] args)
         {
             //创建Book表
             conn.Execute(@" create table Book (Id number, Name nvarchar2(100) not null),Remark nvarchar2(200)");
             Console.WriteLine("Created database");
             BOOK book = new BOOK();
             book.NAME = "C#本质论";
             book.ID = ;
             string query = "INSERT INTO Book(Id,Name)VALUES(@Id,@Name)";
             //对对象进行操作
             conn.Execute(query, book);//原始操作 传入sql语句和参数

             ////以下是扩展中的方式
             //直接用Insert虽然只给了部分字段，但会插入所有字段，造成数据库的默认值会被覆盖的情况
             conn.Insert<BOOK>(new BOOK { ID = , NAME = "Dapper" });
             conn.InsertGiven<BOOK>(new BOOK { ID = , NAME = "Dapper" });
             //每次执行Update方法也是会更新所有字段，没赋值的字段会覆盖掉原始数据库的值
             conn.Update<BOOK>(new BOOK { ID = , NAME = "Dapper" });
             conn.UpdateGiven<BOOK>(new BOOK { ID = , NAME = "update Dos way" });
             ////以下是分页查询，有一个重载
             long longCount;
             var sortlist=new List<ISort>();
             sortlist.Add(new Sort{ PropertyName="id",Ascending=true});
             //该方法要传入一个长整型变量供传递出查询的总量
             var pagebook = conn.GetPageList<BOOK>(, , out longCount, new BOOK { ID=}, sortlist);
             //该重载不需要传入长整型变量
             var pagebook2 = conn.GetPageList<BOOK>(, , null, sortlist);

         }
     }

 }

其中具体方式的实现分别如下：

         /// <summary>
         /// Inserts an entity into table "Ts" and returns identity id.(Insert the given fields)
         /// </summary>
         /// <param name="connection">Open SqlConnection</param>
         /// <param name="entityToInsert">Entity to insert</param>
         /// <returns>Identity of inserted entity</returns>
         public static long InsertGiven<T>(this IDbConnection connection, T entityToInsert, IDbTransaction transaction = null, int? commandTimeout = null) where T : Entity
         {
             var type = typeof(T);
             var name = GetTableName(type);
             var mfields = entityToInsert.GetModifyFields();
             if (null == mfields || mfields.Count == )
                 return -;
             var sbColumnList = new StringBuilder(null);
             SetSqlConnectTag(connection);//根据不同数据库设置标记符 SqlServer@ Oracle:
             var keyProperties = KeyPropertiesCache(type);
             for (var i = ; i < mfields.Count; i++)
             {
                 sbColumnList.AppendFormat("{0}", mfields[i].Field);
                 if (i < mfields.Count - )
                     sbColumnList.Append(", ");
             }
             var sbParameterList = new StringBuilder(null);
             for (var i = ; i < mfields.Count; i++)
             {
                 sbParameterList.AppendFormat("{0}{1}", SqlConnectTag, mfields[i].Field);
                 if (i < mfields.Count - )
                     sbParameterList.Append(", ");
             }
             var adapter = GetFormatter(connection);
             return adapter.Insert(connection, transaction, commandTimeout, name, sbColumnList.ToString(),
                 sbParameterList.ToString(), keyProperties, entityToInsert);
         }

InsertGiven

         /// <summary>
         /// Updates entity in table "Ts", checks if the entity is modified if the entity is tracked by the Get() extension.
         /// update the given fileds
         /// </summary>
         /// <typeparam name="T">Type to be updated</typeparam>
         /// <param name="connection">Open SqlConnection</param>
         /// <param name="entityToUpdate">Entity to be updated</param>
         /// <returns>true if updated, false if not found or not modified (tracked entities)</returns>
         public static bool UpdateGiven<T>(this IDbConnection connection, T entityToUpdate, IDbTransaction transaction = null, int? commandTimeout = null) where T : Entity
         {
             var proxy = entityToUpdate as IProxy;
             if (proxy != null)
             {
                 if (!proxy.IsDirty) return false;
             }

             var type = typeof(T);

             var keyProperties = KeyPropertiesCache(type);
             if (!keyProperties.Any())
                 throw new ArgumentException("Entity must have at least one [Key] property");

             var name = GetTableName(type);

             var mfields = entityToUpdate.GetModifyFields();
             if (null == mfields || mfields.Count == )
                 return false;
             for (var i = ; i < keyProperties.Count(); i++)
             {//排除主键
                 var property = keyProperties.ElementAt(i);
                 if (mfields.Select(t => t.Field).Contains(property.Name))
                     mfields.Remove(mfields.FirstOrDefault(t=>t.Field==property.Name));
             }
             var sb = new StringBuilder();
             sb.AppendFormat("update {0} set ", name);
             SetSqlConnectTag(connection);//根据不同数据库设置标记符 SqlServer@ Oracle:
             for (var i = ; i < mfields.Count; i++)
             {
                 sb.AppendFormat("{0} = {2}{1}", mfields[i].Field, mfields[i].Field, SqlConnectTag);
                 if (i < mfields.Count - )
                     sb.AppendFormat(", ");
             }
             sb.Append(" where ");
             for (var i = ; i < keyProperties.Count(); i++)
             {
                 var property = keyProperties.ElementAt(i);
                 sb.AppendFormat("{0} = {2}{1}", property.Name, property.Name, SqlConnectTag);
                 if (i < keyProperties.Count() - )
                     sb.AppendFormat(" and ");
             }
             var updated = connection.Execute(sb.ToString(), entityToUpdate, commandTimeout: commandTimeout, transaction: transaction);
             return updated > ;
         }

UpdateGiven

  /// <summary>
         /// Paging
         /// </summary>
         /// <typeparam name="T">传入实体类型</typeparam>
         /// <param name="connection">此连接</param>
         /// <param name="pageIndex">第几页:0为第一页开始</param>
         /// <param name="pageSize">每页数量</param>
         /// <param name="allRowsCount">返回满足条件总量</param>
         /// <param name="entityToPredicate">条件:实体传入</param>
         /// <param name="sort">排序条件：ISort列表方式传入</param>
         /// <param name="buffered">是否缓存</param>
         /// <returns></returns>
         public static IEnumerable<T> GetPageList<T>(this IDbConnection connection, int pageIndex, int pageSize, out long allRowsCount,
         T entityToPredicate = null, IList<ISort> sort = null, bool buffered = true) where T : Entity
         {
             DynamicParameters dynamicParameters = new DynamicParameters();
             var type = typeof(T);
             SetSqlConnectTag(connection);//根据不同数据库设置标记符 SqlServer@ Oracle:
             var keys = KeyPropertiesCache(type);
             if (keys.Count() > )
                 throw new DataException("Get<T> only supports an entity with a single [Key] property");
             if (!keys.Any())
                 throw new DataException("Get<T> only supports en entity with a [Key] property");

             var onlyKey = keys.First();
             StringBuilder innersql = new StringBuilder(string.Format("SELECT * FROM {0}",
                 GetTableName(type)));
             if (entityToPredicate != null)
             {
                 var mfields = entityToPredicate.GetModifyFields();
                 innersql.Append(" where ");
                 for (var i = ; i < mfields.Count; i++)
                 {
                     innersql.AppendFormat("{0} = {2}{1}", mfields[i].Field, mfields[i].Field, SqlConnectTag);
                     if (i < mfields.Count - )
                         innersql.AppendFormat(", ");
                     dynamicParameters.Add(mfields[i].Field, mfields[i].NewValue);
                 }
             }
             if (sort != null && sort.Any())
             {
                 innersql.Append(" ORDER BY ")
                     .Append(sort.Select(s => s.PropertyName + (s.Ascending ? " ASC" : " DESC")).AppendStrings());
             }
             allRowsCount = connection.Query(innersql.ToString(), entityToPredicate).Count();
             Dictionary<string, object> parameters = new Dictionary<string, object>();
             string sql = GetFormatter(connection).GetPagingSql(innersql.ToString(), pageIndex, pageSize, parameters);
             foreach (var parameter in parameters)
             {
                 dynamicParameters.Add(parameter.Key, parameter.Value);
             }
             return connection.Query<T>(sql, dynamicParameters);
         }

下面我们来调试一下来看看Insert和InsertGiven、Update和UpdateGiven的区别吧

 　////以下是扩展中的方式
   //直接用Insert虽然只给了部分字段，但会插入所有字段，造成数据库的默认值会被覆盖的情况
   conn.Insert<BOOK>(new BOOK { ID = , NAME = "Dapper" });
   conn.InsertGiven<BOOK>(new BOOK { ID = , NAME = "Dapper" });
   //每次执行Update方法也是会更新所有字段，没赋值的字段会覆盖掉原始数据库的值
   conn.Update<BOOK>(new BOOK { ID = , NAME = "Dapper" });
   conn.UpdateGiven<BOOK>(new BOOK { ID = , NAME = "update Dos way" });

Insert生成的sql语句：

InsertGiven生成的sql语句：

Update生成的sql语句:

UpdateGiven生成的sql语句：

想必扩展的方法个中缘由就一清二楚了。

四.实体类生成

其中BOOK实体类如何生成?这里借鉴了DOS生成实体类工具，并新增了一个模板文件->生成实体类_Dapper_模板文件.tpl

打开DOSTOOL的Debug文件，将其放入模板文件中，重新打开DOSTOOL文件便可看见新增了一个模板，选择其模板，生成代码即可。

以上。