FreeSql aop功能介紹

前言

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!

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章