简介
log4net
是 .NET
平台上非常成熟的日志组件,源自 Java
世界的 log4j
。它功能丰富、性能高、配置灵活,是企业应用中常见的日志框架之一。
核心特点
- 支持多种 输出目标(
Appender
):文件、数据库、控制台、远程服务等 - 支持多种 格式化(
Layout
) - 支持 按级别(
Level
)记录日志 - 支持 日志分类(
Logger
分组、命名空间隔离) - 配置灵活,可通过
XML
文件配置,也可通过代码配置 - 支持 异步日志、按文件大小/时间分割
核心组件
Logger
:日志记录入口,按层次结构组织(如Namespace.Class
)Appender
:日志输出目标(文件、数据库、控制台等)Layout
:日志消息格式化方式Filter
:日志过滤规则
安装 log4net
dotnet add package log4net
基础使用
添加配置(App.config / Web.config / log4net.config)
在入口类中初始化 log4net
[assembly: log4net.Config.XmlConfigurator(Watch = true)]
class Program
{
private static readonly log4net.ILog log = log4net.LogManager.GetLogger(typeof(Program));
static void Main(string[] args)
{
log.Info("程序启动");
log.Debug("调试信息");
log.Warn("警告信息");
log.Error("错误信息");
log.Fatal("严重错误");
}
}
基本日志记录
log.Debug("调试信息");
log.Info("用户登录: " + username);
log.Warn("磁盘空间不足");
log.Error("数据库连接失败", ex); // 包含异常
log.Fatal("系统崩溃", fatalException);
格式化日志
// 字符串格式化
log.InfoFormat("用户 {0} 从 {1} 登录", username, ipAddress);
// 延迟计算(避免不必要的字符串拼接)
log.Debug(() => $"复杂计算: {ComputeExpensiveValue()}");
上下文信息记录
// 设置线程上下文
log4net.ThreadContext.Properties["User"] = currentUser;
log4net.ThreadContext.Properties["RequestId"] = Guid.NewGuid();
// 配置中使用
常见 Appender 类型
RollingFileAppender(常用)
按文件大小或日期分割文件:
ConsoleAppender
输出到控制台:
AdoNetAppender
将日志写入数据库(如 SQL Server
):
日志过滤 (Filter)
...
常用日志等级
Level | 说明 |
---|---|
ALL |
所有级别(最低) |
DEBUG |
调试信息 |
INFO |
普通信息 |
WARN |
警告 |
ERROR |
错误 |
FATAL |
致命错误(崩溃) |
OFF |
关闭所有日志(最高) |
可以根据不同 logger
设置不同级别:
高级特性
自定义 PatternLayout
public class UserInfoPatternConverter : PatternLayoutConverter
{
protected override void Convert(TextWriter writer, LoggingEvent loggingEvent)
{
var user = ThreadContext.Properties["User"] as string;
writer.Write(user ?? "Anonymous");
}
}
// 注册自定义转换器
日志审计跟踪
public class AuditLogger
{
private static readonly ILog auditLog = LogManager.GetLogger("AuditLogger");
public void LogAction(string action, string target)
{
auditLog.InfoFormat("{0} 执行了 {1} 操作,对象: {2}",
GetCurrentUser(), action, target);
}
}
// 配置中单独设置审计日志
动态配置切换
// 运行时更改日志级别
var logger = (log4net.Repository.Hierarchy.Logger)LogManager.GetLogger("root").Logger;
logger.Level = Level.Debug;
// 重新加载配置文件
log4net.Config.XmlConfigurator.Configure(new FileInfo("new_config.xml"));
配置管理策略
全局异常处理
// ASP.NET MVC
protected void Application_Error()
{
var exception = Server.GetLastError();
log.Fatal("未处理的应用程序异常", exception);
}
// .NET Core 中间件
app.UseExceptionHandler(errorApp =>
{
errorApp.Run(async context =>
{
var exceptionHandler = context.Features.Get();
log.Fatal("未处理的请求异常", exceptionHandler.Error);
await context.Response.WriteAsync("内部错误");
});
});
请求跟踪中间件
public class RequestLoggingMiddleware
{
private readonly RequestDelegate _next;
private readonly ILog _log = LogManager.GetLogger(typeof(RequestLoggingMiddleware));
public RequestLoggingMiddleware(RequestDelegate next)
{
_next = next;
}
public async Task Invoke(HttpContext context)
{
var sw = Stopwatch.StartNew();
await _next(context);
sw.Stop();
_log.InfoFormat("{0} {1} 响应 {2} 耗时 {3}ms",
context.Request.Method,
context.Request.Path,
context.Response.StatusCode,
sw.ElapsedMilliseconds);
}
}
性能优化
启用缓冲:减少 I/O 操作频率
使用异步记录器(需要 log4net.Ext.Json)
避免不必要的日志:
// 使用 IsXXXEnabled 检查
if (log.IsDebugEnabled)
{
log.Debug(ComputeExpensiveDebugInfo());
}
不同环境中的集成
ASP.NET Core 集成
// Program.cs
using Microsoft.Extensions.Logging;
using log4net.Extensions.Logging;
var builder = WebApplication.CreateBuilder(args);
// 配置 log4net
builder.Logging.AddLog4Net(new Log4NetProviderOptions {
Log4NetConfigFile = "log4net.config"
});
// 其他配置...
控制台应用集成
// 手动加载配置
XmlConfigurator.Configure(new FileInfo("log4net.config"));
依赖注入集成
// 在 Startup.cs 中注册
services.AddLogging(loggingBuilder => {
loggingBuilder.AddLog4Net();
});