C# 數據操作系列 - 15 SqlSugar 增刪改查詳解

C# 數據操作系列 - 15 SqlSugar 增刪改查詳解

  1. 前言
    繼上一篇,以及上上篇,我們對SqlSugar有了一個大概的認識,但是這並不完美,因爲那些都是理論知識,無法描述我們工程開發中實際情況。而這一篇,將帶領小夥伴們一起試着寫一個能在工程中使用的模板類。
  2. 創建一個Client
    SqlSugar在操作的時候需要一個Client,用來管理數據庫連接,並操作數據庫。所以我們寫一個DbContext用來創建Client:

public class DefaultContext
{

public SqlSugarClient Client { get; }

public DefaultContext(string connectionString, DbType dbType)
{
    Client = new SqlSugarClient(new ConnectionConfig
    {
        ConnectionString = connectionString,//"Data Source=./demo.db",
        DbType = dbType,
        IsAutoCloseConnection = true,
        InitKeyType = InitKeyType.Attribute
    });
    Client.CodeFirst.InitTables(typeof(Dept), typeof(Person), typeof(Employee));
    Client.Aop.OnLogExecuting = (sql, paramters) =>
    {
        Console.WriteLine(sql);
    };
}

public SimpleClient<T> CreateClient<T>() where T : class, new()
{
    return Client.GetSimpleClient<T>();
}

}
SqlSugar 提供了一個SimpleClient,這裏面有很多可以直接拿來用的方法,而且這個是一個泛型類。也就是說我們可以使用它對單個實體類進行操作,這在開發中很重要。

  1. 插入數據
    對於一個程序而言,數據就像是血液一樣重要。對於ORM框架,插入是一切來源的基礎。所以我們先來看看SqlSugar的插入是怎樣的吧:

2.1 簡單的插入模式
public bool Insert(T insertObj);
public bool InsertRange(T[] insertObjs);
public bool InsertRange(List insertObjs);
這是SqlSugar在SimpleClient裏提供的兩個默認插入方法,一個是插入單個實體對象,一個是插入一組對象。

默認情況下,SqlSugar插入並不會將主鍵返回給數據。如果後續操作需要當前數據的主鍵,則可以調用另外一個方法:

public int InsertReturnIdentity(T insertObj);
通過這個方法可以獲取一個默認的int類型主鍵值。

2.2 高級玩法
SqlSugar還有一種插入模式,通過AsInsertable返回一個 IInsertable泛型接口:

public IInsertable AsInsertable(T insertObj);
public IInsertable AsInsertable(T[] insertObjs);
public IInsertable AsInsertable(List insertObjs);
這種模式與SimpleClient的普通插入模式不同,它並不會直接執行插入動作,需要手動調用並執行插入動作:

int ExecuteCommand();
執行動作,然後返回受影響的行數。

bool ExecuteCommandIdentityIntoEntity();
執行動作,然後將主鍵插入實體對象,返回插入結果。執行完成後,主鍵數據保存到實體示例中。

long ExecuteReturnBigIdentity();
int ExecuteReturnIdentity();
執行動作,然後返回主鍵值,不會更新實體。

有一點值得特別注意:

所有會返回主鍵的插入都只針對單個數據,如果一次插入多個數據,並不會返回主鍵信息也無法將主鍵信息更新入實體中。

以上都是全列插入,SqlSugar還提供了只插入部分列和忽略某些列兩種模式:

IInsertable InsertColumns(Expression> columns);// 滿足條件的插入,其他列則不插入
IInsertable InsertColumns(params string[] columns);//插入指定列名
IInsertable IgnoreColumns(Expression> columns);// 忽略滿足條件的列,插入其他列
IInsertable IgnoreColumns(params string[] columns);// 忽略這幾個列
IInsertable IgnoreColumns(bool ignoreNullColumn, bool isOffIdentity = false);//指定是否忽略Null列,並是否強制插入主鍵

  1. 更新或插入
    介紹完插入,那麼來介紹一下更新。正所謂,沒有更新數據就是一灘死水,有了更新數據纔有了變化。所以,就讓我們來看看如何優雅的更新數據吧:

