本文系統講解 VB.NET (2005/2008) 中如何利用 System.Diagnostics.StackTrace 與 StackFrame 獲取調用當前方法的類名、方法名、源文件路徑及行號。此技術廣泛應用於自動化日誌框架、審計追蹤、性能剖析輔助等場景。
| 類/方法 | 用途 | 關鍵參數/返回值 |
|---|---|---|
StackTrace(True) | 捕獲帶文件/行號信息的堆棧 | True 為 fNeedFileInfo,啟用 PDB 符號讀取 |
StackTrace.GetFrame(1) | 獲取直接調用者幀 | 索引 0 為當前方法,1 為調用者,以此類推 |
StackFrame.GetMethod().Name | 調用者方法名 | String |
StackFrame.GetMethod().ReflectedType.Name | 調用者類名 | String |
StackFrame.GetFileLineNumber() | 調用處源碼行號 | Integer,無符號信息時返回 0 |
StackFrame.GetFileName() | 調用者源文件完整路徑 | String,無符號信息返回 Nothing |
Imports System.Diagnostics
Public Class CallerInfoResolver
'''
''' 解析並返回直接調用者的上下文信息
'''
Public Shared Function GetCallerInfo() As CallerInfo
Dim st As New StackTrace(True)
If st.FrameCount < 2 Then Return Nothing ' 無調用者幀
Dim sf As StackFrame = st.GetFrame(1)
Dim mi = sf.GetMethod()
Return New CallerInfo With {
.MethodName = mi.Name,
.ClassName = If(mi.ReflectedType IsNot Nothing, mi.ReflectedType.Name, "Unknown"),
.LineNumber = sf.GetFileLineNumber(),
.FilePath = sf.GetFileName()
}
End Function
End Class
Public Class CallerInfo
Public Property MethodName As String
Public Property ClassName As String
Public Property LineNumber As Integer
Public Property FilePath As String
Public Overrides Function ToString() As String
Return $"{ClassName}.{MethodName} @ {FilePath}:{LineNumber}"
End Function
End Class
' 使用示例
Public Class BusinessService
Public Sub ProcessOrder()
Dim logger As New AuditLogger()
logger.Log("Order processed") ' 內部自動解析調用者
End Sub
End Class
Public Class AuditLogger
Public Sub Log(message As String)
Dim info = CallerInfoResolver.GetCallerInfo()
Dim logEntry = $"{DateTime.Now:yyyy-MM-dd HH:mm:ss} [{info}] {message}"
' 寫入文件/數據庫/雲端...
Debug.WriteLine(logEntry)
End Sub
End Class
2024-01-15 14:30:45 [BusinessService.ProcessOrder @ D:\Projects\OrderSys\BusinessService.vb:23] Order processed
CallerInfoResolver),業務代碼零侵入。<MethodImpl(MethodImplOptions.NoInlining)> 防止內聯導致幀丟失。<>c__DisplayClass、MoveNext 等編譯器生成幀需過濾,可按命名空間/命名規約識別。CallerMemberName 屬性現代 .NET 提供編譯期屬性注入,零運行時開銷:
Public Sub Log(msg As String,
<CallerMemberName> Optional memberName = "",
<CallerFilePath> Optional filePath = "",
<CallerLineNumber> Optional lineNumber = 0)
' 直接使用參數,無需 StackTrace
End Sub
建議:.NET 4.5+ 專案優先使用 Caller* 屬性;維護舊版專案或需動態獲取非直接調用者(如跳過封裝層)時,仍需 StackTrace。
StackTrace 是 .NET 運行時賦予開發者的「透視鏡」。善用它構建可觀測系統,但務必敬畏其性能代價與環境限制。在正確場景、正確姿勢下,它是診斷利器;濫用則是性能殺手。