如何为独立的类库程序集配置和启用 log4net？

Question

背景

我正在 C# .NET 3.5 中编写一个类库程序集，用于与其他应用程序集成，包括第三方商业现成 (COTS) 工具。 因此，有时这个类库会被我控制的应用程序（EXE）调用，而有时它会被我不控制的其他DLL或应用程序调用。

假设

• 我使用的是 C# 3.0、.NET 3.5 SP1 和 Visual Studio 2008 SP1
• 我使用的是 log4net 1.2.10.0 或更高

版本 限制

任何解决方案都必须：

• 允许类库通过其自己的配置文件启用和配置日志记录（如果调用）应用程序未配置 log4net。
• 允许类库通过调用应用程序配置启用和配置日志记录，

如果指定了 log4net 信息，则

• 或者允许类库始终使用其自己的配置文件启用和配置日志记录。

问题

当我的独立类库由我无法控制的 DLL 或应用程序（例如第三方 COTS 工具）调用并且未指定 log4net 配置信息时，我的类库无法执行任何操作记录。

---

问题

如何为独立类库程序集配置和启用 log4net，以便无论调用应用程序是否提供 log4net 配置它都会记录日志？

Answer 1

您可以在这里找到一个很好的描述：
log4net：快速入门指南

该文章描述了，要分别在每个程序集之前配置它，请为名为 AssemblyName.dll.log4net 的程序集创建一个 XML 文件，并将以下 XML 代码放入其中：

<?xml version="1.0" encoding="utf-8"?>
<log4net debug="false">
   <appender name="XmlSchemaFileAppender" type="log4net.Appender.FileAppender">
      <file value="AppLog.xml" />
      <appendToFile value="true" />
      <lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
      <layout type="log4net.Layout.XmlLayout" />
   </appender>

   <root>
      <level value="WARN" />
      <appender-ref ref="XmlSchemaFileAppender" />
   </root>
</log4net>

它进一步描述了实例化新记录器，只需将其声明为整个类的变量，如下所示：

public class LogSample
{
    private static readonly log4net.ILog Log 
            = log4net.LogManager.GetLogger(typeof(LogSample));
    // Class Methods Go Here...
}

然后您可以在类中使用私有变量Log，例如：

Log.Info("Sample message");

