萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET 使用反射取得呼叫者方法名稱完整教學

前言

在撰寫日誌、除錯或 AOP 切面時,常需自動取得「呼叫當前方法的方法名稱」。.NET 提供 System.Reflection 與 System.Diagnostics.StackTrace 兩大工具,本文將示範從基本用法到進階堆疊框架分析的完整範例。

一、必要命名空間

using System;
using System.Diagnostics;
using System.Reflection;

二、取得目前執行方法資訊

MethodBase.GetCurrentMethod() 回傳正在執行的方法資訊。

public static void WriteLog(int level, string content)
{
    MethodBase mb = MethodBase.GetCurrentMethod();
    var info = $@"模組: {mb.Module}
命名空間: {mb.ReflectedType?.Namespace}
類別完整名稱: {mb.ReflectedType?.FullName}
方法名稱: {mb.Name}";
    Console.WriteLine($"LogDate: {DateTime.Now}\nLevel: {level}\n{info}\nContent: {content}\n");
}

三、取得呼叫者(上一層堆疊)資訊

使用 StackTrace 取得堆疊框架陣列,索引 1 為呼叫者。

public static void WriteLog(string content)
{
    const int level = 1000;
    var st = new StackTrace(true); // 捕捉檔案/行號
    var frame = st.GetFrame(1); // 0=本方法, 1=呼叫者
    var mb = frame.GetMethod();

    var info = $@"模組: {mb.Module}
命名空間: {mb.DeclaringType?.Namespace}
類別名稱: {mb.DeclaringType?.Name}
方法名稱: {mb.Name}";
    Console.WriteLine($"LogDate: {DateTime.Now}\nLevel: {level}\n{info}\nContent: {content}\n");
}

四、完整堆疊追蹤範例:Main 方法的呼叫鏈

var st = new StackTrace(true);
foreach (var frame in st.GetFrames())
{
    var method = frame.GetMethod();
    Console.WriteLine($"{method.DeclaringType?.FullName}.{method.Name}");
}

典型輸出順序:

  1. System.Threading.ThreadHelper.ThreadStart()
  2. System.Threading.ExecutionContext.Run(...)
  3. Microsoft.VisualStudio.HostingProcess.HostProc.RunUsersAssembly()
  4. System.AppDomain._nExecuteAssembly(...)
  5. 進入使用者 Main 方法

五、MethodBase 進階屬性速查

屬性說明
Name方法名稱
DeclaringType宣告該方法的類型
ReflectedType透過反射取得的類型(可能為衍生類型)
Module包含該方法的模組
IsPublic / IsPrivate / IsStatic存取修飾詞與靜態判斷
GetParameters()取得參數資訊陣列
ReturnType回傳型別

六、反射應用小技巧:將變數值轉為變數名稱

利用運算式樹或 CallerMemberName 屬性(.NET 4.5+)更優雅:

public void LogValue([CallerMemberName] string name = "", object value = null)
{
    Console.WriteLine($"{name} = {value}");
}

// 呼叫
int count = 10;
LogValue(value: count); // 輸出: count = 10

七、效能與注意事項

  • StackTrace 建構較耗效能,避免在高頻熱路徑(如迴圈、每個 Request)大量使用。
  • Release 模式下 JIT 內聯可能導致堆疊框架消失,需加 [MethodImpl(MethodImplOptions.NoInlining)]。
  • 生產環境日誌建議使用結構化日誌框架(Serilog, NLog)內建的 SourceContext 自動擷取呼叫類別。

結語

掌握 MethodBase.GetCurrentMethod() 與 StackTrace 讓您能建立強大的診斷工具。記住:善用 CallerMemberName、CallerFilePath、CallerLineNumber 屬性(編譯期注入)比執行期反射更高效、更安全。

copyright © 萬盛學電腦網 all rights reserved