C# 数据操作系列 - 19 FreeSql 入坑介绍

冬晨暖雾 發表於 2020-5-29 11:46:00

C# 数据操作系列 - 19 FreeSql 入坑介绍

<h1 id="0-前言">0. 前言</h1>
<blockquote>
前几天FreeSql的作者向我推荐了FreeSql框架，想让我帮忙写个文章介绍一下。嗯，想不到我也能带个货了。哈哈，开个玩笑～看了下觉得设计的挺有意思的，所以就谢了这篇文章。
</blockquote>
简单介绍一下，FreeSql 是NCC组织的沙盒级项目，是一款功能强大的 ORM 组件，支持 .NET Core、.NET Framework 和 Xamarin。目前 FreeSql 支持以下数据库：MySQL、PostgreSQL、SqlServer、Oracle、Sqlite、Odbc、微软 Access 以及国产数据库达梦。
也就是说也是一个由国内优秀开发者维护的优秀项目，初步看了下功能很齐全。小伙伴们有时间可以取瞅瞅。下图是我从它GitHub仓库里复制过来的。可以看见支持的功能还是相当多的。
<img src="https://img2020.cnblogs.com/other/1266612/202005/1266612-20200529114532217-2099337004.png">
<blockquote>
关于NCC社区，是.net core的一个开源社区，也是国内最大的.net core开源社区
</blockquote>
<h1 id="1-初步使用">1. 初步使用</h1>
照例，没安装就没有调用。所以，在创建项目之后，安装一下吧：
<pre><code class="language-bash">dotnet add package FreeSql
</code></pre>
然后创建一个IFreeSql对象：
<pre><code class="language-c#">public class FreeSqlContext
{
public static IFreeSql FreeSqlConnect { get; } =
 new FreeSql.FreeSqlBuilder() .UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=document.db")
 .UseAutoSyncStructure(true) //自动同步实体结构到数据库
 .Build();
}
</code></pre>
因为官方要求将IFreeSql对象声明为单例模式，所以我在这里使用了静态属性。
<blockquote>
这种写法是C#的一种语法糖，只有get表示该属性是一个只能读的属性（与只读属性有个微妙的差距），等号后面表示该属性第一次赋值的内容。
</blockquote>
创建一个普通的Model类：
<pre><code class="language-c#">public class Model
{
public int Id { get; set; }
public int StringLength { get; set; }
public string Name { get; set; }
}
</code></pre>
<h2 id="11-简单插入">1.1 简单插入</h2>
然后试一下插入数据：
<pre><code class="language-c#">var row = FreeSqlContext.FreeSqlConnect.Insert(new Model
{
Name = "测试",
StringLength = 10
}).ExecuteAffrows();

