PostSharp是一種Aspect Oriented Programming 面向切面(或面向方面)的組件框架,適用在.NET開發中,本篇主要介紹Postsharp在.NET開發中的相關知識,以及一些如日志、緩存、事務處理、異常處理等常用的切面處理操作。
AOP(Aspect-Oriented Programming)是一種將函數的輔助性功能與業務邏輯相分離的編程泛型(programming paradigm),其目的是將橫切關注點(cross-cutting concerns)分離出來,使得程序具有更高的模塊化特性。AOP是面向方面軟件開發(Aspect-Oriented Software Development)在編碼實現層面上的具體表現。
我們知道,解耦是程序員編碼開發過程中一直追求的,AOP也是為了解耦所誕生。引入AOP技術,能很大程度上簡化我們編碼,減少復制的代碼量,也便於統一維護統一的部分代碼,如日志、緩存、事務處理、異常處理等常用的處理。
1、AOP框架的介紹
1)AOP技術介紹
AOP技術利用一種稱為“橫切”的技術,剖解開封裝的對象內部,並將那些影響了多個類的公共行為封裝到一個可重用模塊,並將其名為“Aspect”,即方面。所謂“方面”,簡單地說,就是將那些與業務無關,卻為業務模塊所共同調用的邏輯或責任封裝起來,便於減少系統的重復代碼,降低模塊間的耦合度,並有利於未來的可操作性和可維護性。AOP代表的是一個橫向的關系,如果說“對象”是一個空心的圓柱體,其中封裝的是對象的屬性和行為;那么面向方面編程的方法,就仿佛一把利刃,將這些空心圓柱體剖開,以獲得其內部的消息。而剖開的切面,也就是所謂的“方面”了。然后它又以巧奪天功的妙手將這些剖開的切面復原,不留痕跡。
使用“橫切”技術,AOP把軟件系統分為兩個部分:核心關注點和橫切關注點。業務處理的主要流程是核心關注點,與之關系不大的部分是橫切關注點。橫切關注點的一個特點是,他們經常發生在核心關注點的多處,而各處都基本相似。比如權限認證、日志、事務處理。Aop 的作用在於分離系統中的各種關注點,將核心關注點和橫切關注點分離開來。正如Avanade公司的高級方案構架師Adam Magee所說,AOP的核心思想就是“將應用程序中的商業邏輯同對其提供支持的通用服務進行分離。”
2)AOP使用場景
AOP用來封裝橫切關注點,具體可以在下面的場景中使用:
Authentication 權限
Caching 緩存
Context passing 內容傳遞
Error handling 錯誤處理
Lazy loading 懶加載
Debugging 調試
logging, tracing, profiling and monitoring 記錄跟蹤 優化 校准
Performance optimization 性能優化
Persistence 持久化
Resource pooling 資源池
Synchronization 同步
Transactions 事務
3)PostSharp框架
PostSharp是一個用於在.NET平台上實現AOP的框架,是比較常用的一個AOP框架,官方網站為http://www.sharpcrafters.com。目前最新版本為4.X,但是是收費的AOP軟件。
PostSharp使用靜態織入方式實現AOP,其連接點非常豐富,使用簡單,而且相對其它一些.NET平台上的AOP框架來說,PostSharp較為輕量級,但是功能卻一點也不遜色。
總體來說,使用PostSharp,將會帶來如下優點:
- 橫切關注點單獨分離出來,提高了代碼的清晰性和可維護性。
- 只要在Aspect中編寫輔助性功能代碼,在一定程度上減少了工作量和冗余代碼。
當然,使用PostSharp也會存在一些缺點,主要缺點有如下兩方面:
- 增加了調試的難度。
- 相比於不用AOP的代碼,運行效率有所降低。
不過瑕不掩瑜,相對於這些缺點問題,使用PostSharp可以極大提高開發效率,減少重復代碼,從而提高代碼的可讀性、可維護性。
另外在GitHub上還有一些開源的AOP組件,例如排頭位的是KingAOP(https://github.com/AntyaDev/KingAOP),不過由於它采用了Dynamic的方式來實現,如它的構造對象如下所示。
dynamic helloWorld = new HelloWorld(); helloWorld.HelloWorldCall();
因此雖然比較方便,而且號稱和PostSharp使用習慣類似,但是改變了對象的創建方式,對一般項目的類對象處理並不太適合。因此我還是比較傾向於使用PostSharp來進行AOP的編程開發。
2、PostSharp框架的使用
1)准備PostSharp的編譯環境
PostSharp目前版本是4.x,我在官網下載了進行使用,不過經常發生"Error connecting to the pipe server. See previous warnings for details.",后來干脆使用了3.x版本的,反而能夠正常使用,非常不錯,呵呵。
PostSharp是一個可以安裝在VS上的插件,安裝后在VS的菜單欄目里面增加了一個PostSharp的菜單項,如下所示。
一般項目如果需要使用PostSharp特性的,在項目屬性的【PostSharp】選項頁中,使用【Add PostSharp to this project】把PostSharp加入到項目里面進行使用。
添加后,會彈出PostSharp的插件提示對話框,提示將加入相應的PostSharp包等內容,如下所示。
完成后就可以在項目中使用PostSharp的相關類了。
2)增加PostSharp的AOP切面處理
一般約定每個Aspect類的命名必須為“XXXAttribute”的形式。其中“XXX”就是這個Aspect的名字。PostSharp中提供了豐富的內置“Base Aspect”以便我們繼承,其中這里我們繼承“OnMethodBoundaryAspect ”,這個Aspect提供了進入、退出函數等連接點方法。另外,Aspect上必須設置“[Serializable] ”,這與PostSharp內部對Aspect的生命周期管理有關。
日志的Aspect類的代碼如下所示。
[Serializable] public class LogAttribute : OnMethodBoundaryAspect { public override void OnEntry(MethodExecutionArgs args) { Console.WriteLine(Environment.NewLine); Console.WriteLine("Entering [ {0} ] ...", args.Method); base.OnEntry(args); } public override void OnExit(MethodExecutionArgs args) { Console.WriteLine("Leaving [ {0} ] ...", args.Method); base.OnExit(args); } }
異常處理的類代碼如下所示。
[Serializable] public class ExceptionAttribute : OnExceptionAspect { public override void OnException(MethodExecutionArgs args) { Console.WriteLine(String.Format("Exception in :[{0}] , Message:[{1}]", args.Method, args.Exception.Message)); args.FlowBehavior = FlowBehavior.Continue; base.OnException(args); } }
計時處理的Aspect類代碼如下所示。
[Serializable] [MulticastAttributeUsage(MulticastTargets.Method)] public class TimingAttribute : PostSharp.Aspects.OnMethodBoundaryAspect { [NonSerialized] Stopwatch _StopWatch; public override void OnEntry(PostSharp.Aspects.MethodExecutionArgs args) { _StopWatch = Stopwatch.StartNew(); base.OnEntry(args); } public override void OnExit(PostSharp.Aspects.MethodExecutionArgs args) { Console.WriteLine(string.Format("[{0}] took {1}ms to execute", new StackTrace().GetFrame(1).GetMethod().Name, _StopWatch.ElapsedMilliseconds)); base.OnExit(args); } }
事務處理的Aspect類代碼如下所示。
[Serializable] [AspectTypeDependency(AspectDependencyAction.Order, AspectDependencyPosition.After, typeof(LogAttribute))] public class RunInTransactionAttribute : OnMethodBoundaryAspect { [NonSerialized] TransactionScope TransactionScope; public override void OnEntry(MethodExecutionArgs args) { this.TransactionScope = new TransactionScope(TransactionScopeOption.RequiresNew); } public override void OnSuccess(MethodExecutionArgs args) { this.TransactionScope.Complete(); } public override void OnException(MethodExecutionArgs args) { args.FlowBehavior = FlowBehavior.Continue; Transaction.Current.Rollback(); Console.WriteLine("Transaction Was Unsuccessful!"); } public override void OnExit(MethodExecutionArgs args) { this.TransactionScope.Dispose(); } }
下面是幾個Aspect類的切面處理代碼,如下所示。
[Exception] [Log] static void Calc() { throw new DivideByZeroException("A Math Error Occured..."); } [Log, Timing] static void LongRunningCalc() { //wait for 1000 miliseconds Thread.Sleep(1000); }
從上面我們可以看到,常規的異常處理、日志處理都已經通過Attribute的方式進行處理了,在函數體里面都只是剩下具體的業務邏輯代碼了,這樣極大提高了代碼的可讀性,簡潔明了。
運行上面的代碼函數的調用,我們可以在輸出日志里面看到具體的結果內容。
Entering [ Void Calc() ] ... “System.DivideByZeroException”類型的第一次機會異常在 PostSharpExample.exe 中發生 Exception in :[Void Calc()] , Message:[A Math Error Occured...] Leaving [ Void Calc() ] ... Entering [ Void LongRunningCalc() ] ... Leaving [ Void LongRunningCalc() ] ... [LongRunningCalc] took 1002ms to execute
這樣,通過聲明的方式,就實現了常規日志 、異常的處理,當然實際項目上使用日志、異常處理的這些代碼肯定會更加復雜一些,不過小例子已經實現了切面邏輯的分離處理了,塵歸塵、土歸土,一切都是那么的簡潔安靜了。