C# log4net日志库的用法小结

下面就详细讲解一下“C# log4net日志库的用法小结”的完整攻略。

1. 什么是log4net

log4net是一个开源的日志库，它可以帮助我们记录应用程序的运行日志，比如错误信息、调试信息、警告信息等。log4net可以支持多种输出方式，比如文件、控制台、数据库等，开发者可以根据自己的需求进行配置。

2. log4net的使用步骤

使用log4net的主要步骤如下：

2.1 引入log4net

首先，需要在项目中引入log4net库。可以通过NuGet来安装log4net库，也可以手动引入。如果是手动引入，需要先从log4net的官网下载最新版的库文件，然后把这个库文件添加到项目中，建议选择强名称的版本。

2.2 配置log4net

接下来，需要在项目中添加一个log4net配置文件，该文件通常命名为log4net.config。log4net配置文件是一个XML文件，可以用于配置输出方式、日志等级、输出格式等。下面是一个简单的配置文件示例：

<?xml version="1.0" encoding="utf-8" ?>
<log4net>
  <appender name="Console" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{1} - %message%newline" />
    </layout>
  </appender>

  <appender name="FileAppender" type="log4net.Appender.RollingFileAppender">
    <file value="logs\" />
    <AppendToFile value="true" />
    <RollingStyle value="Date" />
    <DatePattern value="yyyy-MM-dd'.log'" />
    <StaticLogFileName value="false" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{1} - %message%newline" />
    </layout>
  </appender>

  <root>
    <level value="DEBUG" />
    <appender-ref ref="Console" />
    <appender-ref ref="FileAppender" />
  </root>
</log4net>

在上面的配置文件中，定义了两个输出方式，一个是控制台输出，一个是文件输出，文件输出时按照日期滚动命名。最后将控制台和文件输出都注册到了root节点上，并指定了最低日志级别为DEBUG。

2.3 初始化log4net

在应用程序启动的时候，需要初始化log4net。一般来说，可以通过Application_Start等启动事件来初始化log4net。下面是一个简单的初始化代码示例：

using log4net;
using log4net.Config;

public class Global : System.Web.HttpApplication
{
    private static readonly ILog _log = LogManager.GetLogger(typeof(Global));

    protected void Application_Start(object sender, EventArgs e)
    {
        XmlConfigurator.ConfigureAndWatch(new FileInfo(Server.MapPath("~/log4net.config")));
        _log.Info("Application_Start");
    }
}

通过XmlConfigurator.ConfigureAndWatch方法可以读取log4net配置文件，并初始化log4net。然后通过LogManager.GetLogger方法可以获取一个日志对象，可以在程序中使用该对象来记录日志。

2.4 记录日志

在程序中记录日志时，可以通过日志对象来记录不同级别的日志。下面是一个简单的记录日志的代码示例：

using log4net;

public class HomeController : Controller
{
    private static readonly ILog _log = LogManager.GetLogger(typeof(HomeController));

    public ActionResult Index()
    {
        _log.Debug("Debug message");
        _log.Info("Info message");
        _log.Warn("Warn message");
        _log.Error("Error message", new Exception("Test exception"));
        _log.Fatal("Fatal message");

        return View();
    }
}

在上面的代码示例中，首先获取了一个ILog对象，然后使用该对象记录了不同级别的日志。当需要记录异常信息时，可以将异常对象作为参数传递给Error或Fatal方法。

3. 示例说明

3.1 控制台输出示例

在log4net配置文件中添加以下代码来定义控制台输出：

<appender name="Console" type="log4net.Appender.ConsoleAppender">
    <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{1} - %message%newline" />
    </layout>
</appender>

<root>
    <level value="INFO" />
    <appender-ref ref="Console" />
</root>

在程序中记录日志时，可以调用ILog.Debug、ILog.Info、ILog.Warn、ILog.Error和ILog.Fatal等方法来记录不同级别的日志。下面是一个记录控制台输出日志的示例代码：

using log4net;

public class Program
{
    private static readonly ILog _log = LogManager.GetLogger(typeof(Program));

    static void Main(string[] args)
    {
        XmlConfigurator.ConfigureAndWatch(new FileInfo("log4net.config"));

        _log.Debug("This is a debug message.");
        _log.Info("This is an info message.");
        _log.Warn("This is a warn message.");
        _log.Error("This is an error message.", new Exception("Test exception."));
        _log.Fatal("This is a fatal message.");

        Console.ReadKey();
    }
}

运行代码后，在控制台上可以看到以下输出结果：

2022-05-09 16:20:51 [1] INFO  Program - This is an info message.
2022-05-09 16:20:51 [1] WARN  Program - This is a warn message.
2022-05-09 16:20:51 [1] ERROR Program - This is an error message.
System.Exception: Test exception.
   at ConsoleApp.Program.Main(String[] args) in D:\Code\ConsoleApp\ConsoleApp\Program.cs:line 16
2022-05-09 16:20:51 [1] FATAL Program - This is a fatal message.

可以看到，log4net已经成功地输出了日志信息。

3.2 文件输出示例

在log4net配置文件中添加以下代码来定义文件输出：

<appender name="RollingFile" type="log4net.Appender.RollingFileAppender">
    <file value="logs\" />
    <appendToFile value="true" />
    <rollingStyle value="Date" />
    <datePattern value="yyyy-MM-dd'.log'" />
    <maxSizeRollBackups value="10" />
    <maximumFileSize value="10MB" />
    <staticLogFileName value="true" />
    <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{1} - %message%newline" />
    </layout>
</appender>

<root>
    <level value="INFO" />
    <appender-ref ref="RollingFile" />
</root>

在程序中记录日志时，也可以通过ILog.Debug、ILog.Info、ILog.Warn、ILog.Error和ILog.Fatal等方法来记录不同级别的日志。下面是一个记录文件输出日志的示例代码：

using log4net;

public class Program
{
    private static readonly ILog _log = LogManager.GetLogger(typeof(Program));

    static void Main(string[] args)
    {
        XmlConfigurator.ConfigureAndWatch(new FileInfo("log4net.config"));

        for (int i = 0; i < 100; i++)
        {
            _log.Info($"This is info log {i}");
        }

        Console.ReadKey();
    }
}

运行代码后，在logs目录下可以看到多个日志文件，文件名按照日期命名，比如2022-05-09.log、2022-05-10.log等，每个文件的大小是10MB，超过大小后会滚动到下一个文件中。打开任何一个日志文件，都可以看到该文件中保存了多条日志信息。

4. 总结

以上就是log4net的使用攻略。通过log4net，可以方便地记录应用程序的运行日志，同时支持多种输出方式，更加灵活。