Dapper.Contrib——更加優雅地使用Dapper進行增刪改查

簡介

Dapper是介於Entity framework與ADO的折中選擇。既滿足手寫查詢的高性能需求，又簡化了數據庫對象映射為內存對象的繁雜工作。Dapper.Contrib是對Dapper的進一步封裝，使對象的基本增刪改查等操作進一步簡化。

為什么使用Dapper.Contrib

如果僅僅使用Dapper，要對一個對象進行insert操作需要如下操作

 using (var connection = new SqlConnection("鏈接字符串"))
{
       var users = connection.Execute("insert into Demo (Name,Age) values('張三',23)");
}

Dapper.Contrib不需要寫sql，操作對象即可

using (var connnection = DbHelper.GetConnection())
{
      var result = connnection.Insert(new Demo
       {
            Age = 23,
            Name = "張三",
       });
}

 使用Dapper.Contrib

工欲善其事，必先利其器。要想不寫sql愉快地增刪改當然需要前期地配置。

entity配置

 

    [Table("Demo")]
    public class Demo
    {
        [Key] //不是自動增長主鍵時使用ExplicitKey
        public int Id { get; set; }

        public string Name { get; set; }

        public int Age { get; set; }

        [Computed]
        public int ComputedAge => Age * 2;

        [Write(false)]
        public int NoWriteCol { get; set; }

    }

上面的Demo類里面包含了Dapper.Contrib的所有實體配置選項

• Table：指定實體對應地數據庫表名，可忽略，但是忽略后實體對應地數據庫表名會在末尾加個s，Demo對應Demos（感覺畫蛇添足了）
• Key：指定此列為主鍵（自動增長主鍵），可忽略，忽略后默認查找
• ExplicitKey：指定此列為主鍵（不自動增長類型例如guid，ExplicitKey與Key地區別下面會詳細講）
  
• Computed：計算屬性，打上此標簽，對象地insert，update等操作會忽略此列
• Write：需穿一個bool值，false時insert，update等操作會忽略此列（和Computed的作用差不多，看了源碼也沒發現與Computed有什么不一樣的地方，有了解的朋友可以賜教下哈）

Key和ExplicitKey這兩項都是指定列為主鍵的。區別是打上Key特性的列在插入時是不能指定值的，只能是數據庫自動增長列，而ExplicitKey特性可以允許在插入時指定值，比如用guid為主鍵類型，則主鍵在插入時必須已經生成好。

 

增刪改查

做好上面的配置后就可以進行實體的操作了，Dapper.Contrib與Dapper一樣都是拓展了DbConnection對象，方法如下（未列出異步方法）

• T Get<T>(id);
• IEnumerable<T> GetAll<T>();
• int Insert<T>(T obj);
• int Insert<T>(Enumerable<T> list);
• bool Update<T>(T obj);
• bool Update<T>(Enumerable<T> list);
• bool Delete<T>(T obj);
• bool Delete<T>(Enumerable<T> list);
• bool DeleteAll<T>();

值得注意的是，從源碼得知，Get方法僅支持單主鍵查詢，如果多主鍵或者沒主鍵都會報錯

 if (keyCount > 1)
                throw new DataException($"{method}<T> only supports an entity with a single [Key] or [ExplicitKey] property");
 if (keyCount == 0)
                throw new DataException($"{method}<T> only supports an entity with a [Key] or an [ExplicitKey] property");