.NET 利用 StackTrace 獲取當前呼叫堆疊與方法資訊完整指南

System.Diagnostics.StackTrace 是 .NET 診斷、日誌、AOP 切面編程中的利器，能在執行時完整捕捉呼叫堆疊資訊。本文透過完整範例示範如何獲取方法名稱、呼叫層級、檔案行號等關鍵資訊，並探討實際應用場景。

核心類別與屬性

• StackTrace：代表一個堆疊追蹤，建構子 new StackTrace(true) 參數 true 表示捕捉檔案資訊（需 PDB 符號檔）。
• StackFrame：堆疊中的單一幀，對應一次方法呼叫。關鍵方法：
  • GetMethod()：取得 MethodBase，可進一步獲取 Name、DeclaringType、Module 等。
  • GetFileName()、GetFileLineNumber()、GetFileColumnNumber()：原始碼位置（需偵錯建置）。
  • GetILOffset()、GetNativeOffset()：IL/原生位移。

完整範例程式碼

using System;
using System.Diagnostics;

namespace StackTraceDemo
{
    class Program
    {
        static void Main(string[] args)
        {
            A();
            B();
            Console.ReadKey();
        }

        static void A()
        {
            ShowStack();
        }

        static void B()
        {
            ShowStack();
            A();  // 巢狀呼叫
        }

        static void ShowStack()
        {
            var st = new StackTrace(true);  // true = capture file info
            var frames = st.GetFrames();
            
            Console.WriteLine("=== 完整呼叫堆疊 (由外而內) ===");
            for (int i = frames.Length - 1; i >= 0; i--)
            {
                var method = frames[i].GetMethod();
                var typeName = method.DeclaringType?.FullName ?? "";
                Console.Write($"{typeName}.{method.Name} -> ");
            }
            Console.WriteLine("\n***********************\n");

            // 進階：只取業務邏輯層（跳過框架內部幀）
            Console.WriteLine("=== 過濾後的業務呼叫鏈 ===");
            foreach (var frame in frames)
            {
                var method = frame.GetMethod();
                if (method.DeclaringType?.Namespace?.StartsWith("StackTraceDemo") == true)
                {
                    Console.WriteLine($"{method.DeclaringType.Name}.{method.Name} " +
                        $"(File: {frame.GetFileName()}, Line: {frame.GetFileLineNumber()})");
                }
            }
        }
    }
}

輸出結果範例

=== 完整呼叫堆疊 (由外而內) ===
StackTraceDemo.Program.Main -> StackTraceDemo.Program.A -> StackTraceDemo.Program.ShowStack -> 
***********************

=== 完整呼叫堆疊 (由外而內) ===
StackTraceDemo.Program.Main -> StackTraceDemo.Program.B -> StackTraceDemo.Program.ShowStack -> 
***********************

=== 完整呼叫堆疊 (由外而內) ===
StackTraceDemo.Program.Main -> StackTraceDemo.Program.B -> StackTraceDemo.Program.A -> StackTraceDemo.Program.ShowStack -> 
***********************

=== 過濾後的業務呼叫鏈 ===
Program.A (File: Program.cs, Line: 22)
Program.ShowStack (File: Program.cs, Line: 35)

實戰應用場景

1. 自動化日誌上下文：無需手動傳遞方法名，日誌元件自動捕捉呼叫者資訊。
2. 例外狀況豐富化：捕捉 Exception.StackTrace 之外的更多上下文（如參數值、區域變數配合 StackFrame.GetMethod().GetParameters()）。
3. AOP/攔截器實作：動態代理中識別真實呼叫者，實現權限檢查、審計追蹤。
4. 效能分析：統計熱點呼叫路徑，輔助優化。

效能與注意事項

• 效能開銷：StackTrace 建構較重（需走 Managed Stack Walk），避免在高頻熱路徑（如迴圈、底層庫）中頻繁建構。建議採樣或條件觸發。
• Release 模式優化：JIT 內聯、尾呼叫優化可能導致幀丟失，關鍵診斷點可加 [MethodImpl(MethodImplOptions.NoInlining)]。
• 安全性：部分信任環境下可能受限，需 SecurityPermission(UnmanagedCode)。
• 替代方案：.NET Core 2.1+ 可用 System.Diagnostics.Activity / ActivitySource 進行分散式追蹤，開銷更低、功能更強。

善用 StackTrace 能大幅提升診斷能力，但請謹記「按需採樣、避開熱路徑」的黃金法則。