同样，您可以使用Log.Error(“运行时发生错误” myMethod", ex) 来记录错误以及异常详细信息。

我发现的是以下内容：

• 不要忘记调用 log4net.Config.XmlConfigurator.Configure(); 来激活您的配置

• 如果您需要知道写入文件的路径，这里一些代码如何从L​​og4Net获取它

我希望这有帮助。

Answer 2

这对我来说适用于共享库

protected static readonly log4net.ILog log = log4net.LogManager.GetLogger(System.Reflection.Assembly.GetExecutingAssembly().GetType());

Answer 3

解决方案 1

第一组约束的解决方案基本上是包装 log4net。 LogManager 到您自己的自定义 LogManager 类中，例如 雅各布，Jeroen，和 McWafflestix 已建议（请参阅下面的代码）。

不幸的是，log4net.LogManager 类是静态的，C# 不支持静态继承，因此您不能简单地继承它并重写 GetLogger 方法。
log4net.LogManager 类，所以这当然是可能的。

此解决方案的另一个缺点是，如果您有现有的代码库（在我的例子中就是这样做的），您将必须用包装类替换对 log4net.LogManager 的所有现有调用。 然而对于今天的重构工具来说这没什么大不了的。

对于我的项目，这些缺点超过了使用调用应用程序提供的日志配置的好处，因此，我选择了解决方案 2。

代码

首先，您需要一个 LogManager 包装类：

using System;
using System.IO;
using log4net;
using log4net.Config;

namespace MyApplication.Logging
{
    //// TODO: Implement the additional GetLogger method signatures and log4net.LogManager methods that are not seen below.
    public static class LogManagerWrapper
    {
        private static readonly string LOG_CONFIG_FILE= @"path\to\log4net.config";

        public static ILog GetLogger(Type type)
        {
            // If no loggers have been created, load our own.
            if(LogManager.GetCurrentLoggers().Length == 0)
            {
                LoadConfig();
            }
            return LogManager.GetLogger(type);
        }

        private void LoadConfig()
        {
           //// TODO: Do exception handling for File access issues and supply sane defaults if it's unavailable.   
           XmlConfigurator.ConfigureAndWatch(new FileInfo(LOG_CONFIG_FILE));
        }              
}

然后在您的类中，而不是：

private static readonly ILog log = LogManager.GetLogger(typeof(MyApp));

使用：

private static readonly ILog log = LogManagerWrapper.GetLogger(typeof(MyApp));

---

方案 2

解决 根据我的目的，我决定采用满足第二组约束的解决方案。 请参阅下面的代码了解我的解决方案。

来自 Apache log4net 文档：

“程序集可以选择使用命名的日志存储库而不是默认存储库，这将程序集的日志记录与应用程序的其余部分完全分开，这对于希望为其组件使用 log4net 但又不想要求所有这些的组件开发人员非常有用。使用其组件的应用程序知道 log4net。这也意味着它们的调试配置与应用程序配置分开。程序集应指定 RepositoryAttribute 来设置其日志记录存储库。”

代码

我将以下几行放在了我的类库的 AssemblyInfo.cs 文件：

//Log4Net配置文件位置 
  [程序集：log4net.Config.Repository（“CompanyName.IntegrationLibName”）] 
  [程序集：log4net.Config.XmlConfigurator（ConfigFile =“CompanyName.IntegrationLibName.config”，Watch = true）] 
  

     

参考文献

• LogManagerMembers
• 雅各布的回答
• 杰罗恩的回答
• McWafflestix 的回答
• log4net 手册 - 存储库
• 来自类库 (dll) 的 log4NET

Answer 4

您可以围绕 XmlConfigurator 类编写一些代码：

public static class MyLogManager
{
    // for illustration, you should configure this somewhere else...
    private static string configFile = @"path\to\log4net.config";

    public static ILog GetLogger(Type type)
    {
        if(log4net.LogManager.GetCurrentLoggers().Length == 0)
        {
            // load logger config with XmlConfigurator
            log4net.Config.XmlConfigurator.Configure(configFile);
        }
        return LogManager.GetLogger(type);
    }
}

然后在你的类中，而不是：

private static readonly ILog log = LogManager.GetLogger(typeof(MyApp));

使用：

private static readonly ILog log = MyLogManager.GetLogger(typeof(MyApp));

当然，最好让这个类成为一个服务并使用你选择的 IoC 容器动态配置它，但是你明白了吗？

编辑：修复了评论中指出的 Count() 问题。

Answer 5

在代码中，您可以通过检查是否有任何记录器，

log4net.LogManager.GetCurrentLoggers().Count()

然后您可以使用 XmlConfigurator 从文件加载默认配置：

log4net.Config.XmlConfigurator.Configure(configFile)

您可以在静态或常规构造函数中进行初始化。

class Sample
{
    private static readonly log4net.ILog LOG;

    static Sample()
    {
        if (log4net.LogManager.GetCurrentLoggers().Count() == 0)
        {
            loadConfig();
        }
        LOG = log4net.LogManager.GetLogger(typeof(Sample));

    }

    private static void loadConfig()
    {
        /* Load your config file here */
    }

    public void YourMethod()
    {
       LOG.Info("Your messages");
    }
}

Answer 6

在独立类库中，有一个使用 log4net.Config.XmlConfigurator 加载 log4net 配置文件的单例。

具体来说，您可以定义所有代码以使用您自己的自定义日志记录类； 这个类可以只是 log4net 日志记录调用的简单包装，但有一个补充； 创建一个静态成员，其中包含您要记录的日志信息； 通过调用该类的静态构造函数中的 XmlConfigurator 来初始化它。 这就是你所要做的。