天天看點
傳回

C# 資料操作系列 - 19 FreeSql 入坑介紹

C# 資料操作系列 - 19 FreeSql 入坑介紹

  1. 前言

    前幾天FreeSql的作者向我推薦了FreeSql架構，想讓我幫忙寫個文章介紹一下。嗯，想不到我也能帶個貨了。哈哈，開個玩笑～看了下覺得設計的挺有意思的，是以就謝了這篇文章。

簡單介紹一下，FreeSql 是NCC組織的沙盒級項目，是一款功能強大的 ORM 元件，支援 .NET Core、.NET Framework 和 Xamarin。目前 FreeSql 支援以下資料庫：MySQL、PostgreSQL、SqlServer、Oracle、Sqlite、Odbc、微軟 Access 以及國産資料庫達夢。

也就是說也是一個由國内優秀開發者維護的優秀項目，初步看了下功能很齊全。小夥伴們有時間可以取瞅瞅。下圖是我從它GitHub倉庫裡複制過來的。可以看見支援的功能還是相當多的。

關于NCC社群，是.net core的一個開源社群，也是國内最大的.net core開源社群

  1. 初步使用

    照例，沒安裝就沒有調用。是以，在建立項目之後，安裝一下吧：

dotnet add package FreeSql

然後建立一個IFreeSql對象：

public class FreeSqlContext

{

public static IFreeSql FreeSqlConnect { get; } =
    new FreeSql.FreeSqlBuilder()            .UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=document.db")
    .UseAutoSyncStructure(true) //自動同步實體結構到資料庫
    .Build();

}

因為官方要求将IFreeSql對象聲明為單例模式，是以我在這裡使用了靜态屬性。

這種寫法是C#的一種文法糖，隻有get表示該屬性是一個隻能讀的屬性（與隻讀屬性有個微妙的差距），等号後面表示該屬性第一次指派的内容。

建立一個普通的Model類：

public class Model

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

1.1 簡單插入

然後試一下插入資料：

var row = FreeSqlContext.FreeSqlConnect.Insert(new Model

Name = "測試",
StringLength = 10

}).ExecuteAffrows();

提示如圖内容，需要我們手動安裝一下FreeSql的SQLite驅動，安裝之後：

dotnet add packages FreeSql.Provider.Sqlite

FreeSql針對各種受支援的資料庫都單獨開發了驅動包，統一命名為：

FreeSql.Provider.<資料庫類型>

安裝完成後，重新運作後順利完成執行，順便幫你把資料庫也生成好了（這一點我感覺挺好的），同時生成了一個主鍵為Id的Model表：

create table Model

(

Id           INTEGER
    primary key,
StringLength INTEGER not null,
Name         NVARCHAR(255)

);

1.2 簡單查詢

接下來簡單的查詢一下剛剛插入的資料：

var list = FreeSqlContext.FreeSqlConnect.Queryable().ToList();

可以發現，查詢使用還是非常友善的。

1.3 簡單更新

FreeSql的更新與其他架構相比略顯複雜，這裡先展示一種更新方式：

list[0].Name = "修改測試";

row = FreeSqlContext.FreeSqlConnect.Update().SetSource(list[0]).ExecuteAffrows();

先聲明要更新的類型是Model，然後設定更新源。

1.4 簡單删除

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

删除之前擷取的資料。

簡單的看，FreeSql設計的增删改查都是以指令的形式進行的，在實際調用ExcuteXXX之前資料并不會儲存到資料庫中。

  1. 增删改查詳解

    在上一節中我們簡單的使用了一下增删改查， 這一節将為大家詳細分析一下FreeSql的增删改查。

2.1 新增

IInsert Insert() where T1 : class;

IInsert Insert(T1 source) where T1 : class;

IInsert Insert(IEnumerable source) where T1 : class;

IInsert Insert(List source) where T1 : class;

IInsert Insert(T1[] source) where T1 : class;

這是IFreeSql接口裡聲明的Insert方法，通過方法我們可以看到插入單資料插入以及多資料插入，并且傳回一個IInsert的接口。當然也可以不傳入資料直接擷取一個IInsert接口執行個體。這幾個方法很簡單，我們就不在這多費時間了，然後跳進IInsert裡，看一看裡面有哪些方法吧。

先來這樣一組方法：

IInsert AppendData(T1 source);

IInsert AppendData(T1[] source);

IInsert AppendData(IEnumerable source);

這些方法可以後續為IInsert繼續添加資料，以便執行更多的插入。

IInsert IgnoreColumns(string[] columns);

IInsert IgnoreColumns(Expression> columns);

設定在插入過程中忽略的列，設定之後這些列将不會插入到資料庫中。其中 Expression>表示一個包含列名屬性的匿名對象。

IInsert InsertColumns(string[] columns);

IInsert InsertColumns(Expression> columns);

設定隻插入這些列，其他的列将不會被插入。

通過調用以下方法将執行插入：