3.1 簡單模式
先來兩個最簡單的:

public bool Update(T updateObj);
public bool UpdateRange(T[] updateObjs);
public bool UpdateRange(List updateObjs);
傳入實體,直接更新到數據庫中,需要注意的是這種更新模式只需要保證主鍵有值,且與之對應即可。

public bool Update(Expression> columns, Expression> whereExpression);
這是另一種條件更新,會更新滿足whereExpression的所有元素,更新示例:

personClient.Update(p=>new Person
{

Age = 1

}, p=>p.Id == 1);
columns需要返回一個要更新的對象的屬性列,也就是在columns中設置需要更新的內容。

3.2 高級模式
同樣,通過AsUpdateable開啓高級模式:

public IUpdateable AsUpdateable(T[] updateObjs);
public IUpdateable AsUpdateable(T updateObj);
public IUpdateable AsUpdateable(List updateObjs);
然後可以針對這些今天更多的操作:

int ExecuteCommand();
返回命令執行影響的行數

bool ExecuteCommandHasChange();
返回是否有變化,也就是影響行數是否大於0。

只更新某些列:
IUpdateable SetColumns(Expression> columns);
更新示例:

personClient.AsUpdateable(d).SetColumns(t=>t.Age ==2).ExecuteCommand();
傳入一個lambda表達式,使數據滿足lambda表達式。要求lambda表達式只能用 == 來判斷列是否等於某個值。

IUpdateable SetColumns(Expression> columns);
IUpdateable UpdateColumns(params string[] columns);
IUpdateable UpdateColumns(Expression> columns);
傳入要更新的實際列名。其中 object 用來接一個匿名對象,其中屬性名字就是要更新的值。

不更新某些列
IUpdateable IgnoreColumns(params string[] columns);// 忽略傳入的列名
IUpdateable IgnoreColumns(Expression> columns);// 用匿名對象表示要忽略的列名
IUpdateable IgnoreColumns(bool ignoreAllNullColumns, bool isOffIdentity = false, bool ignoreAllDefaultValue = false);// 設置是否忽略Null列,是否強制更新主鍵,是否忽略所有默認值列
條件更新
IUpdateable Where(Expression> expression);
IUpdateable Where(string fieldName, string conditionalType, object fieldValue);
IUpdateable Where(string whereSql, object parameters = null);
IUpdateable WhereColumns(Expression> columns);
IUpdateable WhereColumns(string columnName);
IUpdateable WhereColumns(string[] columnNames);
來,簡單猜一猜這幾個是什麼意思呢?

可以說很簡單明瞭的幾種條件設置模式,lambda表示篩選更新數據,字段值判斷條件更新。

其中 conditionType的值,推薦使用 ConditionalType枚舉的值。

3.3 更新或插入
在實際開發中可能會遇到插入或更新是走的一個方法,所以我們就要尋找一個可以直接更新或插入的方法。SqlSugar爲此提供瞭解決方案:

ISaveable Saveable(T saveObject) where T : class, new();
ISaveable Saveable(List saveObjects) where T : class, new();
不過這個方法是在SugarClient裏,我們可以通過:

public ISqlSugarClient AsSugarClient();
在SimpleClient中獲得 與之關聯的SugarClient對象。

關於更新或插入判斷標準是,主鍵是否有值。如果主鍵有值且在數據庫中存在該條記錄,則執行更新,否則執行插入。

  1. 刪除
    刪除在實際開發過程中是一個非常重要的功能點,所以如何快速有效的刪除數據也是一件很重要的事。那麼,就來看看如何執行刪除吧:

public bool Delete(Expression> whereExpression);
public bool Delete(T deleteObj);
public bool DeleteById([Dynamic] dynamic id);
public bool DeleteByIds([Dynamic(new[] { false, true })] dynamic[] ids);
刪除沒有其他需要注意的地方,第一個是條件刪除,所有滿足條件的都要刪除。第二個刪除單個對象,後面兩個根據主鍵刪除對象。

