把Dapper 换成 SqlSugar ORM类的方法详解

为什么要写这篇文章

因数我看到很多人虽然用着SqlSugar，但是同时也用着Dapper，因为SqlSugar兼容了Dapper所有API，所以既然你用了SqlSugar那么就没有必要在同一个项目中使用2个ORM

所以这篇文章是给使用SqlSugar或者你想使用SqlSugar的朋友看的

Dapper 介绍

Dapper是一个轻量级开源的ORM类，他是通过扩展IDbConnection提供一些有用的扩展方法去查询您的数据库，所以Ado.Net支持的数据库，他都可以支持。

在速度方面具有“King of Micro ORM”的头衔，几乎与使用原始的ADO.NET数据读取器一样快。很多人第一次使用了他之后，就深深的喜欢上他了。

SqlSugar 介绍

SqlSugar 同样轻量级小巧，功能方面更加全面，需求都是来自1000多开发人员的真实项目需求，在这些需求上进行完美的设计，经过5年多的积累，

可以完美满足企业级的所有需求特别是查询功能，支持了各种类型的返回例如DataTable、List、字典等，还支持各种查询，

例如一次查询多个结果集，当然也支持存储过程

性能对比

在基础功能查询上性能双方是相当接近的，并且在不同CPU多台电脑上进行过大量测试，性能SqlSugar一点不占下风，甚至更好，

在SqlSugar源码中有对比代码，这边我就不多介绍了，性能永远是自个比才是真实的，别人比都是虚假的

移植教程

1、Sql加参数查询

Dapper 使用Sql加参数查询

/// <summary>
  /// 查询列表
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static List<T> Query(string sql, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    return con.Query<T>(sql, param).ToList();
   }
  }

SqlSugar 使用Sql加参数查询

/// <summary>
  /// 查询列表
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static List<T> Query(string sql, object param)
  {
   using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
   {
    return con.Ado.SqlQuery<T>(sql, param);
   }
  }

其中Object param支持3种类型

1、new {id=1} 匿名对象

2、SugarParameter

3、SugarParameter[] 或者List<SugarParameter>

2、根据Sql查询单条

Dapper根据Sql查询单条

/// <summary>
  /// 查询第一个数据
  /// </summary>
  /// <param name="sql"></param>
  /// <param name="param"></param>
  /// <returns></returns>
  public static T QueryFirst(string sql, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    return con.QueryFirst<T>(sql, param);
   }
  }

SqlSugar根据Sql查询单条

/// <summary>
  /// 查询列表
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static List<T> Query(string sql, object param)
  {
   using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
   {
    return con.Ado.SqlQuerySingle<T>(sql, param);
   }
  }

3、增、删、改

Dapper增、删、改

/// <summary>
  /// 增删改
  /// </summary>
  /// <param name="sql"></param>
  /// <param name="param"></param>
  /// <returns></returns>
  public static int Execute(string sql, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    return con.Execute(sql, param);
   }
  }

SqlSugar增、删、改

/// <summary>
  /// 增、删、改
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static int Query(string sql, object param)
  {
   using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
   {
    return con.Ado.ExecuteCommand(sql, param);
   }
  }

4、DataReader读取数据

Dapper DataReader读取数据

/// <summary>
  /// Reader获取数据
  /// </summary>
  /// <param name="sql"></param>
  /// <param name="param"></param>
  /// <returns></returns>
  public static IDataReader ExecuteReader(string sql, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    return con.ExecuteReader(sql, param);
   }
  }

SqlSugarDataReader读取数据

/// <summary>
  /// 获取DataReader
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static IDataReader Query(string sql, object param)
  {
   using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
   {
    return con.Ado.GetDataReader(sql, param);
   }
  }

5、获取首行首列

Dapper获取首行首列

/// <summary>
  /// Scalar获取数据
  /// </summary>
  /// <param name="sql"></param>
  /// <param name="param"></param>
  /// <returns></returns>
  public static object ExecuteScalar(string sql, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    return con.ExecuteScalar(sql, param);
   }
  }

SqlSugar获取首行首列

/// <summary>
  /// 获取首行首列
  /// </summary>
  /// <param name="sql">查询的sql</param>
  /// <param name="param">替换参数</param>
  /// <returns></returns>
  public static object ExecuteScalar(string sql, object param)
  {
   using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
   {
    return con.Ado.GetScalar(sql, param);
   }
  }

6、获取存储过程

Dapper获取存储过程

/// <summary>
  /// 带参数的存储过程
  /// </summary>
  /// <param name="sql"></param>
  /// <param name="param"></param>
  /// <returns></returns>
  public static List<T> ExecutePro(string proc, object param)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    List<T> list = con.Query<T>(proc,
     param,
     null,
     true,
     null,
     CommandType.StoredProcedure).ToList();
    return list;
   }
  }

