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

来源:https://www.cnblogs.com/c7jie/archive/2020/05/24/12952759.html
-Advertisement-
Play Games

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


0. 前言

繼上一篇，以及上上篇，我們對SqlSugar有了一個大概的認識，但是這並不完美，因為那些都是理論知識，無法描述我們工程開發中實際情況。而這一篇，將帶領小伙伴們一起試著寫一個能在工程中使用的模板類。

1. 創建一個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，這裡面有很多可以直接拿來用的方法，而且這個是一個泛型類。也就是說我們可以使用它對單個實體類進行操作，這在開發中很重要。

2. 插入數據

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

2.1 簡單的插入模式

public bool Insert(T insertObj);
public bool InsertRange(T[] insertObjs);
public bool InsertRange(List<T> insertObjs);

這是SqlSugar在SimpleClient里提供的兩個預設插入方法，一個是插入單個實體對象，一個是插入一組對象。

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

public int InsertReturnIdentity(T insertObj);

通過這個方法可以獲取一個預設的int類型主鍵值。

2.2 高級玩法

SqlSugar還有一種插入模式，通過AsInsertable返回一個 IInsertable泛型介面：

public IInsertable<T> AsInsertable(T insertObj);
public IInsertable<T> AsInsertable(T[] insertObjs);
public IInsertable<T> AsInsertable(List<T> insertObjs);

這種模式與SimpleClient的普通插入模式不同，它並不會直接執行插入動作，需要手動調用並執行插入動作：

int ExecuteCommand();

執行動作，然後返回受影響的行數。

bool ExecuteCommandIdentityIntoEntity();

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

long ExecuteReturnBigIdentity();
int ExecuteReturnIdentity();

執行動作，然後返回主鍵值，不會更新實體。

有一點值得特別註意：

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

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

IInsertable<T> InsertColumns(Expression<Func<T, object>> columns);// 滿足條件的插入，其他列則不插入
IInsertable<T> InsertColumns(params string[] columns);//插入指定列名

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

3. 更新或插入

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

3.1 簡單模式

先來兩個最簡單的：

public bool Update(T updateObj);
public bool UpdateRange(T[] updateObjs);
public bool UpdateRange(List<T> updateObjs);

傳入實體，直接更新到資料庫中，需要註意的是這種更新模式只需要保證主鍵有值，且與之對應即可。

public bool Update(Expression<Func<T, T>> columns, Expression<Func<T, bool>> whereExpression);

這是另一種條件更新，會更新滿足whereExpression的所有元素，更新示例：

personClient.Update(p=>new Person
{
    Age = 1
}, p=>p.Id == 1);

columns需要返回一個要更新的對象的屬性列，也就是在columns中設置需要更新的內容。

3.2 高級模式

同樣，通過AsUpdateable開啟高級模式：

public IUpdateable<T> AsUpdateable(T[] updateObjs);
public IUpdateable<T> AsUpdateable(T updateObj);
public IUpdateable<T> AsUpdateable(List<T> updateObjs);

然後可以針對這些今天更多的操作：

int ExecuteCommand();

返回命令執行影響的行數

bool ExecuteCommandHasChange();

返回是否有變化，也就是影響行數是否大於0。

  • 只更新某些列：
IUpdateable<T> SetColumns(Expression<Func<T, bool>> columns);

更新示例：

personClient.AsUpdateable(d).SetColumns(t=>t.Age ==2).ExecuteCommand();

傳入一個lambda表達式，使數據滿足lambda表達式。要求lambda表達式只能用 == 來判斷列是否等於某個值。

IUpdateable<T> SetColumns(Expression<Func<T, T>> columns);
IUpdateable<T> UpdateColumns(params string[] columns);
IUpdateable<T> UpdateColumns(Expression<Func<T, object>> columns);

傳入要更新的實際列名。其中 object 用來接一個匿名對象，其中屬性名字就是要更新的值。

  • 不更新某些列
IUpdateable<T> IgnoreColumns(params string[] columns);// 忽略傳入的列名
IUpdateable<T> IgnoreColumns(Expression<Func<T, object>> columns);// 用匿名對象表示要忽略的列名
IUpdateable<T> IgnoreColumns(bool ignoreAllNullColumns, bool isOffIdentity = false, bool ignoreAllDefaultValue = false);// 設置是否忽略Null列，是否強制更新主鍵，是否忽略所有預設值列
  • 條件更新
IUpdateable<T> Where(Expression<Func<T, bool>> expression);
IUpdateable<T> Where(string fieldName, string conditionalType, object fieldValue);
IUpdateable<T> Where(string whereSql, object parameters = null);
IUpdateable<T> WhereColumns(Expression<Func<T, object>> columns);
IUpdateable<T> WhereColumns(string columnName);
IUpdateable<T> WhereColumns(string[] columnNames);

來，簡單猜一猜這幾個是什麼意思呢？

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

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

3.3 更新或插入

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

