【问题标题】:How do I find the type of the object instance of the caller of the current function?如何找到当前函数调用者的对象实例的类型?
【发布时间】:2008-12-03 21:18:49
【问题描述】:

目前我有函数 CreateLog() 用于创建一个 log4net 日志,其名称在构造实例的类之后。 通常用于:

class MessageReceiver
{
     protected ILog Log = Util.CreateLog();
     ...
}

如果我们删除大量错误处理,实现归结为: [编辑:请在这篇文章中进一步阅读较长版本的 CreateLog。]

public ILog CreateLog()
{
        System.Diagnostics.StackFrame stackFrame = new System.Diagnostics.StackFrame(1);
        System.Reflection.MethodBase method = stackFrame.GetMethod();
        return CreateLogWithName(method.DeclaringType.FullName);
}

问题是,如果我们将 MessageReceiver 继承到子类中,日志仍将使用 MessageReceiver 的名称,因为这是调用 CreateLog 的方法(构造函数)的声明类。

class IMReceiver : MessageReceiver
{ ... }

class EmailReceiver : MessageReceiver
{ ... }

这两个类的实例将获得名称为“MessageReceiver”的日志,而我希望它们被命名为“IMReceiver”和“EmailReceiver”。

我知道这可以通过在调用 CreateLog 时传递对创建对象的引用来轻松完成(并且已经完成),因为对象上的 GetType() 方法可以满足我的要求。

不喜欢添加参数有一些次要原因,我个人对没有找到没有额外参数的解决方案感到不安。

有没有人可以告诉我如何实现一个零参数 CreateLog() 从子类而不是声明类中获取名称?

编辑:

CreateLog 函数做的比上面提到的要多。每个实例有一个日志的原因是能够在日志文件中的不同实例之间有所不同。这是由 CreateLog/CreateLogWithName 对强制执行的。

扩展 CreateLog() 的功能以激发其存在。

public ILog CreateLog()
{
        System.Diagnostics.StackFrame stackFrame = new System.Diagnostics.StackFrame(1);
        System.Reflection.MethodBase method = stackFrame.GetMethod();
        Type type = method.DeclaringType;

        if (method.IsStatic)
        {
            return CreateLogWithName(type.FullName);
        }
        else
        {
            return CreateLogWithName(type.FullName + "-" + GetAndInstanceCountFor(type));
        }
}

另外我更喜欢写 ILog Log = Util.CreateLog();而不是每当我编写一个新类时从另一个文件中复制一些长而神秘的行。我知道 Util.CreateLog 中使用的反射不能保证工作 - System.Reflection.MethodBase.GetCurrentMethod() 是否保证工作?