悄悄吐槽一下,主鍵的地方用object會比較好一點,因爲動態對象會增加一次裝箱拆箱的過程。

當然了,刪除也有AsDeleteable方法。IDeleteable接口特別提供了根據sql語句刪除的方法,除此之外沒有別的需要注意的地方了。

  1. 查詢
    一個好的ORM框架,至少五分功力在查詢上,如何更快更準的查詢成爲了現在開發對ORM框架的要求。同時簡單易用更是程序員對ORM的期望。

那麼我們來看看SqlSugar在查詢上的功力吧:

public bool IsAny(Expression> whereExpression);// 查詢是否存在符合條件的數據
public int Count(Expression> whereExpression);// 獲取滿足條件的數量
public T GetById([Dynamic] dynamic id);//根據主鍵獲取一個實例
public bool IsAny(Expression> whereExpression);//返回滿足條件的一個對象
public List GetList();// 以List的形式返回所有數據
public List GetList(Expression> whereExpression);//返回符合條件的所有數據
分頁獲取數據:

public List GetPageList(Expression> whereExpression, PageModel page);
public List GetPageList(Expression> whereExpression, PageModel page, Expression> orderByExpression = null, OrderByType orderByType = OrderByType.Asc);
public List GetPageList(List conditionalList, PageModel page);
public List GetPageList(List conditionalList, PageModel page, Expression> orderByExpression = null, OrderByType orderByType = OrderByType.Asc);
其中IConditionModel是一個空的接口,用來定義規範查詢規範,實際上使用的是類:

public class ConditionalModel: IConditionalModel
{

public ConditionalModel()
{
    this.ConditionalType = ConditionalType.Equal;
}
public string FieldName { get; set; }
public string FieldValue { get; set; }
public ConditionalType ConditionalType { get; set; }
public Func<string,object> FieldValueConvertFunc { get; set; }

}
那麼,我們看一下 ConditionType,定義了各種判斷依據:

public enum ConditionalType
{

Equal=0,
Like=1,
GreaterThan =2,
GreaterThanOrEqual = 3,
LessThan=4,
LessThanOrEqual = 5,
In=6,
NotIn=7,
LikeLeft=8,
LikeRight=9,
NoEqual=10,
IsNullOrEmpty=11,
IsNot=12,
NoLike = 13,

}
那麼我們簡單看一下 使用IConditionModel進行分頁是怎樣的效果:

var list = personClient.GetPageList(new List
{

new ConditionalModel
{
    FieldName = "Age",
    FieldValue = "3",
    ConditionalType = ConditionalType.LessThan
}

}, pageModel);
生成如下SQL語句:

SELECT COUNT(1) FROM (SELECT Id,Name,Age FROM Person WHERE Age < @ConditionalAge0 ) CountTable
SELECT Id,Name,Age FROM Person WHERE Age < @ConditionalAge0 LIMIT 0,2
可以看出兩者並沒有區別,只不過是不同的查詢習慣。

  1. 總結
    按照之前的習慣,到目前應該可以結束了。但是SqlSugar還有一些很重要的地方沒有介紹,所以就加個下期預告

下一篇將爲大家分析SqlSugar的一些更高級的內容,查詢的高級模式、事務以及批量操作

好,總結一下這一篇,我們在這一篇看到了SqlSugar在增刪改查上的亮點,可以說更貼合實際業務需求開發。嗯,悄悄給個贊。

再有三篇的內容《C# 數據操作系列》就要完結了。從下一系列開始,就要步入工作中最重要的技術棧了:Asp.net Core。這是可以寫入簡歷的。嗯,沒錯。下一系列計劃以實戰的形式介紹asp.net core的知識點和設置。

原文地址https://www.cnblogs.com/c7jie/p/12952759.html

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章