ISaveable<T> Saveable<T>(T saveObject) where T : class, new();
ISaveable<T> Saveable<T>(List<T> saveObjects) where T : class, new();

不過這個方法是在SugarClient里，我們可以通過：

public ISqlSugarClient AsSugarClient();

在SimpleClient中獲得 與之關聯的SugarClient對象。

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

4. 刪除

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

public bool Delete(Expression<Func<T, bool>> 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語句刪除的方法，除此之外沒有別的需要註意的地方了。

5. 查詢

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

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

public bool IsAny(Expression<Func<T, bool>> whereExpression);// 查詢是否存在符合條件的數據
public int Count(Expression<Func<T, bool>> whereExpression);// 獲取滿足條件的數量

public T GetById([Dynamic] dynamic id);//根據主鍵獲取一個實例
public bool IsAny(Expression<Func<T, bool>> whereExpression);//返回滿足條件的一個對象

public List<T> GetList();// 以List的形式返回所有數據
public List<T> GetList(Expression<Func<T, bool>> whereExpression);//返回符合條件的所有數據

分頁獲取數據：

public List<T> GetPageList(Expression<Func<T, bool>> whereExpression, PageModel page);
public List<T> GetPageList(Expression<Func<T, bool>> whereExpression, PageModel page, Expression<Func<T, object>> orderByExpression = null, OrderByType orderByType = OrderByType.Asc);

public List<T> GetPageList(List<IConditionalModel> conditionalList, PageModel page);
public List<T> GetPageList(List<IConditionalModel> conditionalList, PageModel page, Expression<Func<T, object>> 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<IConditionalModel>
{
    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

可以看出兩者並沒有區別，只不過是不同的查詢習慣。

6. 總結

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

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

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

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

更多內容煩請關註我的博客《高先生小屋》

file


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 程式員使用IDEA這些插件後,辦公效率提升100%（持續更新中）
    IDEA一些不錯的插件分享 目錄 IDEA一些不錯的插件分享 插件集合 CamelCase Translation LiveEdit MarkDown Navigator Jrebel CheckStyle IDEA Alibaba Java Coding Guidelines Ideavim Ma ...
  • HashMap理解
    hashCode() 和equals() 方法的重要性體現在什麼地方？ Java中的HashMap使用hashCode()和equals()方法設置值，根據鍵獲取值的時候也會用到這兩個方法。 怎樣 設置 的值？ hashCode()獲得 hash值。而hash值用來確定hashmap中內部 Node ...
  • Flutter “孔雀開屏”的動畫效果
    老孟導讀：今天分享一個類似“孔雀開屏”的動畫效果，打開新的頁面時，新的頁面從屏幕右上角以圓形逐漸打開到全屏。 先來看下具體的效果 不知道這種效果大家叫什麼名字？如果有更合適的名字可以在評論處告訴我，下麵來說下如何實現此效果。 在使用Navigator進入一個新的頁面時，通常用法如下： 就包含了切換頁 ...
  • Python基礎-04元組
    4.元組 元組的主要特性為： 1.元組在創建之後，具有不可以更改的特性，因此不能直接給元組的元素賦值 2.元組的元素類型可以為任意類型，如字典、字元串、列表等 3.元組常用於在程式的整個生命周期中都不變的場景中 4.1 常用方法 元組大小和內容在定義賦值之後，就不可更改，常用的方法如下所示： cou ...
  • ARMR模型簡單實踐（1）
    1.概念簡述 （1）AR模型 AR 模型(auto regressive model)自回歸模型，模型參量法高解析度譜分析方法之一，也是現代譜估計中常用的模型。 用AR模型法求信具體作法是： ①選擇AR模型，在輸入是衝激函數或白雜訊的情況下，使其輸出等於所研究的信號，至少，應是對該信號的一個好的近似 ...
  • Visual Studio之代碼清理(一)
    執行代碼清理時，可以點擊那個掃把小圖片，會按照預設的第一種配置文件來自動修複。也可以點擊下拉三角符合，選擇不同的配置文件，然後進行修複。或者快捷鍵Ctrl+K，Ctrl+E。 針對每一項配置的說明： 刪除不必要的using 儘可能將私有欄位設置為只讀 刪除不必要的類型轉換（針對強類型轉換），像Con ...
  • .NET 程式下銳浪報表 (Grid++ Report) 的綠色發佈指南
    .NET 程式下銳浪報表 (Grid++ Report) 的綠色發佈指南 在銳浪報表官方為 CSharp 編寫的開發文檔：“在C#與VB.NET中開始使用說明.txt” 中，關於發佈項目是這麼描述的： ★發佈你的項目，用VS.NET製作安裝程式：1、先創建安裝項目：在解決方案資源管理器的根節點上點右 ...
  • 11_ArrayList集合的方法
    1 class Program 2 { 3 static void Main(string[] args) 4 { 5 //數組：長度不可變，類型單一 6 //ArrayList集合：長度可以任意改變，類型可以不單一 7 8 //創建一個ArrayList對象 9 ArrayList mylist ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類