FreeSql aop功能介绍

Posted 2021-12-03 kellynic

前言

FreeSql 是一个功能强大的 .NETStandard 库，用于对象关系映射程序(O/RM)，支持 .NETCore 2.1+ 或 .NETFramework 4.6.1+（QQ群：4336577）。

据了解，用户使用很少问问题，编码过程中，因业务阻塞，情有可原；因框架使用问题阻塞，得不偿失。我们的口号：做 .net 最方便的 ORM！愿每一位开发者嘴角上扬??！

整体功能

• IFreeSql 是核心，提供原始用法；

• FreeSql.DbContext 是扩展包，提供面向对象的用法（像EF）；

• FreeSql.Repository 也是扩展包，提供仓储+工作单元用法（实际上和 DbContext 是一个扩展包）；

• FreeSql.Connection.Extensions 也是扩展包，提供像 Dapper 一样的用法；

源码地址：https://github.com/2881099/FreeSql，可从这里链向上面介绍的各个仓库。

fsql= new FreeSql.FreeSqlBuilder()
    .UseConnectionString(FreeSql.DataType.Sqlite, @"Data Source=|DataDirectory|\document.db;Attachs=xxxtb.db;Pooling=true;Max Pool Size=10")
    .UseAutoSyncStructure(true) //自动迁移(CodeFirst)
    .Build();

AOP 功能

今天上场的是 AOP 已有的功能介绍，未来为会根据用户需求不断增强。

审计 CRUD

马云说过，996是修福报。对于多数程序员来说，加班是好事。。。起码不是闲人，不会下岗。

当如果因为某个 sql 骚操作耗时很高，没有一个相关的审计功能，排查起来可以说无从下手。

FreeSql 支持简单的类似功能：

fsql.Aop.CurdAfter = (s, e) => {
    if (e.ElapsedMilliseconds > 200) {
        //记录日志
        //发送短信给负责人
    }
};

是的，只需要一个事件，就可以对全局起到作用。

除了 CurdAfter，还有一个 CurdBefore （在执行 sql 之前触发）。

审计迁移脚本

FreeSql 自带迁移功能，那么迁移的 SQL 语句长啥样，你可能会好奇。

• 比如创建表时；

• 比如添加字段时；

• 比如修改表名、修改字段名时；

• 又比如字段类型更改之后时；

这些操作在 FreeSql.CodeFirst 实现下基本不需要理会，而且我们只推荐在开发环境使用自动迁移的功能，正式环境可使用其他工具替代此操作。

但我们仍然可能需要对项目做完整的日志记录。

fsql.Aop.SyncStructureBefore、fsql.Aop.SyncStructureAfter 这两个事件将排上用场。

自定义实体特性

比如项目内已经使用了其它 orm，如 efcore，这样意味着实体中可能存在 [Key]，但它与 FreeSql [Column(IsPrimary = true] 不同。

Q： FreeSql 实体特性为啥这么别扭？

A： 为了考虑一致性用法，全部封装在 ColumnAttribute 下，这样用户使用起来，不用到处 using 或者 回忆特性应该用哪个名字，如自增 [Column(IsIdentity = true)] 即可。

FreeSql 提供 AOP 自定义特性功能，实现与多个 orm 共同拥有一套实体特性，可避免重复定义特性。

fsql.Aop.ConfigEntity = (s, e) => {
    var attr = e.EntityType.GetCustomAttributes(
        typeof(System.ComponentModel.DataAnnotations.Schema.TableAttribute), false).FirstOrDefault() 
        as System.ComponentModel.DataAnnotations.Schema.TableAttribute;
    if (attr != null)
        e.ModifyResult.Name = attr.Name; //表名
};

fsql.Aop.ConfigEntityProperty = (s, e) => {
  if (e.Property.GetCustomAttributes(
    typeof(System.ComponentModel.DataAnnotations.KeyAttribute), false).Any())
        e.ModifyResult.IsPrimary = true; //主键
};

就这样，FreeSql 的实体特性就可以和 EFCore 那样设定了。其他自增、乐观锁等，依葫芦画瓢便是。

自定义表达式

FreeSql 内部表达式支持非常丰富，对各大数据库的兼容度也做得很好。

有关表达式支持到的程度，可点击查看详细wiki：https://github.com/2881099/FreeSql/wiki/%E8%A1%A8%E8%BE%BE%E5%BC%8F%E5%87%BD%E6%95%B0

即便如此丰富，也仍然无法满足用户需求，FreeSql 对外开放了自定义表达式解析接口：

fsql.Aop.ParseExpression = (s, e) => {
    if (e.Expression.NodeType == Call && e.Expression.Name == "get_Item")
        e.Result = "1111";
};

这个解析有点复杂，当 e.Expression 很复杂的时候，我们还提供了 e.FreeParse 方法，使用它相当于调用 FreeSql 内置表达式解析引擎，辅助您进行解析。

Aop.Where

FreeSql 提供的 ISelect、IDelete、IUpdate 三大对象，都可以使用 .Where(lambda) 操作，也可以是 .Where(sql) 操作。

Aop.Where 的定位是可拦截 Where 条件。

fsql.Aop.Where = (s, e) => {
    if (e.Parameter[0]?.ToString() == "1")
        e.IsCancel = true;
};

Aop.ToList

监控 ToList 返回的的数据，用于拦截重新装饰。

所有通过 FreeSql.Select 查询返回的时候，都可以在这个事件上进行重新装饰。

未完待续

下载地址：https://github.com/2881099/FreeSql

优势：5种数据库支持彻底，1500+单元测试，文档功能齐全

欢迎更多人加入我们阵营！我们一起做 .NETCore 最方便的 ORM！