在C#代码中应用Log4Net系列教程(附源代码)

引言：为什么需要日志记录？当你开发一个C#应用程序时，代码就像一个黑盒子——你只能看到输入和输出，但中间发生了什么？程序崩溃时，你只能盯着“未处理异常”的红色错误，却不知道问题出在哪个方法、哪个变量。这时，日志记录就像给程序装了一个“黑匣子”，记录下每一步的执行过程。而Log4Net正是C#中最流行的日志框架之一，它简单、灵活，能帮你轻松实现日志记录。本教程将带你从零开始，逐步掌握Log4Net的配置、集成和进阶用法，并提供完整的源代码示例。## 第一步：安装Log4Net### 通过NuGet安装在Visual Studio中，打开“工具” -> “NuGet包管理器” -> “管理解决方案的NuGet程序包”，搜索“log4net”，点击安装。或者使用包管理器控制台：Install-Package log4net安装后，你的项目会自动引用Log4Net的DLL文件。## 第二步：配置Log4Net（使用App.config）Log4Net的配置有两种常见方式：通过App.config文件或独立的log4net.config文件。这里我们选择App.config，因为它与应用程序配置绑定。在App.config中添加以下配置：xml<?xml version="1.0" encoding="utf-8" ?><configuration> <configSections> <section name="log4net" type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" /> </configSections> <log4net> <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender"> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" /> </layout> </appender> <appender name="FileAppender" type="log4net.Appender.FileAppender"> <file value="logs/app.log" /> <appendToFile value="true" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" /> </layout> </appender> <root> <level value="ALL" /> <appender-ref ref="ConsoleAppender" /> <appender-ref ref="FileAppender" /> </root> </log4net></configuration>配置说明：-appender：日志的输出目标。这里有两个：ConsoleAppender（控制台输出）和FileAppender（文件输出）。-layout：日志的输出格式。PatternLayout允许你自定义格式，例如%date（日期）、%level（日志级别）等。-root：根日志记录器，设置默认级别为ALL（记录所有日志），并引用两个appender。## 第三步：在代码中初始化Log4Net在应用程序启动时（例如Program.cs的Main方法中），调用XmlConfigurator.Configure()来加载配置。### 代码示例1：基础日志记录csharpusing log4net;using log4net.Config;class Program{ // 创建日志记录器实例 private static readonly ILog log = LogManager.GetLogger(typeof(Program)); static void Main(string[] args) { // 加载App.config中的log4net配置 XmlConfigurator.Configure(); // 记录不同级别的日志 log.Debug("这是调试信息，用于开发阶段"); log.Info("应用程序启动成功"); log.Warn("警告：内存使用率超过80%"); log.Error("错误：数据库连接超时"); log.Fatal("致命错误：系统崩溃"); Console.WriteLine("日志记录完成，请查看控制台和logs/app.log文件"); Console.ReadLine(); }}运行结果：你会在控制台看到类似以下输出：2023-10-01 14:30:00,123 [1] DEBUG Program - 这是调试信息，用于开发阶段2023-10-01 14:30:00,125 [1] INFO Program - 应用程序启动成功...同时，logs/app.log文件也会记录相同的日志。## 第四步：进阶用法——分类日志与自定义过滤器在实际项目中，你可能需要根据模块（如“用户模块”、“订单模块”）分别记录日志，或者只记录错误级别以上的日志。Log4Net允许你创建多个日志记录器，每个拥有独立的配置。### 代码示例2：多模块日志记录假设你有一个订单处理系统，包含用户模块和订单模块，我们希望：- 用户模块：记录所有级别的日志，输出到“UserLog.txt”- 订单模块：只记录错误和致命日志，输出到“OrderLog.txt”App.config配置：xml<log4net> <!-- 用户模块的appender --> <appender name="UserFileAppender" type="log4net.Appender.FileAppender"> <file value="logs/UserLog.txt" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level - %message%newline" /> </layout> </appender> <!-- 订单模块的appender，只记录错误及以上 --> <appender name="OrderFileAppender" type="log4net.Appender.FileAppender"> <file value="logs/OrderLog.txt" /> <threshold value="ERROR" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level - %message%newline" /> </layout> </appender> <!-- 用户模块日志记录器 --> <logger name="UserModule" additivity="false"> <level value="ALL" /> <appender-ref ref="UserFileAppender" /> </logger> <!-- 订单模块日志记录器 --> <logger name="OrderModule" additivity="false"> <level value="ERROR" /> <appender-ref ref="OrderFileAppender" /> </logger></log4net>C#代码：csharpusing log4net;using log4net.Config;class OrderProcessing{ // 为不同模块创建独立的日志记录器 private static readonly ILog userLog = LogManager.GetLogger("UserModule"); private static readonly ILog orderLog = LogManager.GetLogger("OrderModule"); static void Main(string[] args) { XmlConfigurator.Configure(); // 用户模块操作 userLog.Info("用户登录成功：张三"); userLog.Debug("用户权限检查通过"); userLog.Error("用户登录失败：密码错误"); // 订单模块操作 orderLog.Info("订单创建成功：Order#12345"); // 这行不会被记录（级别低于ERROR） orderLog.Error("订单支付失败：余额不足"); orderLog.Fatal("订单系统异常：数据库连接丢失"); Console.WriteLine("请查看 logs/UserLog.txt 和 logs/OrderLog.txt 文件"); }}运行结果：-UserLog.txt：包含所有级别的日志（调试、信息、错误）-OrderLog.txt：只包含错误和致命日志（orderLog.Info不会被记录）## 第五步：常见问题与最佳实践### 1. 日志文件太大怎么办？使用RollingFileAppender代替FileAppender，它可以按日期或文件大小自动分割日志文件：xml<appender name="RollingFile" type="log4net.Appender.RollingFileAppender"> <file value="logs/AppLog.log" /> <rollingStyle value="Date" /> <datePattern value="yyyyMMdd" /> <staticLogFileName value="false" /> <layout type="log4net.Layout.PatternLayout"> <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" /> </layout></appender>### 2. 如何记录异常对象的堆栈信息？使用log.Error("错误描述", 异常对象)的重载方法，Log4Net会自动记录堆栈：csharptry{ // 可能抛出异常的代码}catch (Exception ex){ log.Error("数据库操作失败", ex); // 第二个参数传入异常对象}### 3. 性能优化——使用条件日志在调试级别，如果日志不输出，字符串拼接会浪费性能。使用IsDebugEnabled检查：csharpif (log.IsDebugEnabled){ log.Debug($"用户ID={userId}，操作耗时={elapsed}ms");}## 总结Log4Net是C#开发的“瑞士军刀”，通过简单的配置就能实现强大的日志功能。本教程从安装、配置、基础用法到进阶多模块日志，逐步带你掌握其核心用法。记住：-日志级别控制记录范围（DEBUG < INFO < WARN < ERROR < FATAL）-Appender决定输出位置（控制台、文件、数据库等）-Logger隔离不同模块的日志立即在你的项目中集成Log4Net，它会在调试、监控和故障排查中成为你的得力助手。完整的源代码已随教程提供，你可以直接运行测试。