如何为 log4net 消息添加类别前缀？

Question

我喜欢为现有日志消息中的所有消息添加类别前缀。然而，将这个前缀一一添加到所有现有的日志消息中是很繁琐的。有没有一种方法可以在类级别添加一个属性，然后该类中的所有消息都将被记录到某个类别？

而不是像下面这样。

Log.Info("[Ref] Level 1 Starts ...");

我真的想要像这样或不同的方式来定义 log4net.ILog，

[LoggingCategory("Ref")]
public class MyClass 
{
   public void MyMethod()
   {
        Log.Info("Level 1 Starts ...");
   }
}

Answer 1

您询问如何通过属性来做到这一点。 @Jonathan 的建议看起来可能会正常工作，但是您可能能够使用 log4net 的内置功能获得足够好的结果。

如果您想将类分组为“类别”，那么您可以根据类别名称而不是类名检索记录器。设置输出格式时，可以使用记录器格式化标记告诉 log4net 在输出中写入记录器名称。

通常，人们会根据类名检索记录器，如下所示：

public class Typical
{
  private static readonly ILog logger = 
       LogManager.GetLogger
          (System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);

  public void F()
  {
    logger.Info("this message will be tagged with the classname");
  }
}

基于任意名称检索记录器是完全可以接受的，如下所示：

public class A
{
  private static readonly ILog logger = LogManager.GetLogger("REF");

  public void F()
  {
    logger.Info("this message will be tagged with REF");
  }
}

public class B
{
  private static readonly ILog logger = LogManager.GetLogger("REF");

  public void F()
  {
    logger.Info("this message will be tagged with REF");
  }
}

public class C
{
  private static readonly ILog logger = LogManager.GetLogger("UMP");

  public void F()
  {
    logger.Info("this message will be tagged with UMP");
  }
}

在前面的示例中，类 A 和 B 被认为属于同一“类别”，因此它们检索具有相同名称的记录器。 C 类属于不同的类别，因此它检索具有不同名称的记录器。

您可以使用自己的“类别”层次结构配置记录器（在配置文件中）：

App
App.DataAccess
App.DataAccess.Create
App.DataAccess.Read
App.DataAccess.Update
App.DataAccess.Delete
App.UI
App.UI.Login
App.UI.Query
App.UI.Options

您还可以配置记录器输出格式以仅记录完全限定记录器名称的一部分。像这样的事情：

%logger:2

获取完全限定名称的最后两部分。例如，如果您的类的完全限定名称是：

NameSpaceA.NameSpaceB.NameSpaceC.Class

那么上述格式会将其输出为记录器名称：

NameSpaceC.Class

我对语法不是 100% 确定，因为我还没有使用过它，而且现在找不到一个好的示例。

这种方法的一个缺点是，您必须定义并记住您的类别是什么，并且必须决定每个类的适当类别是什么（如果您想用包含其类别的属性来装饰每个类，您也会遇到这个问题）。此外，如果同一类别中有多个类，则无法打开或关闭日志记录或更改这些类的子集的日志记录级别。

也许从命名空间层次结构中记录单个命名空间会很有用：

也许您可以根据类的命名空间“分类”您的类。因此，您可能希望将类的直接父命名空间记录为其类别。

因此，对于上面的完全限定类名，您可能希望将“NameSpaceC”记录为“类别”或记录器名称。

我不确定您是否可以使用 log4net 开箱即用地做到这一点，但您可以轻松编写一个 PatternLayoutConverter 来获取记录器名称并剥离类名称和任何“更高级别”名称空间。

以下是自定义 PatternLayoutConverter 示例的链接。采用一个参数，在我的例子中，我想用它来查找字典中的值。在这种情况下，参数可以表示从完全限定的记录器名称的 END 开始的偏移量（与 log4net 内置记录器名称布局对象的参数的解释相同），但是可以添加额外的代码来仅记录该名称空间的单个名称空间指数。

再次

，给定这个完全限定的类名：

NameSpaceA.NameSpaceB.NameSpaceC.Class

您可能会将直接父命名空间视为“类别”。如果您定义了一个自定义 PatternLayoutConverter，category，并且它带有一个参数，那么您的配置可能如下所示：

%category

默认情况下，它将返回最后一个和下一个 '.' 之间的子字符串。 字符。给定一个参数，它可以返回链上的任何离散名称空间。

PatternLayoutConverter 可能看起来像这样（未经测试）：

  class CategoryLookupPatternConverter : PatternLayoutConverter
  {
    protected override void Convert(System.IO.TextWriter writer, LoggingEvent loggingEvent)
    {
      //Assumes logger name is fully qualified classname.  Need smarter code to handle
      //arbitrary logger names.
      string [] names = loggingEvent.LoggerName.Split('.');
      string cat = names[names.Length - 1];
      writer.Write(setting);
    }
  }

或者，使用 Option 属性获取第 N 个命名空间名称（相对于末尾）：

  class CategoryLookupPatternConverter : PatternLayoutConverter
  {
    protected override void Convert(System.IO.TextWriter writer, LoggingEvent loggingEvent)
    {
      //Assumes logger name is fully qualified classname.  Need smarter code to handle
      //arbitrary logger names.
      string [] names = loggingEvent.LoggerName.Split('.');
      string cat;
      if (Option > 0 && Option < names.Length)
      {
        cat = names[names.Length - Option];
      }
      else
      {
        string cat = names[names.Length - 1];
      }
      writer.Write(setting);
    }

  }

@Jonathan 的想法非常酷，但它确实在您的部分添加了一些额外的编码定义并维护一个新的记录器包装器（但很多人这样做并且并不认为这是一个特别繁重的负担）。当然，我的自定义 PatternLayoutConverter 想法也需要您自定义代码。

另一个缺点是 GetCategory 看起来在每次日志记录调用上调用都可能非常昂贵。

Answer 2

有趣的问题，粗略的尝试...

Log4NetLogger - 日志适配器

public class Log4NetLogger
{
    private readonly ILog _logger;
    private readonly string _category;

    public Log4NetLogger(Type type)
    {
        _logger = LogManager.GetLogger(type);
        _category = GetCategory();
    }

    private string GetCategory()
    {
        var attributes = new StackFrame(2).GetMethod().DeclaringType.GetCustomAttributes(typeof(LoggingCategoryAttribute), false);
        if (attributes.Length == 1)
        {
            var attr = (LoggingCategoryAttribute)attributes[0];
            return attr.Category;
        }
        return string.Empty;
    }

    public void Debug(string message)
    {
        if(_logger.IsDebugEnabled) _logger.Debug(string.Format("[{0}] {1}", _category, message));
    }
}

LoggingCategoryAttribute - 适用于类

[AttributeUsage(AttributeTargets.Class)]
public class LoggingCategoryAttribute : Attribute
{
    private readonly string _category;

    public LoggingCategoryAttribute(string category)
    {
        _category = category;
    }

    public string Category { get { return _category; } }
}

LogTester - 测试实现

[LoggingCategory("LT")]
public class LogTester
{
    private static readonly Log4NetLogger Logger = new Log4NetLogger(typeof(LogTester));

    public void Test()
    {
        Logger.Debug("This log message should have a prepended category");
    }
}