C#的日志记录(Logging)是什么?如何集成Serilog或NLog?

来源:这里教程网 时间:2026-02-21 17:30:07 作者:

日志记录(Logging)在C#开发中是用于跟踪应用程序运行状态、捕获错误信息和调试问题的重要手段。它帮助开发者了解程序执行流程,尤其是在生产环境中排查异常或性能瓶颈时非常关键。

.NET 提供了内置的 ILogger 接口和默认的日志提供程序(如 Console、Debug、EventLog 等),但第三方日志框架如 SerilogNLog 功能更强大,支持结构化日志、多种输出目标(文件、数据库、网络服务等)以及灵活的配置方式。

集成 Serilog

Serilog 以结构化日志著称,适合将日志写入 JSON 格式并对接 ELK、Seq 等分析平台。

1. 安装 NuGet 包
在项目中安装以下包: Serilog.AspNetCore(用于 ASP.NET Core 集成) Serilog.Sinks.Console(控制台输出) Serilog.Sinks.File(文件输出) 可通过 Package Manager 或 CLI 执行:
dotnet add package Serilog.AspNetCore
dotnet add package Serilog.Sinks.Console  
dotnet add package Serilog.Sinks.File
2. 配置 Serilog
Program.cs 中配置:
using Serilog;
var builder = WebApplication.CreateBuilder(args);
// 配置 Serilog
builder.Host.UseSerilog((context, services, configuration) => configuration
    .WriteTo.Console()
    .WriteTo.File("logs/log-.txt", rollingInterval: RollingInterval.Day)
    .ReadFrom.Services(services)
    .Enrich.FromLogContext());
var app = builder.Build();
app.Run();
3. 使用 ILogger
在控制器或其他服务中注入 ILogger 即可使用:
public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;
    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }
    public IActionResult Index()
    {
        _logger.LogInformation("访问了首页");
        return View();
    }
}

集成 NLog

NLog 是一个高性能、易于配置的日志框架,支持大量目标和规则过滤。

1. 安装 NuGet 包
安装以下包: NLog.Extensions.Logging NLog.Config(可通过模板生成 nlog.config) 命令示例:
dotnet add package NLog.Extensions.Logging
dotnet add package NLog.Config
2. 添加 nlog.config 配置文件
在项目根目录添加 nlog.config,内容如下:
<?xml version="1.0" encoding="utf-8"?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <targets>
    <target xsi:type="File" name="fileTarget" 
            fileName="logs/${shortdate}.log" 
            layout="${longdate} ${level} ${message} ${exception}" />
    <target xsi:type="Console" name="consoleTarget" />
  </targets>
  <rules>
    <logger name="*" minlevel="Trace" writeTo="fileTarget,consoleTarget" />
  </rules>
</nlog>
确保设置该文件的“复制到输出目录”为“始终复制”。 3. 在 Program.cs 中启用 NLog
using NLog;
using NLog.Web;
var builder = WebApplication.CreateBuilder(args);
// 添加 NLog
builder.Host.UseNLog();
var app = builder.Build();
app.Run();
4. 使用 ILogger
与 Serilog 一样,通过依赖注入使用标准 ILogger 接口写日志。

选择建议

Serilog 更适合需要结构化日志、集中式日志分析的场景,比如微服务架构中对接 Seq 或 Elasticsearch。

NLog 配置灵活、性能高,适合传统企业应用或对日志路由有复杂需求的项目。

两者都支持 .NET 的 Microsoft.Extensions.Logging 抽象层,因此可以无缝替换内置日志提供者。

基本上就这些。根据项目需求选一个,配置好后统一用 ILogger 写日志即可。

相关推荐