快捷導(dǎo)航

.NET使用StackTrace獲取方法調(diào)用信息的代碼演示

更新時(shí)間：2022年09月04日 07:47:57 作者：人生短短幾個(gè)秋

StackTrace，位于 System.Diagnostics 命名空間下，名字很直觀，它代表一個(gè)方法調(diào)用的跟蹤堆棧，里面存放著按順序排列的棧幀對(duì)象（StackFrame），每當(dāng)發(fā)生一次調(diào)用，就會(huì)壓入一個(gè)棧幀，這篇文章主要介紹了.NET使用StackTrace獲取方法調(diào)用信息,需要的朋友可以參考下

前言

在日常工作中，偶爾需要調(diào)查一些詭異的問題，而業(yè)務(wù)代碼經(jīng)過長時(shí)間的演化，很可能已經(jīng)變得錯(cuò)綜復(fù)雜，流程、分支眾多，如果能在關(guān)鍵方法的日志里添加上調(diào)用者的信息，將對(duì)定位問題非常有幫助。

介紹

StackTrace，位于 System.Diagnostics 命名空間下，名字很直觀，它代表一個(gè)方法調(diào)用的跟蹤堆棧，里面存放著按順序排列的棧幀對(duì)象（StackFrame），每當(dāng)發(fā)生一次調(diào)用，就會(huì)壓入一個(gè)棧幀；而一個(gè)棧幀，則擁有本次調(diào)用的各種信息，除了MethodBase，還包括所在的文件名、行、列等。

演示

下面代碼演示了如何獲取調(diào)用者的方法名、所在文件、行號(hào)、列號(hào)等信息。

public static string GetCaller()
{
       StackTrace st = new StackTrace(skipFrames: 1, fNeedFileInfo: true);
       StackFrame[] sfArray = st.GetFrames();
 
       return string.Join(" -> ",
            sfArray.Select(r =>
                $"{r.GetMethod().Name} in {r.GetFileName()} line:{r.GetFileLineNumber()} column:{r.GetFileColumnNumber()}"));
    
}

第一幀是 GetCaller本身，所以跳過；fNeedFileInfo設(shè)置成 true，否則調(diào)用者所在文件等信息會(huì)為空。
簡單創(chuàng)建個(gè)控制臺(tái)程序并添加幾個(gè)類模擬一下，輸出如下：

UpdateOrder in G:\examples\MethodCall2\ClassLevel6.cs line:11 column:8 ->
Level5Method in G:\examples\MethodCall2\ClassLevel5.cs line:8 column:9 ->
Level4Method in G:\examples\MethodCall2\ClassLevel4.cs line:10 column:9 ->
Level3Method in G:\examples\MethodCall2\ClassLevel3.cs line:10 column:9 ->
Level2Method in G:\examples\MethodCall2\ClassLevel2.cs line:10 column:9 ->
InternalMethod in G:\examples\MethodCall2\ClassLevel1.cs line:12 column:13 ->
Main in G:\examples\MethodCall2\Program.cs line:18 column:17

可以看到因?yàn)?code>StackTrace是個(gè)棧結(jié)構(gòu)（FILO），所以打印出來的順序也是由近及遠(yuǎn)的。