Windows 上的 log4net 表单不写入日志文件

log4net on Windows Forms doesn't write log file

我正在使用 .NET Framework 4.0 和 log4net 1.2.13 开发 Windows 表单应用程序。

这是我第一次在 Windows Form 应用程序中使用 log4net,但它不起作用。也许我现在忘记了一个配置步骤螺母,它不起作用:我找不到日志文件

这就是我实例记录器的方式:

public partial class MainForm : Form
{
    private static readonly log4net.ILog _logger =
        log4net.LogManager.GetLogger(typeof(MainForm));

这是App.Config内容:

<log4net xsi:noNamespaceSchemaLocation="http://csharptest.net/downloads/schema/log4net.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <appender type="log4net.Appender.RollingFileAppender" name="AppLogErrorAppender">
    <file value="D:\AppError.log" />
    <appendToFile value="true" />
    <rollingStyle value="Date" />
    <datePattern value=".yyyyMMdd.lo\g" />
    <maximumFileSize value="5MB" />
    <maxSizeRollBackups value="-1" />
    <countDirection value="1" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date %-5level [%thread] %logger - %message%newline%exception" />
    </layout>
  </appender>
  <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date %-5level [%thread] %logger - %message%newline%exception" />
    </layout>
  </appender>
  <logger name="AppLog">
    <level value="ERROR" />
    <appender-ref ref="AppLogErrorAppender" />
  </logger>
  <root>
      <level value="ERROR" />
      <appender-ref ref="AppLogErrorAppender" />
      <appender-ref ref="ConsoleAppender" />
  </root>
</log4net>

我在这里登录:

public const string LogExceptionNameMessageFormatString = "EXCEPTION: {0} - Message: {1}";

private void LogError(string exceptionMessage, string exceptionName)
{
    _logger.ErrorFormat(LogExceptionNameMessageFormatString, exceptionName, exceptionMessage);
}

我在上面设置了一个断点,它就停止了。

我做错了什么?

您需要致电:

  XmlConfigurator.Configure();

在记录任何东西之前。这将初始化 log4net 并读取配置。

Program.cs:

[STAThread]
private static void Main(string[] args)
{
    log4net.Config.XmlConfigurator.Configure();

    /* other stuff */
}

我通常也会在配置后立即在 void Main 中记录一些内容。

App.config:

您需要记住将 log4net 配置部分作为 <configSections>:

的第一个元素
<?xml version="1.0" encoding="utf-8"?>
<configuration>
        <configSections>
                <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/>
        </configSections>
        <startup>
                <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
        </startup>

        <log4net>
                <appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
                        <file value="log.log"/>
                        <appendToFile value="true"/>
                        <rollingStyle value="Size"/>
                        <maxSizeRollBackups value="1"/>
                        <maximumFileSize value="5MB"/>
                        <staticLogFileName value="true"/>
                        <layout type="log4net.Layout.PatternLayout">
                                <conversionPattern value="%newline%date [%thread] %-5level %logger - %message%newline%exception"/>
                        </layout>
                </appender>

                <appender name="DebugAppender" type="log4net.Appender.DebugAppender">
                        <immediateFlush value="true"/>
                        <layout type="log4net.Layout.PatternLayout">
                                <conversionPattern value="%newline%date [%thread] %property{detailContext} %-5level %logger - %message%newline%exception"/>
                        </layout>
                </appender>

                <root>
                        <level value="ALL"/>
                        <appender-ref ref="DebugAppender"/>
                        <appender-ref ref="RollingFileAppender"/>
                </root>
        </log4net>
</configuration>

我花了一些时间在我的应用程序中设置 log4net 并让它开始工作。这是我学到的:

在您的代码中引用 log4net,通过调用 GetLogger 创建日志并使用其中一种记录方法写入日志。

using log4net;
...
private static ILog Log;
...
Log = log4net.LogManager.GetLogger("Ref-A");
Log.Info("test-A");
Log = log4net.LogManager.GetLogger(MethodBase.GetCurrentMethod().Name);
Log.Debug("test-B");

2018-05-29 21:32:58,574 [1] Ref-A - testA
2018-05-29 21:32:58,575 [1] MyMethod - testB

调用 GetLogger 时,您向其传递一个字符串,作为日志行的前缀,通常是当前 class and/or 方法。

在 AssemblyInfo.cs 中,您需要添加以下行之一。您可以使用 using 子句引用 log4net.Config 或为 XmlConfigurator 的调用添加前缀。

第一个语法,w/o 指定文件名将使用 App.config。我发现在文档和一些帖子中提到的第二种语法是使用单独的 log4net.config 文件。最后,如果在依赖程序集中使用 log4net,则需要指定将生成的配置文件的名称,以便 log4net 在那里查找,而不是在调用应用程序中查找 App.config.

//use App.config
using log4net.Config;
[assembly: XmlConfigurator(Watch = true)]

//use log4net.config
[assembly: log4net.Config.XmlConfigurator(ConfigFile = "log4net.config",Watch = true)]

//use myLibrary.dll.config
[assembly: log4net.Config.XmlConfigurator(ConfigFile = "myLibrary.dll.config",Watch = true)]

这是我用的App.config。它适用于上面的场景 1 和 3 以及绝对文件路径。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
    </startup>
  <configSections>
    <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
  </configSections>
  <log4net>
    <root>
      <level value="ALL" />
      <appender-ref ref="console" />
      <appender-ref ref="file" />
    </root>
    <appender name="console" type="log4net.Appender.ConsoleAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date %level %logger - %message%newline" />
      </layout>
    </appender>
    <appender name="file" type="log4net.Appender.RollingFileAppender">
      <file value="c:\temp\myLog.log" />
      <appendToFile value="true" />
      <rollingStyle value="Size" />
      <maxSizeRollBackups value="5" />
      <maximumFileSize value="10MB" />
      <staticLogFileName value="true" />
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %level %logger - %message%newline" />
      </layout>
    </appender>
  </log4net>
</configuration>

另外几个提示。

  • 调试时,检查GetLogger返回值的属性——IsDebugEnabled、IsInfoEnabled等——如果都设置为false,说明你的日志配置错误,日志不会写入任何东西。

  • 如果您有多个项目使用 log4net,其中一个无法创建日志,那么其他所有项目也会失败。至少在我的场景中,许多 dll 调用相同的基 class 而基 class 无法创建第一个日志。程序中各处的所有日志也不起作用。