【问题讨论】:

    标签: c# .net reflection logging


    【解决方案1】:

    通常,MethodBase.ReflectedType 会知道您的信息。但是,根据 MSDN StackFrame.GetMethod:

    当前正在执行的方法可能是从基类继承的,尽管它是在派生类中调用的。在这种情况下,GetMethod 返回的 MethodBase 对象的 ReflectedType 属性标识基类,而不是派生类。

    这意味着你可能运气不好。

    【讨论】:

      【解决方案2】:

      我想你可能问错了问题。首先,记录器对于每个类应该是静态的 - 每个类都应该声明自己的记录器(以确保正确报告类名,并允许从配置文件中选择性地报告按项目或命名空间过滤的日志消息。

      其次,您创建此方法似乎只是为了识别调用类的名称?如果是这样,我们使用粘贴到每个类中的样板代码:

      private static ILog log = 
      log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
      

      因为它是私有的,所以你确保你的继承类必须声明它们自己的记录器,而不是使用你的。因为它是静态的,所以您可以确保查找记录器的开销只发生一次。

      如果您有不同的原因编写 Util.CreateLog() 方法,我深表歉意。

      【讨论】:

      • 我将其设为受保护成员,因为我希望继承类使用相同的 Log。我的目标是能够连接来自同一个对象实例的日志条目。
      【解决方案3】:

      有没有人可以告诉我如何实现一个零参数 CreateLog() 从子类而不是声明类中获取名称?

      我认为您无法通过查看堆栈帧来做到这一点。

      虽然您的类是 IMReceiver,但对 CreateLog 方法的调用在 MessageReceiver 类中。堆栈帧必须告诉你从哪里调用该方法,否则它不会有任何用处,所以它总是会说MessageReceiver

      如果您在 IMReceiver 和其他类中显式调用 CreateLog,那么它会起作用,因为堆栈框架显示了在派生类中调用的方法(因为它实际上是)。

      这是我能想到的最好的东西:

      class BaseClass{
        public Log log = Utils.CreateLog();
      }
      class DerivedClass : BaseClass {
        public DerivedClass() {
          log = Utils.CreateLog();
        }
      }
      

      如果我们跟踪日志的创建,我们会得到:

      new BaseClass();
      # Log created for BaseClass
      
      new DerivedClass();
      # Log created for BaseClass
      # Log created for DerivedClass
      

      第二个“为派生类创建的日志”会覆盖实例变量,因此您的代码将正常运行,您只需创建一个 BaseClass 日志,该日志会立即被丢弃。这对我来说似乎很笨拙和不好,我只是在构造函数中指定类型参数或使用泛型。

      恕我直言,指定类型比在堆栈框架中四处寻找更干净

      如果您可以在不查看堆栈帧的情况下获得它,那么您的选择会大大扩展

      【讨论】:

        【解决方案4】:

        试试 StackTrace.GetFrames 方法。它返回调用堆栈中所有 StackFrame 对象的数组。您的调用者应该在索引一。

        class Program
        {
            static void Main(string[] args)
            {
                Logger logger = new Logger();
                Caller caller = new Caller();
                caller.FirstMethod(logger);
                caller.SecondMethod(logger);
            }
        }
        
        public class Caller
        {
            public void FirstMethod(Logger logger)
            {
                Console.Out.WriteLine("first");
                logger.Log();
            }
        
            public void SecondMethod(Logger logger)
            {
                Console.Out.WriteLine("second");
                logger.Log();
            }
        }
        
        public class Logger
        {
            public void Log()
            {
                StackTrace trace = new StackTrace();
                var frames = trace.GetFrames();
                Console.Out.WriteLine(frames[1].GetMethod().Name);
            }
        }
        

        这个输出

        首先 第一种方法 第二 第二种方法

        【讨论】:

        • System.Diagnostics.StackFrame stackFrame = new System.Diagnostics.StackFrame(1);应与以下相同: System.Diagnostics.StackFrame[] frames = new System.Diagnostics.StackTrace.GetFrames(); System.Diagnostics.StackFrame stackFrame = frames[1];
        • 是的,我只是认为展示如何在一次调用中获取整个数组可能很有用。
        【解决方案5】:

        向上堆栈检查基类 - 派生类关系。

                var type = new StackFrame(1).GetMethod().DeclaringType;
                foreach (var frame in new StackTrace(2).GetFrames())
                    if (type != frame.GetMethod().DeclaringType.BaseType)
                        break;
                    else
                        type = frame.GetMethod().DeclaringType;
                return CreateLogWithName(type.FullName);
        

        您可能需要检查检查的方法是否为构造函数。但是,如果子类在其构造函数之外的方法中实例化超类,可能仍需要当前行为。

        【讨论】:

        • 不幸的是,我认为任何使用堆栈跟踪都是不行的。当我在问题中的代码使用 release compile 运行时,由于堆栈帧被优化掉,没过多久就中断了。
        猜你喜欢
        • 1970-01-01
        • 1970-01-01
        • 2013-07-01
        • 1970-01-01
        • 2021-01-17
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2011-01-18
        相关资源
        最近更新 更多