.NET如何使用log4net或Serilog记录日志

在 .NET 项目中，日志记录是排查问题、监控运行状态的重要手段。log4net 和 Serilog 是两个广泛使用的第三方日志框架，各有特点，使用方式也略有不同。下面分别介绍如何在 .NET（包括 .NET Core/.NET 5+）中配置和使用它们。

使用 log4net 记录日志

log4net 是 Apache log4j 的 .NET 移植版本，基于 XML 配置，灵活但稍显复杂。

1. 安装 NuGet 包

在项目中安装 log4net：

Install-Package log4net

2. 添加配置文件 log4net.config

在项目根目录添加一个名为 log4net.config 的 XML 文件，内容如下：

<?xml version="1.0" encoding="utf-8"?>
<log4net>
  <appender name="FileAppender" type="log4net.Appender.FileAppender">
    <file value="logs\log.txt" />
    <appendToFile value="true" />
    <layout type="log4net.Layout.PatternLayout">
      <conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
    </layout>
  </appender>
  <root>
    <level value="DEBUG" />
    <appender-ref ref="FileAppender" />
  </root>
</log4net>

确保该文件的“复制到输出目录”设置为“始终复制”。

3. 在 AssemblyInfo.cs 或程序启动时加载配置

在 AssemblyInfo.cs 中添加特性（推荐用于传统 .NET Framework）：

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

对于 .NET Core/.NET 5+，建议在 Program.cs 或 Startup.cs 中手动加载：

log4net.Config.XmlConfigurator.Configure(new FileInfo("log4net.config"));

4. 在代码中使用

在需要记录日志的类中创建 logger 实例：

private static readonly ILog log = LogManager.GetLogger(typeof(YourClass));
<p>log.Debug("这是一条调试信息");
log.Info("这是一条普通信息");
log.Error("发生错误", exception);</p>

使用 Serilog 记录日志

Serilog 是现代 .NET 应用中更受欢迎的日志库，支持结构化日志，配置简洁，与 .NET Core 内建日志系统集成良好。

1. 安装 NuGet 包

安装核心包和所需的接收器（sink）：

命令行示例：

Install-Package Serilog

Install-Package Serilog.Sinks.File

Install-Package Serilog.AspNetCore

2. 配置 Serilog

在 Program.cs 中配置日志（以 .NET 6+ 为例）：

using Serilog;
<p>var builder = WebApplication.CreateBuilder(args);</p><p>// 配置 Serilog
builder.Host.UseSerilog((context, services, configuration) => configuration
.WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day)
.WriteTo.Console()
.Enrich.FromLogContext()
.ReadFrom.Configuration(context.Configuration));</p><p>var app = builder.Build();</p>

也可以从 appsettings.json 读取配置：

"Serilog": {
  "MinimumLevel": "Information",
  "WriteTo": [
    { "Name": "Console" },
    {
      "Name": "File",
      "Args": {
        "path": "logs/log-.txt",
        "rollingInterval": "Day"
      }
    }
  ]
}

3. 使用 ILogger 接口记录日志

Serilog 会自动集成到 ASP.NET Core 的依赖注入系统中，控制器或服务中直接注入 ILogger：

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;
<pre class='brush:php;toolbar:false;'>public HomeController(ILogger<HomeController> logger)
{
    _logger = logger;
}
public IActionResult Index()
{
    _logger.LogInformation("访问了首页");
    _logger.LogError("模拟一个错误", new Exception("测试异常"));
    return View();
}

}

4. 支持结构化日志

Serilog 的优势之一是支持结构化日志，例如：

_logger.LogInformation("用户 {UserId} 在 {LoginTime} 登录", userId, DateTime.Now);

这些属性可以被日志分析工具（如 Seq、Elasticsearch）解析和查询。

基本上就这些。log4net 更适合已有老项目迁移，而 Serilog 更适合新项目，尤其是需要结构化日志和云原生部署的场景。选择哪个取决于团队习惯和运维需求。两者都能有效提升应用可观测性。不复杂但容易忽略的是配置文件路径和初始化时机，务必确认日志能正确输出。