0. 前言
前言,暫時(shí)揮別NHibernate(雖然我突然發(fā)現(xiàn)這玩意還挺有意思的,不過看得人不多)。大步進(jìn)入了有很多小伙伴向我安利的SQLSugar,嗯,我一直叫SugarSQL,好像是這個(gè)吧?
這是一個(gè)由國內(nèi)開發(fā)者開發(fā)的ORM框架,是一個(gè)輕量級框架(最新版的sqlSugarCore大概只有290kb)。下圖是sqlSugar的功能描述:

從圖中我們能夠大概看出,SqlSugar的使用需要預(yù)先創(chuàng)建一個(gè)SqlSugarClient對象。SqlSugar在此基礎(chǔ)上添加了CRUD、實(shí)體信息維護(hù)(映射關(guān)系)、配置(AOP/過濾器等)、模式(DbFirst、CodeFirst)還有一些工具類等??梢钥吹竭@是一個(gè)簡而全的框架。
同時(shí),SqlSugar也為查詢進(jìn)行了進(jìn)一步的擴(kuò)展,以下是它支持的功能,以及在查詢上的增強(qiáng):

好了,廢話不多說,先來試一下如何使用吧。
1. 安裝
本節(jié)環(huán)境是dotnet + vscode。因?yàn)槲业腞ider過期了,懶得折騰。系統(tǒng)又是Linux,所以選擇這種方式。至于Visual Studio和Rider的操作,十分簡單,而且之前《C#基礎(chǔ)系列16》里有過介紹。
先建一個(gè)解決方案,名字為DataProvider:
dotnet new sln --name DataProvider
然后創(chuàng)建一個(gè)SqlSugarDemo的控制臺項(xiàng)目:
dotnet new console --name SqlSugarDemo
將這個(gè)項(xiàng)目添加到解決方案里:(這一步為了方便后續(xù)管理)
dotnet sln add SqlSugarDemo
然后準(zhǔn)備安裝 sqlSugarCore 。SqlSugar有兩個(gè)版本,這里使用的是sqlSugarCore,這是針對.net core支持的版本。另一個(gè)是sqlSugar,是基于.netframework 4.X的。我們的系列是.net core的,所以就使用sqlSugarCore。
因?yàn)槲覀冎皇墙o項(xiàng)目SqlSugarDemo添加這個(gè)包,而不是給整個(gè)解決方案添加,所以我們需要預(yù)先切換目錄到SqlSugarDemo里:
cd SqlSugarDemo/
然后使用命令行安裝 sqlSugarCore:
dotnet add package sqlSugarCore
或者使用 NuGet:
Install-Package sqlSugarCore
過一會就可以在控制臺中看到安裝成功的消息:
log : Restore completed in XX sec for XXXXXX/SqlSugarDemo/SqlSugarDemo.csproj.
2. 基本使用示例
在上一節(jié)中,我們成功在項(xiàng)目中安裝了sqlSugarCore,那么在這一節(jié)中將帶領(lǐng)小伙伴們一起探索SqlSugar。
先創(chuàng)建一個(gè)普通的模型:
public class Person
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
}
創(chuàng)建一個(gè)操作類,取名為 DefaultContext,根據(jù)給出的文檔得知,SqlSugar每次操作數(shù)據(jù)的時(shí)候需要持有一個(gè) SqlSugarClient對象。所以,這個(gè)類的定義應(yīng)該如下:
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:數(shù)據(jù)庫類型,共有以下幾個(gè)值
- MySql
- SqlServer
- Sqlite
- Oracle
- PostgreSQL
- IsAutoCloseConnection:是否自動關(guān)閉連接,推薦true,默認(rèn)為false。默認(rèn)情況下,需要手動釋放
然后測試插入:
var context = new DefaultContext("Data Source=./demo.db", DbType.Sqlite);
context.Client.Insertable<Person>(new Person
{
Age = 10,
Name = "小明"
}).ExecuteCommand();
這個(gè)時(shí)候,提示如下錯(cuò)誤:no such table: Person

原因很簡單,因?yàn)閿?shù)據(jù)庫demo.db 里沒有這個(gè)表。也就是SqlSugar默認(rèn)不會自動生成表,但生成了一個(gè)空殼數(shù)據(jù)庫。
這時(shí)候,需要在DefaultContext的構(gòu)造方法里,為Client添加一些配置:
Client.CodeFirst.InitTables<Person>();
這一行的意思是使用CodeFirst模式,自動生成表 Person。
當(dāng)然,這樣并不意味著就能繼續(xù)了,我們還需要設(shè)置 主鍵策略,在初始化 SqlSugarClient的時(shí)候,修改為:
Client = new SqlSugarClient(new ConnectionConfig
{
ConnectionString = connectionString,//"Data Source=./demo.db",
DbType = dbType,
IsAutoCloseConnection = true,
InitKeyType = InitKeyType.Attribute //添加這行,意思是根據(jù)實(shí)體類取發(fā)現(xiàn)主鍵
});
然后重新插入,執(zhí)行成功。
現(xiàn)在進(jìn)行查詢測試:
var query = context.Client.Queryable<Person>();
query是一個(gè)ISugarQueryable<T>類型的元素,這個(gè)接口支持方法鏈查詢和查詢表達(dá)式兩種查詢方式:
var list = (from a in context.Client.Queryable<Person>()
select a).ToList();
Console.WriteLine(list.Count);
通過這種方式,直接獲取了一個(gè)Person類型的列表。
然后,我們將針對這幾個(gè)元素進(jìn)行修改和刪除測試。先來修改:
list[0].Age =22;
context.Client.Updateable(list[0]).ExecuteCommand();
直接執(zhí)行會提示如下錯(cuò)誤:

意思是沒有提供主鍵或者檢索條件。根據(jù)它的錯(cuò)誤信息,我們可以得知解決方法基礎(chǔ)為兩種:
修改方案1:
在Person類上添加主鍵,并設(shè)置自增長。
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();
我采用了第一個(gè)方法,添加了主鍵配置,重新運(yùn)行,執(zhí)行結(jié)果正確。
刪除,在更新修改完成后,刪除也正常使用:
context.Client.Deleteable(list[0]).ExecuteCommand();
3 總結(jié)
匆匆一撇,發(fā)現(xiàn)SqlSugar也是一個(gè)讓我感覺驚艷的ORM框架,功能全面,效率也非常不錯(cuò)。下一篇將為小伙伴們深入探索一下sqlSugar。
更多內(nèi)容煩請關(guān)注我的博客《高先生小屋》
