FreeSql AOP 已有的功能介紹,未來為會根據用戶需求不斷增強。
審計 CRUD
馬雲說過,996是修福報。對於多數程序員來說,加班是好事。。。起碼不是閑人,不會下崗。
當如果因為某個 sql 騷操作耗時很高,沒有一個相關的審計功能,排查起來可以說無從下手,福報與你緊緊相隨(哈哈)。
FreeSql 支持簡單的類似功能:
fsql.Aop.CurdAfter += (s, e) => {
if (e.ElapsedMilliseconds > 200) {
//記錄日志
//發送短信給負責人
}
};
是的,只需要一個事件,就可以對全局起到作用。
除了 CurdAfter,還有一個 CurdBefore (在執行 sql 之前觸發)。
審計屬性值
實現插入/更新時統一處理某些值,比如某屬性的雪花算法值、創建時間值、甚至是業務值。
fsql.Aop.AuditValue += (s, e) => {
if (e.Column.CsType == typeof(long)
&& e.Property.GetCustomAttribute<SnowflakeAttribute>(false) != null
&& e.Value?.ToString() == 0)
e.Value = new Snowflake().GetId();
};
class Order {
[Snowflake]
public long Id { get; set; }
//...
}
當屬性的類型是 long,並且標記了 [Snowflake],並且當前值是 0,那么在插入/更新時它的值將設置為雪花id值。
說明:SnowflakeAttribute 是使用者您來定義,new Snowflake().GetId() 也是由使用者您來實現
如果命名規范,可以在 aop 里判斷,if (e.Property.Name == "createtime") e.Value = DateTime.Now;
審計遷移腳本
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 共同擁有一套實體特性,可避免重復定義特性。
v1.4.0+ 已自動識別 EFCore 實體特性 Key/Required/NotMapped/MaxLength/StringLength/DatabaseGenerated/Table/Column
fsql.Aop.ConfigEntity += (s, e) => {
var attr = e.EntityType.GetCustomAttributes(typeof(MyTableAttribute), false).FirstOrDefault() as MyTableAttribute;
if (attr != null)
e.ModifyResult.Name = attr.Name; //表名
};
fsql.Aop.ConfigEntityProperty += (s, e) => {
var attr = e.Property.GetCustomAttributes(typeof(MyColumnAttribute), false).FirstOrDefault() as MyColumnAttribute;
if (attr != null)
e.ModifyResult.Name = attr.Name; //字段名
};
[MyTable("xxx")]
class YourEntity {
[MyColumn("id")]
public int pkid { get; set; }
}
class MyTableAttribute : Attribute {
public string Name { get; }
public MyTableAttribute(string name)
{
this.Name = name;
}
}
class MyColumnAttribute : Attribute {
public string Name { get; }
public MyColumnAttribute(string name)
{
this.Name = name;
}
}
自定義表達式
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