基于C#、Visual Studio 2017以及.NET Framework 4.5的Log4Net使用教程

ops/2024/11/15 3:51:20/

在使用Log4Net记录日志时，以下是一个基于C#、Visual Studio 2017以及.NET Framework 4.5的详细步骤教程。这个教程适合初学者，会从添加Log4Net库、配置日志、编写日志记录代码等方面进行说明。

步骤1：安装Log4Net

通过NuGet安装
- 打开您的Visual Studio 2017。
- 右键点击解决方案资源管理器中的项目，选择“管理NuGet程序包”。
- 在浏览标签页中，搜索“log4net”。
- 从搜索结果中选择“log4net”，点击“安装”。

步骤2：配置Log4Net

创建配置文件段

如果是Windows窗体应用或控制台应用，您应该在App.config文件中添加配置；对于ASP.NET应用，则在Web.config中添加。

在相应的配置文件内添加以下XML配置段作为示例，定义一个控制台Appender和一个滚动文件Appender：

<configuration><configSections><section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net"/></configSections><log4net><!-- 控制台Appender --><appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender"><layout type="log4net.Layout.PatternLayout"><conversionPattern value="%date{ABSOLUTE} %level %logger - %message%newline"/></layout></appender><!-- 滚动文件Appender --><appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender"><file value="Logs\\log-file.txt"/><appendToFile value="true"/><rollingStyle value="Size"/><maxSizeRollBackups value="5"/><maximumFileSize value="10MB"/><staticLogFileName value="true"/><layout type="log4net.Layout.PatternLayout"><conversionPattern value="%date{ABSOLUTE} %level %logger - %message%newline"/></layout></appender><!-- 根记录器配置 --><root><level value="ALL"/><appender-ref ref="ConsoleAppender"/><appender-ref ref="RollingFileAppender"/></root></log4net>
</configuration>

步骤3：初始化Log4Net

在应用程序启动时配置Log4Net
- 对于控制台应用，在Program.cs的Main方法开始处加入：
```
1log4net.Config.XmlConfigurator.Configure();
```
- 对于ASP.NET应用，在Global.asax.cs的Application_Start方法中加入：
```
1log4net.Config.XmlConfigurator.Configure();
```
- 或者，如果您希望从自定义配置文件加载配置，可以这样写（在任何适用的地方执行一次即可）：
```
1log4net.Config.XmlConfigurator.Configure(new FileInfo("CustomLog4Net.config"));
```
步骤4：在代码中使用Log4Net记录日志

声明并使用ILog实例

在需要记录日志的类中，声明一个ILog类型的静态字段，并在构造函数中初始化它。
```
1private static readonly ILog log = LogManager.GetLogger(typeof(YourClassName));
```

然后，在需要记录日志的地方，使用ILog实例：

1log.Debug("This is a debug message.");
2log.Info("This is an info message.");
3log.Warn("This is a warning message.");
4log.Error("This is an error message.");
5log.Fatal("This is a fatal error message.");