0. 前言

前幾天FreeSql的作者向我推薦了FreeSql框架，想讓我?guī)兔?xiě)個(gè)文章介紹一下。嗯，想不到我也能帶個(gè)貨了。哈哈，開(kāi)個(gè)玩笑～看了下覺(jué)得設(shè)計(jì)的挺有意思的，所以就謝了這篇文章。

簡(jiǎn)單介紹一下，FreeSql 是NCC組織的沙盒級(jí)項(xiàng)目，是一款功能強(qiáng)大的 ORM 組件，支持 .NET Core、.NET Framework 和 Xamarin。目前 FreeSql 支持以下數(shù)據(jù)庫(kù)：MySQL、PostgreSQL、SqlServer、Oracle、Sqlite、Odbc、微軟 Access 以及國(guó)產(chǎn)數(shù)據(jù)庫(kù)達(dá)夢(mèng)。

也就是說(shuō)也是一個(gè)由國(guó)內(nèi)優(yōu)秀開(kāi)發(fā)者維護(hù)的優(yōu)秀項(xiàng)目，初步看了下功能很齊全。小伙伴們有時(shí)間可以取瞅瞅。下圖是我從它GitHub倉(cāng)庫(kù)里復(fù)制過(guò)來(lái)的。可以看見(jiàn)支持的功能還是相當(dāng)多的。

關(guān)于NCC社區(qū)，是.net core的一個(gè)開(kāi)源社區(qū)，也是國(guó)內(nèi)最大的.net core開(kāi)源社區(qū)

1. 初步使用

照例，沒(méi)安裝就沒(méi)有調(diào)用。所以，在創(chuàng)建項(xiàng)目之后，安裝一下吧：

dotnet add package FreeSql

然后創(chuàng)建一個(gè)IFreeSql對(duì)象：

public class FreeSqlContext {public static IFreeSql FreeSqlConnect { get; } =new FreeSql.FreeSqlBuilder() .UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=document.db").UseAutoSyncStructure(true) //自動(dòng)同步實(shí)體結(jié)構(gòu)到數(shù)據(jù)庫(kù).Build(); }

因?yàn)楣俜揭髮FreeSql對(duì)象聲明為單例模式，所以我在這里使用了靜態(tài)屬性。

這種寫(xiě)法是C#的一種語(yǔ)法糖，只有g(shù)et表示該屬性是一個(gè)只能讀的屬性（與只讀屬性有個(gè)微妙的差距），等號(hào)后面表示該屬性第一次賦值的內(nèi)容。

創(chuàng)建一個(gè)普通的Model類(lèi)：

public class Model {public int Id { get; set; }public int StringLength { get; set; }public string Name { get; set; } }

1.1 簡(jiǎn)單插入

然后試一下插入數(shù)據(jù)：

var row = FreeSqlContext.FreeSqlConnect.Insert(new Model {Name = "測(cè)試",StringLength = 10 }).ExecuteAffrows();

提示如圖內(nèi)容，需要我們手動(dòng)安裝一下FreeSql的SQLite驅(qū)動(dòng)，安裝之后：

dotnet add packages FreeSql.Provider.Sqlite

FreeSql針對(duì)各種受支持的數(shù)據(jù)庫(kù)都單獨(dú)開(kāi)發(fā)了驅(qū)動(dòng)包，統(tǒng)一命名為：

FreeSql.Provider.<數(shù)據(jù)庫(kù)類(lèi)型>

安裝完成后，重新運(yùn)行后順利完成執(zhí)行，順便幫你把數(shù)據(jù)庫(kù)也生成好了（這一點(diǎn)我感覺(jué)挺好的），同時(shí)生成了一個(gè)主鍵為Id的Model表：

create table Model (Id INTEGERprimary key,StringLength INTEGER not null,Name NVARCHAR(255) );

1.2 簡(jiǎn)單查詢(xún)

接下來(lái)簡(jiǎn)單的查詢(xún)一下剛剛插入的數(shù)據(jù)：

var list = FreeSqlContext.FreeSqlConnect.Queryable<Model>().ToList();

可以發(fā)現(xiàn)，查詢(xún)使用還是非常方便的。

1.3 簡(jiǎn)單更新

FreeSql的更新與其他框架相比略顯復(fù)雜，這里先展示一種更新方式：

list[0].Name = "修改測(cè)試"; row = FreeSqlContext.FreeSqlConnect.Update<Model>().SetSource(list[0]).ExecuteAffrows();

先聲明要更新的類(lèi)型是Model，然后設(shè)置更新源。

1.4 簡(jiǎn)單刪除