SqlSugar获取存储过程

/// <summary>
   /// 获取存储过程
   /// </summary>
   /// <param name="sql">查询的sql</param>
   /// <param name="param">替换参数</param>
   /// <returns></returns>
   public static object ExecutePro<T>(string proc, object param) 8   {
    using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
    {
     return con.Ado.UseStoredProcedure().SqlQuery<T>(proc, param);12    }
  }

7、事务执行多个Sql

Dapper事务执行多个Sql

/// <summary>
  /// 事务1 - 全SQL
  /// </summary>
  /// <param name="sqlarr">多条SQL</param>
  /// <param name="param">param</param>
  /// <returns></returns>
  public static int ExecuteTransaction(string[] sqlarr)
  {
   using (SqlConnection con = new SqlConnection(connectionString))
   {
    using (var transaction = con.BeginTransaction())
    {
     try
     {
      int result = 0;
      foreach (var sql in sqlarr)
      {
       result += con.Execute(sql, null, transaction);
      }

      transaction.Commit();
      return result;
     }
     catch (Exception ex)
     {
      transaction.Rollback();
      return 0;
     }
    }
   }
  }

Sugar事务执行多个Sql

/// <summary>
  /// 事务1 - 全SQL
  /// </summary>
  /// <param name="sqlarr">多条SQL</param>
  /// <param name="param">param</param>
  /// <returns></returns>
  public static int ExecuteTransaction(string[] sqlarr)
  {
   using (SqlSugarClient con = new SqlSugarClient(connectionConfig))
   {
    con.Ado.BeginTran();
    using (var transaction = con.Ado.Transaction)
    {
     try
     {
      int result = 0;
      foreach (var sql in sqlarr)
      {
       result += con.Ado.ExecuteCommand(sql);
      }

      transaction.Commit();
      return result;
     }
     catch (Exception ex)
     {
      transaction.Rollback();
      return 0;
     }
    }
   }
  }

SqlSugar参数详解

SqlSugar同样支持游标、Output、 ReturnValue

var nameP=new SugarParameter("@name", "张三", typeof(string),ParameterDirection.ReturnValue);

移植成SqlSugar ORM有哪些优点

同样是写Sql但是SqlSugar提供了AOP、性能监控、返回多个结果集、SQL分页、一对多、一对一操作、JSON类型等

1、SqlSugar支持AOP等事件操作

db.Aop.OnLogExecuted = (sql, pars) => //SQL执行完
{
 Console.Write("time:" + db.Ado.SqlExecutionTime.ToString());//输出SQL执行时间
};
db.Aop.OnLogExecuting = (sql, pars) => //SQL执行前
{

};
db.Aop.OnError = (exp) =>//SQL报错
{
 //exp.sql 这样可以拿到错误SQL
};
db.Aop.OnExecutingChangeSql = (sql, pars) => //可以修改SQL和参数的值
{
 return new KeyValuePair<string, SugarParameter[]>(sql,pars);
};

除了这些事件外 SqlSugar还支持了性能监控，对于性能差的Sql或者存储过程都能很好的跟踪

SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
 {
    DbType = DbType.SqlServer,
    ConnectionString = Config.ConnectionString,
    InitKeyType = InitKeyType.Attribute,
    IsAutoCloseConnection = true

 });
 db.Aop.OnLogExecuted = (sql, p) =>
 {
   //执行时间超过1秒
  if (db.Ado.SqlExecutionTime.TotalSeconds > 1)
  {
   //代码CS文件名
   var fileName= db.Ado.SqlStackTrace.FirstFileName;
   //代码行数
   var fileLine = db.Ado.SqlStackTrace.FirstLine;
   //方法名
   var FirstMethodName = db.Ado.SqlStackTrace.FirstMethodName;
   //db.Ado.SqlStackTrace.MyStackTraceList[1].xxx 获取上层方法的信息
   }
 };

因为内容比较多一下子写不完 ,没关注的点一波关注

2、Json类型的查询

public class UnitJsonTest
{
 [SqlSugar.SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
 public int Id { get; set; }
 [IsJson = true)]//其中IsJson是必填
 public Order Order { get; set; }
 public string Name{get;set;}
}
var list = Db.Ado.SqlQuery<UnitJsonTest>().ToList();//数据库是一个json字符串

3、Sql分页

 var list= db.SqlQueryable<Student>("select * from student").Where("id=@id",new { id=1}).ToPageList(1, 2);

源码下载：https://github.com/sunkaixuan/SqlSugar

到此这篇关于把Dapper 换成 SqlSugar ORM类的方法详解的文章就介绍到这了,更多相关Dapper 换成 SqlSugar ORM内容请搜索自学编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持自学编程网！

编程技巧