C#日志的自定义输出格式（从零开始掌握C#日志格式自定义技巧）

为什么需要自定义日志格式？

默认情况下，很多日志框架（如 NLog、log4net 或 Microsoft.Extensions.Logging）会以固定格式输出日志。但在实际项目中，我们可能希望：

• 包含时间戳、日志级别、类名、方法名等信息
• 以 JSON 格式输出便于日志收集系统解析
• 高亮错误信息或添加颜色区分不同级别
• 精简输出内容以提升可读性

使用 Microsoft.Extensions.Logging 自定义格式

从 .NET Core 开始，官方推荐使用 Microsoft.Extensions.Logging 进行日志管理。虽然它本身不直接提供格式模板，但我们可以通过实现 ILoggerProvider 和 ILogger 来完全控制输出格式。

不过更简单的方式是配合控制台日志（Console Logger）使用 ConsoleFormatter（.NET 5+ 支持）。下面是一个自定义控制台日志格式的完整示例：

// Program.cs (.NET 6+ 顶级语句)using Microsoft.Extensions.DependencyInjection;using Microsoft.Extensions.Hosting;using Microsoft.Extensions.Logging;var builder = Host.CreateApplicationBuilder(args);// 移除默认的控制台日志提供程序builder.Logging.ClearProviders();// 添加自定义格式的控制台日志builder.Logging.AddConsole(options =>{    options.FormatterName = "CustomFormatter";});// 注册自定义格式器builder.Services.AddSingleton<ConsoleFormatter, CustomConsoleFormatter>();var host = builder.Build();// 使用日志var logger = host.Services.GetRequiredService<ILogger<Program>>();logger.LogInformation("这是一条自定义格式的日志信息。");logger.LogError("这里发生了一个错误！");host.Run();

接下来，我们需要实现 CustomConsoleFormatter 类：

using Microsoft.Extensions.Logging;using Microsoft.Extensions.Logging.Console;using System.Text;public class CustomConsoleFormatter : ConsoleFormatter{    public CustomConsoleFormatter() : base("CustomFormatter") { }    public override void Write<TState>(        in LogEntry<TState> logEntry,        IExternalScopeProvider scopeProvider,        TextWriter textWriter)    {        if (logEntry.Formatter == null)        {            return;        }        var logMessage = logEntry.Formatter(logEntry.State, logEntry.Exception);        // 构建自定义格式：[时间] [级别] [来源] - 消息        var formattedLog = $"[{DateTime.Now:yyyy-MM-dd HH:mm:ss.fff}] " +                          $"[{logEntry.LogLevel}] " +                          $"[{logEntry.Category}] - {logMessage}";        // 可选：根据日志级别设置颜色        if (logEntry.LogLevel == LogLevel.Error || logEntry.LogLevel == LogLevel.Critical)        {            var originalColor = Console.ForegroundColor;            Console.ForegroundColor = ConsoleColor.Red;            textWriter.WriteLine(formattedLog);            Console.ForegroundColor = originalColor;        }        else        {            textWriter.WriteLine(formattedLog);        }    }}

使用 NLog 实现更灵活的格式控制

如果你需要更强大的功能（如文件输出、滚动日志、远程发送等），推荐使用 NLog。NLog 通过配置文件即可轻松实现 C#日志输出格式 的自定义。

首先安装 NuGet 包：

Install-Package NLog

然后创建 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"      autoReload="true"      internalLogLevel="Info"      internalLogFile="internal-nlog.txt">  <targets>    <target xsi:type="Console" name="console"            layout="[${date:format=yyyy-MM-dd HH\:mm\:ss.fff}] [${level:uppercase=true}] [${logger}] ${message} ${exception:format=tostring}" />  </targets>  <rules>    <logger name="*" minlevel="Trace" writeTo="console" />  </rules></nlog>

在代码中使用：

using NLog;class Program{    private static readonly Logger logger = LogManager.GetCurrentClassLogger();    static void Main(string[] args)    {        logger.Info("应用程序启动");        logger.Warn("这是一个警告");        logger.Error(new Exception("模拟异常"), "发生错误");    }}

总结

通过本文，你已经掌握了两种主流的 自定义日志格式教程 方法：使用 .NET 内置的 ConsoleFormatter 和使用 NLog 配置文件。无论你选择哪种方式，都能显著提升日志的可读性和实用性。

记住，良好的日志格式不仅能帮助你快速定位问题，还能为后续的日志分析和监控打下坚实基础。赶快在你的 C# 项目中实践这些 C#日志记录技巧 吧！

—— 学会自定义日志格式，让你的 C# 应用更专业、更易维护 ——