row = FreeSqlContext.FreeSqlConnect.Delete<Model>(new[] { list[0] }).ExecuteAffrows();

刪除之前獲取的數(shù)據(jù)。

簡(jiǎn)單的看，FreeSql設(shè)計(jì)的增刪改查都是以命令的形式進(jìn)行的，在實(shí)際調(diào)用ExcuteXXX之前數(shù)據(jù)并不會(huì)保存到數(shù)據(jù)庫(kù)中。

2. 增刪改查詳解

在上一節(jié)中我們簡(jiǎn)單的使用了一下增刪改查， 這一節(jié)將為大家詳細(xì)分析一下FreeSql的增刪改查。

2.1 新增

IInsert<T1> Insert<T1>() where T1 : class; IInsert<T1> Insert<T1>(T1 source) where T1 : class; IInsert<T1> Insert<T1>(IEnumerable<T1> source) where T1 : class; IInsert<T1> Insert<T1>(List<T1> source) where T1 : class; IInsert<T1> Insert<T1>(T1[] source) where T1 : class;

這是IFreeSql接口里聲明的Insert方法，通過(guò)方法我們可以看到插入單數(shù)據(jù)插入以及多數(shù)據(jù)插入，并且返回一個(gè)IInsert<T1>的接口。當(dāng)然也可以不傳入數(shù)據(jù)直接獲取一個(gè)IInsert接口實(shí)例。這幾個(gè)方法很簡(jiǎn)單，我們就不在這多費(fèi)時(shí)間了，然后跳進(jìn)IInsert里，看一看里面有哪些方法吧。

先來(lái)這樣一組方法：

IInsert<T1> AppendData(T1 source); IInsert<T1> AppendData(T1[] source); IInsert<T1> AppendData(IEnumerable<T1> source);

這些方法可以后續(xù)為IInsert繼續(xù)添加數(shù)據(jù)，以便執(zhí)行更多的插入。

IInsert<T1> IgnoreColumns(string[] columns); IInsert<T1> IgnoreColumns(Expression<Func<T1, object>> columns);

設(shè)置在插入過(guò)程中忽略的列，設(shè)置之后這些列將不會(huì)插入到數(shù)據(jù)庫(kù)中。其中 Expression<Func<T1, object>>表示一個(gè)包含列名屬性的匿名對(duì)象。

IInsert<T1> InsertColumns(string[] columns); IInsert<T1> InsertColumns(Expression<Func<T1, object>> columns);

設(shè)置只插入這些列，其他的列將不會(huì)被插入。

通過(guò)調(diào)用以下方法將執(zhí)行插入：

int ExecuteAffrows();// 返回受影響的列 long ExecuteIdentity();// 返回自增主鍵值

這個(gè)方法需要實(shí)體類(lèi)的主鍵標(biāo)記為自增（這部分內(nèi)容見(jiàn)下一節(jié)）。如果啟用了批量插入模式，該值將返回最后一個(gè)數(shù)據(jù)的主鍵值。

List<T1> ExecuteInserted();// 返回插入后的數(shù)據(jù)

這個(gè)方法官方標(biāo)注只在Postgresql/SqlServer有效果。

這是插入基本內(nèi)容，相對(duì)而言插入比較簡(jiǎn)單。

2.2 刪除

這次換個(gè)順序，因?yàn)閯h除的方法在這里相對(duì)簡(jiǎn)單一些。FreeSql對(duì)于單表的數(shù)據(jù)刪除相對(duì)克制而謹(jǐn)慎。那么就讓我們簡(jiǎn)單看一下如何進(jìn)行刪除吧。

IDelete<T1> Delete<T1>() where T1 : class;

設(shè)置泛型類(lèi)型，創(chuàng)建一個(gè)刪除器（我給起的名，官方?jīng)]給起名，也就是一個(gè)IDelete接口實(shí)例）。

IDelete<T1> Delete<T1>(object dywhere) where T1 : class;

這個(gè)方法很有意思，支持的相當(dāng)廣泛。

以下是官方給的注釋：

主鍵值 | new[]{主鍵值1,主鍵值2} | TEntity1 | new[]{TEntity1,TEntity2} |new{id=1}

根據(jù)實(shí)際表現(xiàn)來(lái)看，會(huì)刪除對(duì)應(yīng)主鍵的數(shù)據(jù)。如果傳入的是實(shí)體的話(huà)，會(huì)自動(dòng)分析對(duì)應(yīng)實(shí)體的主鍵，然后把這個(gè)數(shù)據(jù)標(biāo)記為待刪除。

記住這種方式，因?yàn)樵诤罄m(xù)的Update中會(huì)用到。