</code></pre>
<img src="https://img2020.cnblogs.com/other/1266612/202005/1266612-20200529114532487-882993465.png">
提示如图内容，需要我们手动安装一下FreeSql的SQLite驱动，安装之后：
<pre><code class="language-bash">dotnet add packages FreeSql.Provider.Sqlite
</code></pre>
FreeSql针对各种受支持的数据库都单独开发了驱动包，统一命名为：
<pre><code class="language-c#">FreeSql.Provider.<数据库类型>
</code></pre>
安装完成后，重新运行后顺利完成执行，顺便帮你把数据库也生成好了（这一点我感觉挺好的），同时生成了一个主键为Id的Model表：
<pre><code class="language-sql">create table Model
(
Id INTEGER
 primary key,
StringLength INTEGER not null,
Name NVARCHAR(255)
);
</code></pre>
<h2 id="12-简单查询">1.2 简单查询</h2>
接下来简单的查询一下刚刚插入的数据：
<pre><code class="language-c#">var list = FreeSqlContext.FreeSqlConnect.Queryable<Model>().ToList();
</code></pre>
可以发现，查询使用还是非常方便的。
<h2 id="13-简单更新">1.3 简单更新</h2>
FreeSql的更新与其他框架相比略显复杂，这里先展示一种更新方式：
<pre><code class="language-c#">list.Name = "修改测试";
row = FreeSqlContext.FreeSqlConnect.Update<Model>().SetSource(list).ExecuteAffrows();
</code></pre>
先声明要更新的类型是Model，然后设置更新源。
<h2 id="14-简单删除">1.4 简单删除</h2>
<pre><code class="language-c#">row = FreeSqlContext.FreeSqlConnect.Delete<Model>(new[] { list }).ExecuteAffrows();
</code></pre>
删除之前获取的数据。
简单的看，FreeSql设计的增删改查都是以命令的形式进行的，在实际调用ExcuteXXX之前数据并不会保存到数据库中。
<h1 id="2-增删改查详解">2. 增删改查详解</h1>
在上一节中我们简单的使用了一下增删改查，这一节将为大家详细分析一下FreeSql的增删改查。
<h2 id="21-新增">2.1 新增</h2>
<pre><code class="language-c#">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;
</code></pre>
这是IFreeSql接口里声明的Insert方法，通过方法我们可以看到插入单数据插入以及多数据插入，并且返回一个IInsert<T1>的接口。当然也可以不传入数据直接获取一个IInsert接口实例。这几个方法很简单，我们就不在这多费时间了，然后跳进IInsert里，看一看里面有哪些方法吧。
先来这样一组方法：
<pre><code class="language-c#">IInsert<T1> AppendData(T1 source);
IInsert<T1> AppendData(T1[] source);
IInsert<T1> AppendData(IEnumerable<T1> source);
</code></pre>
这些方法可以后续为IInsert继续添加数据，以便执行更多的插入。
<pre><code class="language-c#">IInsert<T1> IgnoreColumns(string[] columns);
IInsert<T1> IgnoreColumns(Expression<Func<T1, object>> columns);
</code></pre>
设置在插入过程中忽略的列，设置之后这些列将不会插入到数据库中。其中 <code>Expression<Func<T1, object>></code>表示一个包含列名属性的匿名对象。
<pre><code class="language-c#">IInsert<T1> InsertColumns(string[] columns);
IInsert<T1> InsertColumns(Expression<Func<T1, object>> columns);
</code></pre>
设置只插入这些列，其他的列将不会被插入。
通过调用以下方法将执行插入：
<pre><code class="language-c#">int ExecuteAffrows();// 返回受影响的列
</code></pre>
<pre><code class="language-c#">long ExecuteIdentity();// 返回自增主键值
</code></pre>
这个方法需要实体类的主键标记为自增（这部分内容见下一节）。如果启用了批量插入模式，该值将返回最后一个数据的主键值。
<pre><code class="language-c#">List<T1> ExecuteInserted();// 返回插入后的数据
</code></pre>
这个方法官方标注只在Postgresql/SqlServer有效果。
这是插入基本内容，相对而言插入比较简单。
<h2 id="22-删除">2.2 删除</h2>
这次换个顺序，因为删除的方法在这里相对简单一些。FreeSql对于单表的数据删除相对克制而谨慎。那么就让我们简单看一下如何进行删除吧。
<pre><code class="language-c#">IDelete<T1> Delete<T1>() where T1 : class;
</code></pre>
设置泛型类型，创建一个删除器（我给起的名，官方没给起名，也就是一个IDelete接口实例）。
<pre><code class="language-c#">IDelete<T1> Delete<T1>(object dywhere) where T1 : class;
</code></pre>
这个方法很有意思，支持的相当广泛。
以下是官方给的注释：
<pre><code class="language-c#">主键值 | new[]{主键值1,主键值2} | TEntity1 | new[]{TEntity1,TEntity2} |new{id=1}
</code></pre>
根据实际表现来看，会删除对应主键的数据。如果传入的是实体的话，会自动分析对应实体的主键，然后把这个数据标记为待删除。
<blockquote>
记住这种方式，因为在后续的Update中会用到。
</blockquote>
IFreeSql中的删除都不会立即删除，都会返回一个IDelete实例，与IInsert一样需要手动调用ExcuteXXX方法。
那么我们来看一下IDelete里的方法：
<pre><code class="language-c#">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);
</code></pre>
简单看一下方法，可以通过方法和参数就能知道其中含义。
需要注意的是，如果使用exp 做批量删除的话，只能用实体类的属性作为条件，不能使用导航属性。
使用sql语句的话，可以使用参数化写法如下：<code>Where("id = ?id", new { id = 1 })</code>，如果有多个条件的话sql里用and拼接。
<pre><code class="language-c#">IDelete<T1> WhereDynamic(object dywhere, bool not = false);
</code></pre>
这里的dywhere与Delete的dywhere一样，not 如果设置为true，则表示删除除此之外的对象。
FreeSql在设计删除模式时，如果在IFreeSql.Delete中传入参数，后续继续调用Where或者WhereDynamic的话，两次是以and 的形式拼接的条件：
<pre><code class="language-c#">list = FreeSqlContext.FreeSqlConnect.Queryable<Model>().ToList();
FreeSqlContext.FreeSqlConnect.Delete<Model>(list).WhereDynamic(list).ExecuteAffrows();
FreeSqlContext.FreeSqlConnect.Delete<Model>(list).Where(t=>t.Id > 10).ExecuteAffrows();
</code></pre>
分别生成了如下SQL语句：
<pre><code class="language-sql">DELETE FROM "Model" WHERE ("Id" = 1) AND ("Id" = 11)
----------------------------
DELETE FROM "Model" WHERE ("Id" = 1) AND ("Id" > 10)
</code></pre>
额，所以调用删除的时候最好注意一下，因为条件冲突的话，可能数据不会发生任何变化。
执行删除：
<pre><code class="language-c#">int ExecuteAffrows();//返回被影响的行数
List<T1> ExecuteDeleted();// 返回被删除的数据，一样只有 Postgresql/SqlServer 有效果
</code></pre>
<h2 id="23-更新">2.3 更新</h2>
<pre><code class="language-c#">IUpdate<T1> Update<T1>() where T1 : class;
IUpdate<T1> Update<T1>(object dywhere) where T1 : class;
</code></pre>
同样，开启一个更新器（获取一个IUpdate示例），这里dywhere与删除支持的内容是一样的。不过，有一点不同的是：
<pre><code class="language-c#">row = FreeSqlContext.FreeSqlConnect.Update<Model>(list).ExecuteAffrows();
</code></pre>
不会有任何数据发生更改。嗯，这点与Delete完全不一样。简单理解一下，在这里FreeSql只是解析了数据里的实体，但并没有从传入的实体解析出更新SQL语句。
接下来，进入IUpdate：
<pre><code class="language-c#">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);
</code></pre>
设置要更新的列和要忽略的列，两者互相冲突。
示例：
<pre><code class="language-c#">row = FreeSqlContext.FreeSqlConnect.Update<Model>(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();
</code></pre>
是不是觉得欢天喜地的觉得会更新了，答案很残酷，没有。依旧返回0。说到这里了，FreeSql在更新上，需要额外指定更新的数据来源：
<pre><code class="language-c#">IUpdate<T1> SetSource(T1 source);
IUpdate<T1> SetSource(IEnumerable<T1> source);
</code></pre>
也就是，FreeSql会从source解析出需要更新的字段，然后使用Update/Ignore来设置只更新或忽略哪些列。
最终示例：
<pre><code class="language-c#">row = FreeSqlContext.FreeSqlConnect.Update<Model>(list)
.SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();
row = FreeSqlContext.FreeSqlConnect.Update<Model>(list)
.SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();
row = FreeSqlContext.FreeSqlConnect.Update<Model>(new[] { list ,list})
.SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();
row = FreeSqlContext.FreeSqlConnect.Update<Model>(new[] { list, list })
.SetSource(list).UpdateColumns(new[] { "Name" }).ExecuteAffrows();
</code></pre>
然后生成如下SQL：
<pre><code class="language-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)
</code></pre>
可以看出，如果在生成IUpdate实例的时候，传入数据再使用SetSource进行更新会比较诡异。所以SetSource的正常使用方式是，获取IUpdate实例的时候，不传dywhere，直接获取一个空IUpdate。
那么dywhere该在什么时候使用呢？
<pre><code class="language-c#">row = FreeSqlContext.FreeSqlConnect.Update<Model>(list).Set(t => t.StringLength + 1).ExecuteAffrows();
</code></pre>
通过调用Set/SetDto/SetIf三种方法进行更新，当然了这三种方法并不局限于使用了dywhere参数。
<pre><code class="language-c#">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);
</code></pre>
其中：
<ul>
<li>Expression<Func<T1, TMember>> exp表示在字段本身值的基础上进行操作</li>
<li>Expression<Func<T1, TMember>> column, TMember value 表示将 column设置 value</li>
<li>object dto一个包含要更新属性和值的匿名类，或者一个字典类型（键为要更新的列，值为对应列的值）</li>
<li>bool condition 表示满足条件则更新，否则将不进行更新</li>
</ul>
IUpdate也提供了Where模式：
<pre><code class="language-c#">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);
</code></pre>
最终更新应该如下：
<pre><code class="language-c#">FreeSqlContext.FreeSqlConnect.Update<Model>(list).Set(t => t.StringLength + 1).ExecuteAffrows();
FreeSqlContext.FreeSqlConnect.Update<Model>(list).SetDto(new { Name="测试2" }).ExecuteAffrows();
FreeSqlContext.FreeSqlConnect.Update<Model>(list).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();
</code></pre>
执行更新：
<pre><code class="language-c#">int ExecuteAffrows();// 返回受影响的行数
List<T1> ExecuteUpdated();// 嗯，只有 Postgresql/SqlServer 有效果
</code></pre>
<h2 id="24-查询">2.4 查询</h2>
FreeSql的查询有两种方式，一种是使用FreeSql的ISelect方法，一种是使用扩展出来的Queryable方法，两者最终返回是一样的，均返回了一个ISelect实例。
那先来悄悄看一下两个方法的声明吧：
<pre><code class="language-c#">ISelect<T1> Select<T1>() where T1 : class;
ISelect<T1> Select<T1>(object dywhere) where T1 : class;
// 扩展方法在FreeSqlGlobalExtensions 类
public static ISelect<T> Queryable<T>(this IFreeSql freesql) where T : class;
</code></pre>
其中有一个闪闪放光的 dywhere，与Update/Delete一样，也是通过传入的属性解析到主键值获取对应的数据。
那么进入ISelect一探究竟吧：
暂且忽略多个泛型支持的方法：
<pre><code class="language-c#">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);
</code></pre>
<ul>
<li>First和ToOne都是返回第一条数据</li>
<li>TDto 表示要查询出来的字段合集，列名与数据表中一一对应</li>
<li>Expression<Func<T1, TReturn>> select 类型投影，通过lambda语句建立T1到TReturn之间的关系</li>
</ul>
返回多个：
<pre><code class="language-c#">List<T1> ToList(bool includeNestedMembers = false);
List<TDto> ToList<TDto>();
List<TReturn> ToList<TReturn>(Expression<Func<T1, TReturn>> select);
</code></pre>
<ul>
<li>includeNestedMembers ： false: 返回 2级 LeftJoin/InnerJoin/RightJoin 对象；true: 返回所有 LeftJoin/InnerJoin/RightJoin的导航数据</li>
</ul>
其他方法：
<pre><code class="language-c#">long Count();// 返回数目
ISelect<T1> Distinct();//去重
ISelect<T1> Skip(int offset);// 忽略几个
ISelect<T1> Take(int limit);// 获取前几个
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);// 求平均数
</code></pre>
设置查询条件：
<pre><code class="language-c#">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);
</code></pre>
注意与dywhere之间是并列关系。
关于查询FreeSql做了很多优化，更多内容可以查阅官方文档。到目前为止，这些方法已经可以满足一个项目的使用了。
<h1 id="3-总结">3. 总结</h1>
FreeSql可以说结合了很多优秀的ORM框架内容，而且针对不同的方式分成了不同的插件形式，使主干可以轻装上阵。
<img src="https://img2020.cnblogs.com/other/1266612/202005/1266612-20200529114532682-1579997770.png">
这是官方文档中关于不同使用习惯的介绍。
关于FreeSql的基础内容就到这里了，如果对FreeSql有更多的需求的话，可以踊跃吐槽哦~~如果有小伙伴还想看的话，我将会继续为大家讲解的。
至此，2020-5-28 《C# 数据操作系列》暂时 完结（如果后续有其他好的ORM的话，还会继续更新的）。
<blockquote>
更多内容烦请关注我的博客《高先生小屋》
</blockquote>
<img src="https://img2020.cnblogs.com/other/1266612/202005/1266612-20200529114532984-1514074843.png"> 
来源：https://www.cnblogs.com/c7jie/p/12986598.html

頁: [1]

琼殿技术论坛's Archiver

C# 数据操作系列 - 19 FreeSql 入坑介绍