C# 資料操作系列 - 13 SugarSql初探

月影西下發表於2020-05-22
C#SQL

0. 前言

前言，暫時揮別NHibernate（雖然我突然發現這玩意還挺有意思的，不過看得人不多）。大步進入了有很多小夥伴向我安利的SQLSugar，嗯，我一直叫SugarSQL，好像是這個吧？

這是一個由國內開發者開發的ORM框架，是一個輕量級框架（最新版的sqlSugarCore大概只有290kb）。下圖是sqlSugar的功能描述：

功能說明

從圖中我們能夠大概看出，SqlSugar的使用需要預先建立一個SqlSugarClient物件。SqlSugar在此基礎上新增了CRUD、實體資訊維護（對映關係）、配置（AOP/過濾器等）、模式（DbFirst、CodeFirst）還有一些工具類等。可以看到這是一個簡而全的框架。

同時，SqlSugar也為查詢進行了進一步的擴充套件，以下是它支援的功能，以及在查詢上的增強：

查詢

好了，廢話不多說，先來試一下如何使用吧。

1. 安裝

本節環境是dotnet + vscode。因為我的Rider過期了，懶得折騰。系統又是Linux，所以選擇這種方式。至於Visual Studio和Rider的操作，十分簡單，而且之前《C#基礎系列16》裡有過介紹。

先建一個解決方案，名字為DataProvider：

dotnet new sln --name DataProvider

然後建立一個SqlSugarDemo的控制檯專案：

dotnet new console --name SqlSugarDemo

將這個專案新增到解決方案裡：（這一步為了方便後續管理）

dotnet sln add SqlSugarDemo

然後準備安裝 sqlSugarCore 。SqlSugar有兩個版本，這裡使用的是sqlSugarCore，這是針對.net core支援的版本。另一個是sqlSugar，是基於.netframework 4.X的。我們的系列是.net core的，所以就使用sqlSugarCore。

因為我們只是給專案SqlSugarDemo新增這個包，而不是給整個解決方案新增，所以我們需要預先切換目錄到SqlSugarDemo裡：

cd SqlSugarDemo/

然後使用命令列安裝 sqlSugarCore：

dotnet add package sqlSugarCore

或者使用 NuGet：

Install-Package sqlSugarCore

過一會就可以在控制檯中看到安裝成功的訊息：

log  : Restore completed in XX sec for XXXXXX/SqlSugarDemo/SqlSugarDemo.csproj.

2. 基本使用示例

在上一節中，我們成功在專案中安裝了sqlSugarCore，那麼在這一節中將帶領小夥伴們一起探索SqlSugar。

先建立一個普通的模型：

public class Person
{
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

建立一個操作類，取名為 DefaultContext，根據給出的文件得知，SqlSugar每次運算元據的時候需要持有一個 SqlSugarClient物件。所以，這個類的定義應該如下：

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,
        });
    }
}
  • ConnectionString ：連線字串
  • DbType：資料庫型別，共有以下幾個值
    • MySql
    • SqlServer
    • Sqlite
    • Oracle
    • PostgreSQL
  • IsAutoCloseConnection：是否自動關閉連線，推薦true，預設為false。預設情況下，需要手動釋放

然後測試插入：

var context = new DefaultContext("Data Source=./demo.db", DbType.Sqlite);
context.Client.Insertable<Person>(new Person
{
    Age = 10,
    Name = "小明"
}).ExecuteCommand();

這個時候，提示如下錯誤：no such table: Person

image-20200521232829596

原因很簡單，因為資料庫demo.db 裡沒有這個表。也就是SqlSugar預設不會自動生成表，但生成了一個空殼資料庫。

這時候，需要在DefaultContext的構造方法裡，為Client新增一些配置：

Client.CodeFirst.InitTables<Person>();

這一行的意思是使用CodeFirst模式，自動生成表 Person。

當然，這樣並不意味著就能繼續了，我們還需要設定 主鍵策略，在初始化 SqlSugarClient的時候，修改為：

Client = new SqlSugarClient(new ConnectionConfig
{
    ConnectionString = connectionString,//"Data Source=./demo.db",
    DbType = dbType,
    IsAutoCloseConnection = true,
    InitKeyType = InitKeyType.Attribute  //新增這行，意思是根據實體類取發現主鍵
});

然後重新插入，執行成功。

現在進行查詢測試：

var query = context.Client.Queryable<Person>();

query是一個ISugarQueryable<T>型別的元素，這個介面支援方法鏈查詢和查詢表示式兩種查詢方式：

var list = (from a in context.Client.Queryable<Person>()
            select a).ToList();
Console.WriteLine(list.Count);

通過這種方式，直接獲取了一個Person型別的列表。

然後，我們將針對這幾個元素進行修改和刪除測試。先來修改：

list[0].Age =22;
context.Client.Updateable(list[0]).ExecuteCommand();

直接執行會提示如下錯誤：

image-20200521235559454

意思是沒有提供主鍵或者檢索條件。根據它的錯誤資訊，我們可以得知解決方法基礎為兩種：

修改方案1：

在Person類上新增主鍵，並設定自增長。

public class Person
{
    [SugarColumn(IsPrimaryKey = true, IsIdentity = true)] 
    public int Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

解決方案2：

新增篩選條件：

context.Client.Updateable(list[0]).Where(t=>t.Name == "小明").ExecuteCommand();

我採用了第一個方法，新增了主鍵配置，重新執行，執行結果正確。

刪除，在更新修改完成後，刪除也正常使用：

context.Client.Deleteable(list[0]).ExecuteCommand();

3 總結

匆匆一撇，發現SqlSugar也是一個讓我感覺驚豔的ORM框架，功能全面，效率也非常不錯。下一篇將為小夥伴們深入探索一下sqlSugar。

更多內容煩請關注我的部落格《高先生小屋》

file

相關文章