如何將 Dapper 換成 SqlSugar ORM

果糖大資料科技發表於2020-12-14
APPSqlSugarORM

為什麼要寫這篇文章

因數我看到很多人雖然用著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加引數查詢

 1         /// <summary>
 2         /// 查詢列表
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static List<T> Query(string sql, object param)
 8         {
 9             using (SqlConnection con = new SqlConnection(connectionString))
10             {
11                 return con.Query<T>(sql, param).ToList();
12             }
13         }

SqlSugar 使用Sql加引數查詢

 1         /// <summary>
 2         /// 查詢列表
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static List<T> Query(string sql, object param)
 8         {
 9             using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
10             {
11                 return con.Ado.SqlQuery<T>(sql, param);
12             }
13         }

其中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查詢單條

 1         /// <summary>
 2         /// 查詢列表
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static List<T> Query(string sql, object param)
 8         {
 9             using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
10             {
11                 return con.Ado.SqlQuerySingle<T>(sql, param);
12             }
13         }

 

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讀取資料

 1     /// <summary>
 2         /// Reader獲取資料
 3         /// </summary>
 4         /// <param name="sql"></param>
 5         /// <param name="param"></param>
 6         /// <returns></returns>
 7         public static IDataReader ExecuteReader(string sql, object param)
 8         {
 9             using (SqlConnection con = new SqlConnection(connectionString))
10             {
11                 return con.ExecuteReader(sql, param);
12             }
13         }

SqlSugar  DataReader讀取資料

 1         /// <summary>
 2         /// 獲取DataReader
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static IDataReader Query(string sql, object param)
 8         {
 9             using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
10             {
11                 return con.Ado.GetDataReader(sql, param);
12             }
13         }

 

 5、獲取首行首列

Dapper獲取首行首列

 1       /// <summary>
 2         /// Scalar獲取資料
 3         /// </summary>
 4         /// <param name="sql"></param>
 5         /// <param name="param"></param>
 6         /// <returns></returns>
 7         public static object ExecuteScalar(string sql, object param)
 8         {
 9             using (SqlConnection con = new SqlConnection(connectionString))
10             {
11                 return con.ExecuteScalar(sql, param);
12             }
13         }

SqlSugar獲取首行首列

 1     /// <summary>
 2         /// 獲取首行首列
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static object ExecuteScalar(string sql, object param)
 8         {
 9             using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
10             {
11                 return con.Ado.GetScalar(sql, param);
12             }
13         }

 

6、獲取儲存過程

Dapper獲取儲存過程

 1      /// <summary>
 2         /// 帶引數的儲存過程
 3         /// </summary>
 4         /// <param name="sql"></param>
 5         /// <param name="param"></param>
 6         /// <returns></returns>
 7         public static List<T> ExecutePro(string proc, object param)
 8         {
 9             using (SqlConnection con = new SqlConnection(connectionString))
10             {
11                 List<T> list = con.Query<T>(proc,
12                     param,
13                     null,
14                     true,
15                     null,
16                     CommandType.StoredProcedure).ToList();
17                 return list;
18             }
19         }

SqlSugar獲取儲存過程

 1       /// <summary>
 2         /// 獲取儲存過程
 3         /// </summary>
 4         /// <param name="sql">查詢的sql</param>
 5         /// <param name="param">替換引數</param>
 6         /// <returns></returns>
 7         public static object ExecutePro<T>(string proc, object param)
 8         {
 9             using (SqlSugarClient con =new SqlSugar.SqlSugarClient(connectionConfig))
10             {
11                 return con.Ado.UseStoredProcedure().SqlQuery<T>(proc, param);
12             }
13         }

 

7、事務執行多個Sql

Dapper事務執行多個Sql

 1   /// <summary>
 2         /// 事務1 - 全SQL
 3         /// </summary>
 4         /// <param name="sqlarr">多條SQL</param>
 5         /// <param name="param">param</param>
 6         /// <returns></returns>
 7         public static int ExecuteTransaction(string[] sqlarr)
 8         {
 9             using (SqlConnection con = new SqlConnection(connectionString))
10             {
11                 using (var transaction = con.BeginTransaction())
12                 {
13                     try
14                     {
15                         int result = 0;
16                         foreach (var sql in sqlarr)
17                         {
18                             result += con.Execute(sql, null, transaction);
19                         }
20 
21                         transaction.Commit();
22                         return result;
23                     }
24                     catch (Exception ex)
25                     {
26                         transaction.Rollback();
27                         return 0;
28                     }
29                 }
30             }
31         }