int ExecuteAffrows();// 傳回受影響的列

long ExecuteIdentity();// 傳回自增主鍵值

這個方法需要實體類的主鍵标記為自增（這部分内容見下一節）。如果啟用了批量插入模式，該值将傳回最後一個資料的主鍵值。

List ExecuteInserted();// 傳回插入後的資料

這個方法官方标注隻在Postgresql/SqlServer有效果。

這是插入基本内容，相對而言插入比較簡單。

2.2 删除

這次換個順序，因為删除的方法在這裡相對簡單一些。FreeSql對于單表的資料删除相對克制而謹慎。那麼就讓我們簡單看一下如何進行删除吧。

IDelete Delete() where T1 : class;

設定泛型類型，建立一個删除器（我給起的名，官方沒給起名，也就是一個IDelete接口執行個體）。

IDelete Delete(object dywhere) where T1 : class;

這個方法很有意思，支援的相當廣泛。

以下是官方給的注釋：

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

根據實際表現來看，會删除對應主鍵的資料。如果傳入的是實體的話，會自動分析對應實體的主鍵，然後把這個資料标記為待删除。

記住這種方式，因為在後續的Update中會用到。

IFreeSql中的删除都不會立即删除，都會傳回一個IDelete執行個體，與IInsert一樣需要手動調用ExcuteXXX方法。

那麼我們來看一下IDelete裡的方法：

IDelete Where(Expression> exp);

IDelete Where(string sql, object parms = null);

IDelete Where(T1 item);

IDelete Where(IEnumerable items);

簡單看一下方法，可以通過方法和參數就能知道其中含義。

需要注意的是，如果使用exp 做批量删除的話，隻能用實體類的屬性作為條件，不能使用導航屬性。

使用sql語句的話，可以使用參數化寫法如下：Where("id = ?id", new { id = 1 })，如果有多個條件的話sql裡用and拼接。

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

這裡的dywhere與Delete的dywhere一樣，not 如果設定為true，則表示删除除此之外的對象。

FreeSql在設計删除模式時，如果在IFreeSql.Delete中傳入參數，後續繼續調用Where或者WhereDynamic的話，兩次是以and 的形式拼接的條件：

list = FreeSqlContext.FreeSqlConnect.Queryable().ToList();

FreeSqlContext.FreeSqlConnect.Delete(list[0]).WhereDynamic(list[2]).ExecuteAffrows();

FreeSqlContext.FreeSqlConnect.Delete(list[0]).Where(t=>t.Id > 10).ExecuteAffrows();

分别生成了如下SQL語句：

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

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

額，是以調用删除的時候最好注意一下，因為條件沖突的話，可能資料不會發生任何變化。

執行删除：

int ExecuteAffrows();//傳回被影響的行數

List ExecuteDeleted();// 傳回被删除的資料，一樣隻有 Postgresql/SqlServer 有效果

2.3 更新

IUpdate Update() where T1 : class;

IUpdate Update(object dywhere) where T1 : class;

同樣，開啟一個更新器（擷取一個IUpdate示例），這裡dywhere與删除支援的内容是一樣的。不過，有一點不同的是：

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

不會有任何資料發生更改。嗯，這點與Delete完全不一樣。簡單了解一下，在這裡FreeSql隻是解析了資料裡的實體，但并沒有從傳入的實體解析出更新SQL語句。

接下來，進入IUpdate：

IUpdate UpdateColumns(string[] columns);

IUpdate UpdateColumns(Expression> columns);

IUpdate IgnoreColumns(Expression> columns);

IUpdate IgnoreColumns(string[] columns);

設定要更新的列和要忽略的列，兩者互相沖突。

示例：

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

是不是覺得歡天喜地的覺得會更新了，答案很殘酷，沒有。依舊傳回0。說到這裡了，FreeSql在更新上，需要額外指定更新的資料來源：

IUpdate SetSource(T1 source);

IUpdate SetSource(IEnumerable source);

也就是，FreeSql會從source解析出需要更新的字段，然後使用Update/Ignore來設定隻更新或忽略哪些列。

最終示例：

row = FreeSqlContext.FreeSqlConnect.Update(list[0])

.SetSource(list[0]).UpdateColumns(new[] { "Name" }).ExecuteAffrows();           
.SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();

row = FreeSqlContext.FreeSqlConnect.Update(new[] { list[0] ,list[1]})

.SetSource(list[0]).UpdateColumns(new[] { "Name" }).ExecuteAffrows();

row = FreeSqlContext.FreeSqlConnect.Update(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)

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執行個體的時候，傳入資料再使用SetSource進行更新會比較詭異。是以SetSource的正常使用方式是，擷取IUpdate執行個體的時候，不傳dywhere，直接擷取一個空IUpdate。

那麼dywhere該在什麼時候使用呢？

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

通過調用Set/SetDto/SetIf三種方法進行更新，當然了這三種方法并不局限于使用了dywhere參數。

IUpdate Set(Expression> exp);

