前言:為什麼需要運行時定位代碼位置?
日誌記錄、異常診斷、性能分析、審計追蹤常需要知道「誰在哪一行調用了我」。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($"Method: {frame.GetMethod().Name}");
Console.WriteLine($"File: {frame.GetFileName()}");
Console.WriteLine($"Line: {frame.GetFileLineNumber()}");
Console.WriteLine($"Column: {frame.GetFileColumnNumber()}");
}
優缺點
| 優點 | 缺點 |
| 無需修改調用點簽名 | **性能極差**:走棧、解析符號、文件 IO,微秒級 → 毫秒級 |
| 可獲取完整調用鏈 | **需 PDB 文件**:Release 模式無 PDB 時行號為 0 或不準 |
| 支持異常堆棧捕獲 | 內聯優化導致幀丟失 (MethodImplOptions.AggressiveInlining) |
| 跨語言 (C#/VB/F#) 通用 | 不支持 Source Link / 嵌入式 PDB (舊版) |
性能基準 (BenchmarkDotNet)
// StackTrace: ~2-5 μs/op (Debug+PDB) | ~50-200 μs/op (Release 無 PDB)
// 分配: ~1-2 KB (StackFrame[] + 字符串)
方案二:Caller Information Attributes (編譯期注入,C# 5+)
語法
using System.Runtime.CompilerServices;
public void Log(string message,
[CallerMemberName] string memberName = "",
[CallerFilePath] string filePath = "",
[CallerLineNumber] int lineNumber = 0,
[CallerArgumentExpression("message")] string expression = "") // C# 10+
{
Console.WriteLine($"{Path.GetFileName(filePath)}:{lineNumber} {memberName} - {message}");
// expression 可獲取調用處表達式文本,如 "user.Count > 0"
}
調用點零成本
Log("User logged in"); // 編譯器自動填充 4 個參數
// 等價於
Log("User logged in", "Log", "Program.cs", 42, "User logged in");
優缺點
| 優點 | 缺點 |
| **零運行時開銷** (編譯期常量注入) | 需修改方法簽名 (增加可選參數) |
| **精準行號/文件名** (無視優化/內聯) | 無法獲取完整調用鏈 (僅直接調用者) |
| Release/Debug 一致,無需 PDB | 構造函數/屬性訪問器/索引器不支持 CallerMemberName (返回 .ctor/get_Item 等) |
支持 CallerArgumentExpression 捕獲表達式文本 | 異步方法中行號指向 await 後續點而非調用點 |
方案三:Source Link + 嵌入式 PDB (現代最佳平衡)
- 專案文件啟用:
<DebugType>embedded</DebugType> <PublishRepositoryUrl>true</PublishRepositoryUrl> <EmbedUntrackedSources>true</EmbedUntrackedSources>
- NuGet 引用
Microsoft.SourceLink.GitHub (或 GitLab/Azure DevOps)。
- 發布時自動將源碼映射嵌入 PDB,StackTrace 可在**無源碼環境**準確定位行號,調試器可直接跳轉 GitHub 源碼。
場景化選型決策表
| 場景 | 推薦方案 | 關鍵代碼 |
| 高性能日誌框架 (Serilog/NLog/LoggerMessage) | Caller Information + Source Generator | LoggerMessage.Define + [CallerArgumentExpression] |
| 異常捕獲上報 (Sentry/Elmah) | StackTrace (異常自帶) | exception.StackTrace / EnhancedStackTrace |
| 單元測試斷言輔助 (打印調用行) | Caller Information | Assert.That(..., "[CallerLineNumber]") |
| 臨時調試/腳本輸出 | StackTrace (一次性) | new StackTrace(true).ToString() |
| 庫開發:不想污染用戶簽名 | StackTrace (內部封裝) | 內部私有方法走棧,公共 API 保持乾淨 |
最佳實踐:統一日誌門面封裝
public static class Log
{
// 熱路徑:Caller Information + 結構化日誌
public static void Info(string message,
[CallerMemberName] string member = "",
[CallerFilePath] string file = "",
[CallerLineNumber] int line = 0)
{
var logger = LoggerFactory.Create(b => b.AddConsole());
logger.LogInformation("{File}:{Line} [{Member}] {Message}",
Path.GetFileName(file), line, member, message);
}
// 冷路徑/異常:捕獲完整堆棧
public static void Error(Exception ex, string message = "")
{
var logger = LoggerFactory.Create(b => b.AddConsole());
logger.LogError(ex, "{Message} {StackTrace}", message, ex.StackTrace);
}
}
// 業務代碼極簡
Log.Info("訂單創建成功"); // 自動帶上文件:行 方法名
結語
**日常業務日誌首選 Caller Information**:零開銷、精準定位、現代 C# 標準用法。
**異常診斷、審計、全鏈路追蹤用 StackTrace/Exception.StackTrace**:接受性能代價換取完整上下文。
**現代專案必開啟 Source Link + Embedded PDB**,讓兩者在生產環境同樣精準。不要在熱路徑裸用 new StackTrace(true),那是性能殺手。