C# 開發技巧 輕鬆監控方法執行耗時

小码编匠發表於2024-07-23
C#

前言

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技術匠] 社群，與其他熱愛技術的同行交流心得，共同成長。

相關文章