IFreeSql中的刪除都不會(huì)立即刪除，都會(huì)返回一個(gè)IDelete實(shí)例，與IInsert一樣需要手動(dòng)調(diào)用ExcuteXXX方法。

那么我們來(lái)看一下IDelete里的方法：

IDelete<T1> Where(Expression<Func<T1, bool>> exp); IDelete<T1> Where(string sql, object parms = null); IDelete<T1> Where(T1 item); IDelete<T1> Where(IEnumerable<T1> items);

簡(jiǎn)單看一下方法，可以通過(guò)方法和參數(shù)就能知道其中含義。

需要注意的是，如果使用exp 做批量刪除的話(huà)，只能用實(shí)體類(lèi)的屬性作為條件，不能使用導(dǎo)航屬性。

使用sql語(yǔ)句的話(huà)，可以使用參數(shù)化寫(xiě)法如下：Where("id = ?id", new { id = 1 })，如果有多個(gè)條件的話(huà)sql里用and拼接。

IDelete<T1> WhereDynamic(object dywhere, bool not = false);

這里的dywhere與Delete的dywhere一樣，not 如果設(shè)置為true，則表示刪除除此之外的對(duì)象。

FreeSql在設(shè)計(jì)刪除模式時(shí)，如果在IFreeSql.Delete中傳入?yún)?shù)，后續(xù)繼續(xù)調(diào)用Where或者WhereDynamic的話(huà)，兩次是以and 的形式拼接的條件：

list = FreeSqlContext.FreeSqlConnect.Queryable<Model>().ToList(); FreeSqlContext.FreeSqlConnect.Delete<Model>(list[0]).WhereDynamic(list[2]).ExecuteAffrows(); FreeSqlContext.FreeSqlConnect.Delete<Model>(list[0]).Where(t=>t.Id > 10).ExecuteAffrows();

分別生成了如下SQL語(yǔ)句：

DELETE FROM "Model" WHERE ("Id" = 1) AND ("Id" = 11) ---------------------------- DELETE FROM "Model" WHERE ("Id" = 1) AND ("Id" > 10)

額，所以調(diào)用刪除的時(shí)候最好注意一下，因?yàn)闂l件沖突的話(huà)，可能數(shù)據(jù)不會(huì)發(fā)生任何變化。

執(zhí)行刪除：

int ExecuteAffrows();//返回被影響的行數(shù) List<T1> ExecuteDeleted();// 返回被刪除的數(shù)據(jù)，一樣只有 Postgresql/SqlServer 有效果

2.3 更新

IUpdate<T1> Update<T1>() where T1 : class; IUpdate<T1> Update<T1>(object dywhere) where T1 : class;

同樣，開(kāi)啟一個(gè)更新器（獲取一個(gè)IUpdate示例），這里dywhere與刪除支持的內(nèi)容是一樣的。不過(guò)，有一點(diǎn)不同的是：

row = FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).ExecuteAffrows();

不會(huì)有任何數(shù)據(jù)發(fā)生更改。嗯，這點(diǎn)與Delete完全不一樣。簡(jiǎn)單理解一下，在這里FreeSql只是解析了數(shù)據(jù)里的實(shí)體，但并沒(méi)有從傳入的實(shí)體解析出更新SQL語(yǔ)句。

接下來(lái)，進(jìn)入IUpdate：

IUpdate<T1> UpdateColumns(string[] columns); IUpdate<T1> UpdateColumns(Expression<Func<T1, object>> columns); IUpdate<T1> IgnoreColumns(Expression<Func<T1, object>> columns); IUpdate<T1> IgnoreColumns(string[] columns);

設(shè)置要更新的列和要忽略的列，兩者互相沖突。

示例：

row = FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).UpdateColumns(new[] { "Name" }).ExecuteAffrows();

是不是覺(jué)得歡天喜地的覺(jué)得會(huì)更新了，答案很殘酷，沒(méi)有。依舊返回0。說(shuō)到這里了，FreeSql在更新上，需要額外指定更新的數(shù)據(jù)來(lái)源：

IUpdate<T1> SetSource(T1 source); IUpdate<T1> SetSource(IEnumerable<T1> source);

也就是，FreeSql會(huì)從source解析出需要更新的字段，然后使用Update/Ignore來(lái)設(shè)置只更新或忽略哪些列。

最終示例：

row = FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).SetSource(list[0]).UpdateColumns(new[] { "Name" }).ExecuteAffrows(); row = FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows(); row = FreeSqlContext.FreeSqlConnect.Update<Model>(new[] { list[0] ,list[1]}).SetSource(list[0]).UpdateColumns(new[] { "Name" }).ExecuteAffrows(); row = FreeSqlContext.FreeSqlConnect.Update<Model>(new[] { list[0], list[1] }).SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();

