如何找到调用当前方法的方法？

Question

登录C#时,如何学习调用当前方法的方法的名称？我知道所有这些System.Reflection.MethodBase.GetCurrentMethod(),但我想在堆栈跟踪中向下迈出一步.我考虑过解析堆栈跟踪,但我希望找到一种更清晰,更明确的方法,比如Assembly.GetCallingAssembly()方法.

Answer 1

试试这个:

using System.Diagnostics;
// Get call stack
StackTrace stackTrace = new StackTrace();

// Get calling method name
Console.WriteLine(stackTrace.GetFrame(1).GetMethod().Name);

它来自使用反射[C#]的Get Calling Method.

Answer 2

在C#5中,您可以使用来电者信息获取该信息:

//using System.Runtime.CompilerServices;
public void SendError(string Message, [CallerMemberName] string callerName = "") 
{ 
    Console.WriteLine(callerName + "called me."); 
} 

你也可以得到[CallerFilePath]和[CallerLineNumber].

Answer 3

您可以使用来电者信息和可选参数:

public static string WhoseThere([CallerMemberName] string memberName = "")
{
       return memberName;
}

该测试说明了这一点:

[Test]
public void Should_get_name_of_calling_method()
{
    var methodName = CachingHelpers.WhoseThere();
    Assert.That(methodName, Is.EqualTo("Should_get_name_of_calling_method"));
}

虽然StackTrace的工作速度非常快,但在大多数情况下都不会出现性能问题,但Caller Information的速度要快得多.在1000次迭代的样本中,我将其计时速度提高了40倍.

Answer 4

我们可以通过仅实例化我们实际需要的帧而不是整个堆栈来改进阿萨德先生的代码(当前接受的答案):

new StackFrame(1).GetMethod().Name;

这可能会更好一点,但很可能它仍然必须使用完整堆栈来创建该单帧.此外,它仍然有Alex Lyman指出的相同警告(优化器/本机代码可能会破坏结果).最后,您可能希望检查以确定new StackFrame(1)或.GetFrame(1)不返回null,因为这种可能性看起来不太可能.

请参阅此相关问题: 您是否可以使用反射来查找当前正在执行的方法的名称？

Answer 5

通常,您可以使用System.Diagnostics.StackTrace该类获取a System.Diagnostics.StackFrame,然后使用该GetMethod()方法获取System.Reflection.MethodBase对象.但是,这种方法有一些注意事项:

1. 它表示运行时堆栈 - 优化可以内联方法,并且您不会在堆栈跟踪中看到该方法.
2. 它不会显示任何原生帧,所以如果你的方法有可能被本机方法调用,这将无法工作,实际上目前还没有可行的方法.

(注意:我只是扩展了Firas Assad提供的答案.)

Answer 6

快速回顾两种方法,速度比较是重要的部分.

http://geekswithblogs.net/BlackRabbitCoder/archive/2013/07/25/c.net-little-wonders-getting-caller-information.aspx

在编译时确定调用者

static void Log(object message, 
[CallerMemberName] string memberName = "",
[CallerFilePath] string fileName = "",
[CallerLineNumber] int lineNumber = 0)
{
    // we'll just use a simple Console write for now    
    Console.WriteLine("{0}({1}):{2} - {3}", fileName, lineNumber, memberName, message);
}

使用堆栈确定调用者

static void Log(object message)
{
    // frame 1, true for source info
    StackFrame frame = new StackFrame(1, true);
    var method = frame.GetMethod();
    var fileName = frame.GetFileName();
    var lineNumber = frame.GetFileLineNumber();

    // we'll just use a simple Console write for now    
    Console.WriteLine("{0}({1}):{2} - {3}", fileName, lineNumber, method.Name, message);
}

比较两种方法

Time for 1,000,000 iterations with Attributes: 196 ms
Time for 1,000,000 iterations with StackTrace: 5096 ms

所以你看,使用属性要快得多!事实上快了近25倍.

Answer 7

从.NET 4.5开始,您可以使用来电者信息属性:

• CallerFilePath - 调用该函数的源文件;
• CallerLineNumber - 调用函数的代码行;

• CallerMemberName - 调用该函数的成员.

  public void WriteLine(
      [CallerFilePath] string callerFilePath = "", 
      [CallerLineNumber] long callerLineNumber = 0,
      [CallerMemberName] string callerMember= "")
  {
      Debug.WriteLine(
          "Caller File Path: {0}, Caller Line Number: {1}, Caller Member: {2}", 
          callerFilePath,
          callerLineNumber,
          callerMember);
  }
  

 

此工具也存在于".NET Core"和".NET Standard"中.

参考

1. 微软 - 来电者信息(C#)
2. 微软 - CallerFilePathAttribute班级
3. 微软 - CallerLineNumberAttribute班级
4. 微软 - CallerMemberNameAttribute班级

Answer 8

请注意,由于优化,这样做在发布代码中将是不可靠的.此外,以沙箱模式(网络共享)运行应用程序将不允许您抓取堆栈帧.

考虑面向方面编程(AOP),如PostSharp,它不是从代码中调用,而是修改代码,从而随时了解它的位置.

Answer 9

显然这是一个迟到的答案,但如果您可以使用.NET 4.5或更高版本,我有更好的选择:

internal static void WriteInformation<T>(string text, [CallerMemberName]string method = "")
{
    Console.WriteLine(DateTime.Now.ToString() + " => " + typeof(T).FullName + "." + method + ": " + text);
}

这将打印当前日期和时间,后跟"Namespace.ClassName.MethodName"并以":text"结尾.
样本输出:

6/17/2016 12:41:49 PM => WpfApplication.MainWindow..ctor: MainWindow initialized

样品用途:

Logger.WriteInformation<MainWindow>("MainWindow initialized");

Answer 10

/// <summary>
/// Returns the call that occurred just before the "GetCallingMethod".
/// </summary>
public static string GetCallingMethod()
{
   return GetCallingMethod("GetCallingMethod");
}

/// <summary>
/// Returns the call that occurred just before the the method specified.
/// </summary>
/// <param name="MethodAfter">The named method to see what happened just before it was called. (case sensitive)</param>
/// <returns>The method name.</returns>
public static string GetCallingMethod(string MethodAfter)
{
   string str = "";
   try
   {
      StackTrace st = new StackTrace();
      StackFrame[] frames = st.GetFrames();
      for (int i = 0; i < st.FrameCount - 1; i++)
      {
         if (frames[i].GetMethod().Name.Equals(MethodAfter))
         {
            if (!frames[i + 1].GetMethod().Name.Equals(MethodAfter)) // ignores overloaded methods.
            {
               str = frames[i + 1].GetMethod().ReflectedType.FullName + "." + frames[i + 1].GetMethod().Name;
               break;
            }
         }
      }
   }
   catch (Exception) { ; }
   return str;
}

Answer 11

也许你正在寻找这样的东西:

StackFrame frame = new StackFrame(1);
frame.GetMethod().Name; //Gets the current method name

MethodBase method = frame.GetMethod();
method.DeclaringType.Name //Gets the current class name