Sugar事務執行多個Sql

 1         /// <summary>
 2         /// 事務1 - 全SQL
 3         /// </summary>
 4         /// <param name="sqlarr">多條SQL</param>
 5         /// <param name="param">param</param>
 6         /// <returns></returns>
 7         public static int ExecuteTransaction(string[] sqlarr)
 8         {
 9             using (SqlSugarClient con = new SqlSugarClient(connectionConfig))
10             {
11                 con.Ado.BeginTran();
12                 using (var transaction = con.Ado.Transaction)
13                 {
14                     try
15                     {
16                         int result = 0;
17                         foreach (var sql in sqlarr)
18                         {
19                             result += con.Ado.ExecuteCommand(sql);
20                         }
21 
22                         transaction.Commit();
23                         return result;
24                     }
25                     catch (Exception ex)
26                     {
27                         transaction.Rollback();
28                         return 0;
29                     }
30                 }
31             }
32         }

 

SqlSugar引數詳解

SqlSugar同樣支援遊標 、Output、 ReturnValue  

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

 

 

移植成SqlSugar ORM有哪些優點

同樣是寫Sql但是SqlSugar提供了AOP、效能監控、返回多個結果集、SQL分頁、一對多、一對一操作、JSON型別 等

 

 1、SqlSugar支援AOP等事件操作

 1 db.Aop.OnLogExecuted = (sql, pars) => //SQL執行完
 2 {
 3  Console.Write("time:" + db.Ado.SqlExecutionTime.ToString());//輸出SQL執行時間
 4 };
 5 db.Aop.OnLogExecuting = (sql, pars) => //SQL執行前
 6 {
 7   
 8 };
 9 db.Aop.OnError = (exp) =>//SQL報錯
10 {
11     //exp.sql 這樣可以拿到錯誤SQL            
12 };
13 db.Aop.OnExecutingChangeSql = (sql, pars) => //可以修改SQL和引數的值
14 {
15     return new KeyValuePair<string, SugarParameter[]>(sql,pars);
16 };

除了這些事件外 SqlSugar還支援了效能監控，對於效能差的Sql或者儲存過程都能很好的跟蹤

 1    SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
 2    {
 3                 DbType = DbType.SqlServer,
 4                 ConnectionString = Config.ConnectionString,
 5                 InitKeyType = InitKeyType.Attribute,
 6                 IsAutoCloseConnection = true
 7                
 8    });
 9     db.Aop.OnLogExecuted = (sql, p) =>
10     {
11          //執行時間超過1秒
12         if (db.Ado.SqlExecutionTime.TotalSeconds > 1) 
13         {
14             //程式碼CS檔名
15             var fileName= db.Ado.SqlStackTrace.FirstFileName;
16             //程式碼行數
17             var fileLine = db.Ado.SqlStackTrace.FirstLine;
18             //方法名
19             var FirstMethodName = db.Ado.SqlStackTrace.FirstMethodName;
20             //db.Ado.SqlStackTrace.MyStackTraceList[1].xxx 獲取上層方法的資訊
21          }
22    };

因為內容比較多一下子寫不完 ,沒關注的點一波關注

2、Json型別的查詢

1 public class UnitJsonTest
2 {
3    [SqlSugar.SugarColumn(IsPrimaryKey = true, IsIdentity = true)]
4    public int Id { get; set; }
5     [IsJson = true)]//其中IsJson是必填
6    public Order Order { get; set; }
7    public string Name{get;set;}
8 }
9 var list = Db.Ado.SqlQuery<UnitJsonTest>().ToList();//資料庫是一個json字串

 3、Sql分頁

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

 

 

原始碼下載：https://github.com/sunkaixuan/SqlSugar

 

UnitJsonTest

相關文章