然后生成如下SQL：

UPDATE "Model" SET "Name" = @p_0 WHERE ("Id" = 1) AND ("Id" = 1) -------------------------- UPDATE "Model" SET "Name" = CASE "Id" WHEN 1 THEN @p_0 WHEN 10 THEN @p_1 WHEN 11 THEN @p_2 WHEN 12 THEN @p_3 WHEN 13 THEN @p_4 WHEN 14 THEN @p_5 WHEN 15 THEN @p_6 WHEN 16 THEN @p_7 WHEN 17 THEN @p_8 WHEN 18 THEN @p_9 WHEN 19 THEN @p_10 WHEN 20 THEN @p_11 WHEN 21 THEN @p_12 WHEN 22 THEN @p_13 WHEN 23 THEN @p_14 WHEN 24 THEN @p_15 END WHERE ("Id" IN (1,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24)) AND ("Id" = 1) -------------------- UPDATE "Model" SET "Name" = @p_0 WHERE ("Id" = 1) AND ("Id" = 1 OR "Id" = 10) -------------------- UPDATE "Model" SET "Name" = CASE "Id" WHEN 1 THEN @p_0 WHEN 10 THEN @p_1 WHEN 11 THEN @p_2 WHEN 12 THEN @p_3 WHEN 13 THEN @p_4 WHEN 14 THEN @p_5 WHEN 15 THEN @p_6 WHEN 16 THEN @p_7 WHEN 17 THEN @p_8 WHEN 18 THEN @p_9 WHEN 19 THEN @p_10 WHEN 20 THEN @p_11 WHEN 21 THEN @p_12 WHEN 22 THEN @p_13 WHEN 23 THEN @p_14 WHEN 24 THEN @p_15 END WHERE ("Id" IN (1,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24)) AND ("Id" = 1 OR "Id" = 10)

可以看出，如果在生成IUpdate實(shí)例的時(shí)候，傳入數(shù)據(jù)再使用SetSource進(jìn)行更新會(huì)比較詭異。所以SetSource的正常使用方式是，獲取IUpdate實(shí)例的時(shí)候，不傳dywhere，直接獲取一個(gè)空IUpdate。

那么dywhere該在什么時(shí)候使用呢？

row = FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).Set(t => t.StringLength + 1).ExecuteAffrows();

通過(guò)調(diào)用Set/SetDto/SetIf三種方法進(jìn)行更新，當(dāng)然了這三種方法并不局限于使用了dywhere參數(shù)。

IUpdate<T1> Set<TMember>(Expression<Func<T1, TMember>> exp); IUpdate<T1> Set<TMember>(Expression<Func<T1, TMember>> column, TMember value); IUpdate<T1> SetDto(object dto); IUpdate<T1> SetIf<TMember>(bool condition, Expression<Func<T1, TMember>> exp); IUpdate<T1> SetIf<TMember>(bool condition, Expression<Func<T1, TMember>> column, TMember value);

其中：

• Expression<Func<T1, TMember>> exp 表示在字段本身值的基礎(chǔ)上進(jìn)行操作
• Expression<Func<T1, TMember>> column, TMember value 表示將 column設(shè)置 value
• object dto 一個(gè)包含要更新屬性和值的匿名類(lèi)，或者一個(gè)字典類(lèi)型（鍵為要更新的列，值為對(duì)應(yīng)列的值）
• bool condition 表示滿(mǎn)足條件則更新，否則將不進(jìn)行更新

IUpdate也提供了Where模式：

IUpdate<T1> Where(Expression<Func<T1, bool>> exp); IUpdate<T1> Where(string sql, object parms = null); IUpdate<T1> Where(T1 item); IUpdate<T1> Where(IEnumerable<T1> items); IUpdate<T1> WhereDynamic(object dywhere, bool not = false);

最終更新應(yīng)該如下：

FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).Set(t => t.StringLength + 1).ExecuteAffrows(); FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).SetDto(new { Name="測(cè)試2" }).ExecuteAffrows(); FreeSqlContext.FreeSqlConnect.Update<Model>(list[0]).SetIf(true, t => t.Name + 1).ExecuteAffrows(); // 或者以下模式 FreeSqlContext.FreeSqlConnect.Update<Model>().Where(t => true).Set(t => t.StringLength + 1).ExecuteAffrows(); // 或者 FreeSqlContext.FreeSqlConnect.Update<Model>(1).Set(t => t.StringLength + 1).ExecuteAffrows();

執(zhí)行更新：

