前言 MethodTimer.Fody 是一個功能強大的庫,可以用於測量 .NET 應用程式中的方法的執行時間。允許你在不修改代碼的情況下,自動地測量和記錄方法的執行時間。 這個工具是基於.NET的 weaving 技術,通過修改IL(Intermediate Language,中間語言)代碼來插入 ...
前言
MethodTimer.Fody 是一個功能強大的庫,可以用於測量 .NET 應用程式中的方法的執行時間。允許你在不修改代碼的情況下,自動地測量和記錄方法的執行時間。
這個工具是基於.NET的 weaving 技術,通過修改IL(Intermediate Language,中間語言)代碼來插入計時邏輯,從而在方法調用前後記錄時間戳,進而計算出方法的執行時間。
它使用 Fody 插件框架可以無縫集成到項目中,所以向代碼中添加性能測量功能變得非常容易。
使用方法
1、安裝NuGet包
在Visual Studio中,打開NuGet包管理器,搜索並安裝MethodTimer.Fody或者使用命令方式
PM> Install-Package Fody
PM> Install-Package MethodTimer.Fody
具體操作如下圖所示:
2、使用 Time 特性
using MethodTimer; namespace DemoConsole { internal class Program { /// <summary> /// 程式入口 /// </summary> /// <param name="args"></param> static void Main(string[] args) { // 調用示例方法 new Program().DoSomething(); Console.WriteLine("測試方法執行結束!!!"); Console.ReadKey(); } /// <summary> /// 示例方法 /// </summary> [Time] public void DoSomething() { Console.WriteLine("測試方法執行時間!!!"); } } }
Fody是一個.NET的weaving框架,需要確保項目已經啟用了Fody,並且在項目屬性的"Fody"標簽頁中添加了MethodTimer
模塊。
3、執行效果
啟動運行程式,可以在輸出視窗查看方法的執行耗時,具體如下圖所示:
4、其他說明
Time 特性不僅可以加在方法上還可以直接添加到 Class 上,具體如下代碼所示:
using MethodTimer; namespace ConsoleApp3 { [Time] internal class Program { /// <summary> /// 程式入口 /// </summary> /// <param name="args"></param> static void Main(string[] args) { // 調用示例方法 new Program().DoSomething(); new Program().ToDoSomething(); Console.WriteLine("方法執行結束!!!"); Console.ReadKey(); } /// <summary> /// 示例方法1 /// </summary> public void DoSomething() { Console.WriteLine("001——測試執行時間方法!!!"); } /// <summary> /// 示例方法2 /// </summary> public void ToDoSomething() { Console.WriteLine("002——測試執行時間方法!!!"); } } }
運行程式後,可以輸出類中每個方法的執行時間。
實際上,在代碼中添加了 Time 特性以後,Fody 會自動生成下麵的代碼
public class MyClass { [Time] public void DoSomething() { Stopwatch stopwatch = new Stopwatch(); stopwatch.Start(); // 原始方法體 System.Threading.Thread.Sleep(1000); // 模擬工作 stopwatch.Stop(); // 輸出或記錄執行時間 Console.WriteLine($"執行時間:{stopwatch.Elapsed.TotalMilliseconds} ms"); } }
5、攔截記錄
如果想手動處理日誌記錄,可以定義一個靜態類來攔截日誌記錄,方法的示例,具體如下代碼所示
public static class MethodTimeLogger { public static void Log(MethodBase methodBase, TimeSpan elapsed, string message) { //Do some logging here } }
生成後的代碼
public class MyClass { public void MyMethod() { var stopwatch = Stopwatch.StartNew(); try { Console.WriteLine("Hello"); } finally { stopwatch.Stop(); MethodTimeLogger.Log(methodof(MyClass.MyMethod), stopwatch.Elapsed); } } }
MethodTimer.Fody是一個非常有用的工具,尤其在性能調優階段,可以幫助你快速識別出哪些方法是性能瓶頸,從而針對性地進行優化。
主要特點
1、非侵入式
MethodTimer.Fody不需要在源代碼中添加額外的計時代碼,只需要在項目中添加相應的NuGet包,併在項目屬性中做一些配置,就可以自動地為方法添加計時功能。
2、靈活的配置
你可以選擇性地對某些方法進行計時,或者排除不想被計時的方法。這通常通過方法的特性或者類的命名空間來進行配置。
3、輸出結果多樣化
MethodTimer.Fody可以將計時結果輸出到不同的地方,如控制台、日誌文件或者通過事件追蹤(ETW)等方式,這取決於你的配置。
4、性能影響小
儘管MethodTimer.Fody在方法中插入了計時邏輯,但它被設計得儘可能地對性能影響最小,通過精心優化的IL代碼插入策略來實現這一點。
總結
MethodTimer.Fody 是一個強大的工具,提供了簡便的方式來監控 C# 方法的執行時間,特別適用於需要快速診斷性能問題的場合。
通過其靈活的配置和非侵入性的特性,它可以無縫地融入現有的開發流程中,幫助我們團隊提高應用的性能和響應速度。
這個工具特別適合在開發和測試階段快速識別性能瓶頸,而無需在代碼中顯式地添加計時代碼,可以保持源代碼的整齊性和可維護性。
開源地址
https://github.com/Fody/MethodTimer
如果覺得這篇文章對你有用,歡迎加入微信公眾號 [DotNet技術匠] 社區,與其他熱愛技術的同行交流心得,共同成長。