C# 獲取當前方法名、行號、文件名：StackTrace 與 Caller Information 雙重方案

在日誌記錄、異常診斷、性能分析、審計追蹤等場景中，自動獲取調用位置信息（方法名、源文件行號、文件路徑）至關重要。C# 提供兩種截然不同的方案：運行時 StackTrace 與編譯期 Caller Information 屬性。本文深度對比兩者原理、性能、適用場景並給出生產級封裝代碼。

方案一：System.Diagnostics.StackTrace（運行時堆棧遍歷）

基本用法

using System.Diagnostics;

public void LogWithStackTrace() {
    var st = new StackTrace(true); // true = 捕獲文件信息（需 PDB 文件）
    var frame = st.GetFrame(1);    // 0=當前方法，1=調用者
    Console.WriteLine($"方法: {frame.GetMethod().Name}");
    Console.WriteLine($"文件: {frame.GetFileName()}");
    Console.WriteLine($"行號: {frame.GetFileLineNumber()}");
    Console.WriteLine($"列號: {frame.GetFileColumnNumber()}");
}

關鍵參數與陷阱

性能與局限

• 性能開銷大：捕獲完整堆棧、解析 PDB、反射 MethodBase，單次調用 ~1-5μs，高頻日誌不可接受。
• 內聯優化干擾：JIT 內聯會導致堆棧幀消失，GetFrame(1) 可能非預期調用者。可用 [MethodImpl(MethodImplOptions.NoInlining)] 防止。
• Release 模式 PDB 缺失：默認 Release 不生成 PDB，需專案文件配置 <DebugType>portable</DebugType> 或 <DebugSymbols>true</DebugSymbols>。
• 跨平台路徑差異：Windows 絕對路徑含盤符，Linux 為 /home/...，容器化部署路徑可能無意義。

方案二：Caller Information Attributes（編譯期注入，零開銷）

C# 5.0+ 引入，編譯器在調用點自動填充參數值，**零運行時開銷**，**不受內聯/PDB 影響**。

三大屬性

標準封裝模式

using System.Runtime.CompilerServices;

public static class LogHelper {
    public static void Log(string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string filePath = "",
        [CallerLineNumber] int lineNumber = 0) {
        // 可選：只保留文件名
        var fileName = Path.GetFileName(filePath);
        Console.WriteLine($"[{DateTime.Now:HH:mm:ss.fff}] [{fileName}:{lineNumber} {memberName}] {message}");
    }

    // 異步版本
    public static async Task LogAsync(string message,
        [CallerMemberName] string memberName = "",
        [CallerFilePath] string filePath = "",
        [CallerLineNumber] int lineNumber = 0) {
        // 寫入文件/發送到日誌服務...
        await Task.CompletedTask;
    }
}

// 業務代碼調用極其簡潔
public class OrderService {
    public void PlaceOrder(OrderDto dto) {
        LogHelper.Log("開始下單"); // 自動注入: memberName="PlaceOrder", lineNumber=XX
        // ...
        LogHelper.Log("下單完成");
    }
}

進階：獲取調用者類型名

CallerMemberName 不包含類名。結合 StackTrace 輕量級獲取（僅 1 幀）：

public static void LogWithType(string message,
    [CallerMemberName] string member = "",
    [CallerFilePath] string file = "",
    [CallerLineNumber] int line = 0) {
    string typeName = "";
    // 僅獲取第 1 幀（調用者），不捕獲文件信息，性能可接受
    var frame = new StackTrace(false).GetFrame(1);
    if (frame?.GetMethod()?.DeclaringType != null) {
        typeName = frame.GetMethod().DeclaringType.Name;
    }
    Console.WriteLine($"[{typeName}.{member}:{line}] {message}");
}

生產級日誌封裝建議

public static class StructuredLogger {
    // 結構化日誌，便於 ELK/Splunk 解析
    public static void Info(string eventName, object? payload = null,
        [CallerMemberName] string member = "",
        [CallerFilePath] string file = "",
        [CallerLineNumber] int line = 0) {
        var log = new {
            Timestamp = DateTimeOffset.UtcNow,
            Level = "INFO",
            Event = eventName,
            Caller = new {
                Member = member,
                File = Path.GetFileName(file),
                Line = line
            },
            Payload = payload
        };
        // 序列化為 JSON 寫入文件/發送到 Kafka/Seq/Elasticsearch
        var json = System.Text.Json.JsonSerializer.Serialize(log);
        File.AppendAllText("app.log", json + Environment.NewLine);
    }
}

方案選型決策表

核心總結

• 首選 Caller Information：現代 C# 日誌、審計、診斷的標準做法，性能零損耗、語法極簡。
• StackTrace 為補充：需完整調用鏈、異常堆棧、第三方代碼診斷時使用，注意性能與 PDB 依賴。
• Release 也要生成 PDB：<DebugType>portable</DebugType> 使 StackTrace 在生產環境同樣可用，文件大小極小。
• 結構化日誌：攜帶 Caller 信息輸出 JSON，配合日誌平台實現秒級問題定位。

合理組合兩套方案，構建「開發時可見、生產時可查、性能無損耗」的可觀測體系，是高質量 .NET 應用的標配。