C# 數據操做系列 - 13 SugarSql初探

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

緣由很簡單，由於數據庫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();

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

意思是沒有提供主鍵或者檢索條件。根據它的錯誤信息，咱們能夠得知解決方法基礎爲兩種：

修改方案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。

更多內容煩請關注個人博客《高先生小屋》