int ExecuteAffrows();// 返回受影響的行數(shù) List<T1> ExecuteUpdated();// 嗯， 只有 Postgresql/SqlServer 有效果

2.4 查詢(xún)

FreeSql的查詢(xún)有兩種方式，一種是使用FreeSql的ISelect方法，一種是使用擴(kuò)展出來(lái)的Queryable方法，兩者最終返回是一樣的，均返回了一個(gè)ISelect實(shí)例。

那先來(lái)悄悄看一下兩個(gè)方法的聲明吧：

ISelect<T1> Select<T1>() where T1 : class; ISelect<T1> Select<T1>(object dywhere) where T1 : class; // 擴(kuò)展方法在 FreeSqlGlobalExtensions 類(lèi) public static ISelect<T> Queryable<T>(this IFreeSql freesql) where T : class;

其中有一個(gè)閃閃放光的 dywhere，與Update/Delete一樣，也是通過(guò)傳入的屬性解析到主鍵值獲取對(duì)應(yīng)的數(shù)據(jù)。

那么進(jìn)入ISelect一探究竟吧：

暫且忽略多個(gè)泛型支持的方法：

T1 First() TDto First<TDto>(); TReturn First<TReturn>(Expression<Func<T1, TReturn>> select); T1 ToOne(); TDto ToOne<TDto>(); TReturn ToOne<TReturn>(Expression<Func<T1, TReturn>> select);

• First和ToOne都是返回第一條數(shù)據(jù)
• TDto 表示要查詢(xún)出來(lái)的字段合集，列名與數(shù)據(jù)表中一一對(duì)應(yīng)
• Expression<Func<T1, TReturn>> select 類(lèi)型投影，通過(guò)lambda語(yǔ)句建立T1到TReturn之間的關(guān)系

返回多個(gè)：

List<T1> ToList(bool includeNestedMembers = false); List<TDto> ToList<TDto>(); List<TReturn> ToList<TReturn>(Expression<Func<T1, TReturn>> select);

• includeNestedMembers ： false: 返回 2級(jí) LeftJoin/InnerJoin/RightJoin 對(duì)象；true: 返回所有 LeftJoin/InnerJoin/RightJoin的導(dǎo)航數(shù)據(jù)

其他方法：

long Count();// 返回?cái)?shù)目 ISelect<T1> Distinct();//去重 ISelect<T1> Skip(int offset);// 忽略幾個(gè) ISelect<T1> Take(int limit);// 獲取前幾個(gè) ISelect<T1> OrderBy<TMember>(Expression<Func<T1, TMember>> column);// 排序 ISelect<T1> OrderBy<TMember>(bool condition, Expression<Func<T1, TMember>> column);// 排序 ISelect<T1> OrderByDescending<TMember>(Expression<Func<T1, TMember>> column); // 降序 ISelect<T1> OrderByDescending<TMember>(bool condition, Expression<Func<T1, TMember>> column);// 降序 decimal Sum<TMember>(Expression<Func<T1, TMember>> column);// 求和 double Avg<TMember>(Expression<Func<T1, TMember>> column);// 求平均數(shù)

設(shè)置查詢(xún)條件：

ISelect<T1> Where(Expression<Func<T1, bool>> exp); ISelect<T1> WhereIf(bool condition, Expression<Func<T1, bool>> exp); ISelect<T1> Where(string sql, object parms = null);

注意與dywhere之間是并列關(guān)系。

關(guān)于查詢(xún)FreeSql做了很多優(yōu)化，更多內(nèi)容可以查閱官方文檔。到目前為止，這些方法已經(jīng)可以滿(mǎn)足一個(gè)項(xiàng)目的使用了。

3. 總結(jié)

FreeSql可以說(shuō)結(jié)合了很多優(yōu)秀的ORM框架內(nèi)容，而且針對(duì)不同的方式分成了不同的插件形式，使主干可以輕裝上陣。

這是官方文檔中關(guān)于不同使用習(xí)慣的介紹。

關(guān)于FreeSql的基礎(chǔ)內(nèi)容就到這里了，如果對(duì)FreeSql有更多的需求的話(huà)，可以踴躍吐槽哦~~如果有小伙伴還想看的話(huà)，我將會(huì)繼續(xù)為大家講解的。

至此，2020-5-28 《C# 數(shù)據(jù)操作系列》暫時(shí) 完結(jié)（如果后續(xù)有其他好的ORM的話(huà)，還會(huì)繼續(xù)更新的）。

更多內(nèi)容煩請(qǐng)關(guān)注我的博客《高先生小屋》

總結(jié)

以上是生活随笔為你收集整理的c# emnu 获取注释_C# 数据操作系列 - 19 FreeSql 入坑介绍的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。