IUpdate Set(Expression> column, TMember value);

IUpdate SetDto(object dto);

IUpdate SetIf(bool condition, Expression> exp);

IUpdate SetIf(bool condition, Expression> column, TMember value);

其中：

Expression> exp 表示在字段本身值的基礎上進行操作

Expression> column, TMember value 表示将 column設定 value

object dto 一個包含要更新屬性和值的匿名類，或者一個字典類型（鍵為要更新的列，值為對應列的值）

bool condition 表示滿足條件則更新，否則将不進行更新

IUpdate也提供了Where模式：

IUpdate Where(Expression> exp);

IUpdate Where(string sql, object parms = null);

IUpdate Where(T1 item);

IUpdate Where(IEnumerable items);

IUpdate WhereDynamic(object dywhere, bool not = false);

最終更新應該如下：

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

FreeSqlContext.FreeSqlConnect.Update(list[0]).SetDto(new { Name="測試2" }).ExecuteAffrows();

FreeSqlContext.FreeSqlConnect.Update(list[0]).SetIf(true, t => t.Name + 1).ExecuteAffrows();

// 或者以下模式

FreeSqlContext.FreeSqlConnect.Update()

.Where(t => true)
            .Set(t => t.StringLength + 1)
            .ExecuteAffrows();

// 或者

FreeSqlContext.FreeSqlConnect.Update(1)

.Set(t => t.StringLength + 1)
            .ExecuteAffrows();

執行更新：

int ExecuteAffrows();// 傳回受影響的行數

List ExecuteUpdated();// 嗯， 隻有 Postgresql/SqlServer 有效果

2.4 查詢

FreeSql的查詢有兩種方式，一種是使用FreeSql的ISelect方法，一種是使用擴充出來的Queryable方法，兩者最終傳回是一樣的，均傳回了一個ISelect執行個體。

那先來悄悄看一下兩個方法的聲明吧：

ISelect Select() where T1 : class;

ISelect Select(object dywhere) where T1 : class;

// 擴充方法在 FreeSqlGlobalExtensions 類

public static ISelect Queryable(this IFreeSql freesql) where T : class;

其中有一個閃閃放光的 dywhere，與Update/Delete一樣，也是通過傳入的屬性解析到主鍵值擷取對應的資料。

那麼進入ISelect一探究竟吧：

暫且忽略多個泛型支援的方法：

T1 First()

TDto First();

TReturn First(Expression> select);

T1 ToOne();

TDto ToOne();

TReturn ToOne(Expression> select);

First和ToOne都是傳回第一條資料

TDto 表示要查詢出來的字段合集，列名與資料表中一一對應

Expression> select 類型投影，通過lambda語句建立T1到TReturn之間的關系

傳回多個：

List ToList(bool includeNestedMembers = false);

List ToList();

List ToList(Expression> select);

includeNestedMembers ： false: 傳回 2級 LeftJoin/InnerJoin/RightJoin 對象；true: 傳回所有 LeftJoin/InnerJoin/RightJoin的導航資料

其他方法：

long Count();// 傳回數目

ISelect Distinct();//去重

ISelect Skip(int offset);// 忽略幾個

ISelect Take(int limit);// 擷取前幾個

ISelect OrderBy(Expression> column);// 排序

ISelect OrderBy(bool condition, Expression> column);// 排序

ISelect OrderByDescending(Expression> column); // 降序

ISelect OrderByDescending(bool condition, Expression> column);// 降序

decimal Sum(Expression> column);// 求和

double Avg(Expression> column);// 求平均數

設定查詢條件：

ISelect Where(Expression> exp);

ISelect WhereIf(bool condition, Expression> exp);

ISelect Where(string sql, object parms = null);

注意與dywhere之間是并列關系。

關于查詢FreeSql做了很多優化，更多内容可以查閱官方文檔。到目前為止，這些方法已經可以滿足一個項目的使用了。

  1. 總結

    FreeSql可以說結合了很多優秀的ORM架構内容，而且針對不同的方式分成了不同的插件形式，使主幹可以輕裝上陣。

這是官方文檔中關于不同使用習慣的介紹。

關于FreeSql的基礎内容就到這裡了，如果對FreeSql有更多的需求的話，可以踴躍吐槽哦~~如果有小夥伴還想看的話，我将會繼續為大家講解的。

至此，2020-5-28 《C# 資料操作系列》暫時 完結（如果後續有其他好的ORM的話，還會繼續更新的）。

原文位址

https://www.cnblogs.com/c7jie/p/12986598.html
sql Oracle 關系型資料庫 mysql 資料庫連接配接 資料庫 c# postgresql 開發者 資料庫管理 cgss資料管理工作 mysql學習筆記操作資料 cgss資料管理 oracle資料管理 mysql學習筆記資料類型操作資料
上一篇: 如何在 CentOS 8 上安裝和配置 Redis
下一篇: 國内首家财務經紀公司-中稅經紀

繼續閱讀