如何为Microsoft.Extensions.Logging日志参数设置默认DateTime格式

原生Microsoft.Extensions.Logging（MEL）并没有直接提供全局配置DateTime参数默认格式化的开关，但可以通过以下几种方式实现，无需修改现有日志调用代码：

方案1：自定义Console日志格式化器（原生MEL） #

如果你的日志输出目标是控制台，可以通过自定义ConsoleFormatter来全局拦截并修改DateTime类型参数的格式化逻辑：

步骤1：实现自定义格式化器 #

using Microsoft.Extensions.Logging;
using Microsoft.Extensions.Logging.Console;
using System.Collections.Generic;
using System.Linq;
using System.Text;

public class CustomDateTimeConsoleFormatter : ConsoleFormatter
{
    private readonly ConsoleFormatterOptions _options;
    private const string OriginalFormatKey = "{OriginalFormat}";

    public CustomDateTimeConsoleFormatter(ConsoleFormatterOptions options) 
        : base(nameof(CustomDateTimeConsoleFormatter))
    {
        _options = options;
    }

    public override void Write<TState>(in LogEntry<TState> logEntry, IExternalScopeProvider scopeProvider, TextWriter textWriter)
    {
        string formattedMessage = logEntry.Formatter(logEntry.State, logEntry.Exception);
        
        // 仅当状态为结构化日志键值对时，替换DateTime格式
        if (logEntry.State is IEnumerable<KeyValuePair<string, object?>> keyValuePairs)
        {
            var stateDict = keyValuePairs.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
            if (stateDict.TryGetValue(OriginalFormatKey, out var templateObj) && templateObj is string messageTemplate)
            {
                var args = new List<object?>();
                foreach (var kvp in stateDict.Where(k => k.Key != OriginalFormatKey))
                {
                    if (kvp.Value is DateTime dt)
                    {
                        args.Add(dt.ToString("yyyy-MM-dd HH:mm:ss")); // 替换为你需要的格式
                    }
                    else if (kvp.Value is DateTimeOffset dto)
                    {
                        args.Add(dto.ToString("yyyy-MM-dd HH:mm:ss zzz"));
                    }
                    else
                    {
                        args.Add(kvp.Value);
                    }
                }
                formattedMessage = string.Format(messageTemplate, args.ToArray());
            }
        }

        // 输出日志级别、消息等（可根据需求调整格式）
        var logBuilder = new StringBuilder();
        logBuilder.Append($"[{logEntry.LogLevel}] ");
        logBuilder.Append(formattedMessage);
        
        if (logEntry.Exception != null)
        {
            logBuilder.AppendLine().Append(logEntry.Exception);
        }

        textWriter.WriteLine(logBuilder.ToString());
    }
}

步骤2：注册自定义格式化器 #

在Program.cs中配置日志服务时，替换默认的Console格式化器：

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddLogging(loggingBuilder =>
{
    loggingBuilder.AddConsole(options =>
    {
        // 指定使用自定义格式化器
        options.FormatterName = nameof(CustomDateTimeConsoleFormatter);
    })
    // 注册自定义格式化器及其配置选项
    .AddConsoleFormatter<CustomDateTimeConsoleFormatter, ConsoleFormatterOptions>();
});

var app = builder.Build();
// ... 其他配置

方案2：集成第三方日志框架（如Serilog） #

如果项目可以集成第三方日志框架，这类框架通常提供更灵活的全局格式化配置。以Serilog为例：

步骤1：安装依赖包 #

Install-Package Serilog.AspNetCore

步骤2：配置全局DateTime格式 #

在Program.cs中初始化Serilog并配置输出模板：

using Serilog;

var builder = WebApplication.CreateBuilder(args);

// 配置Serilog，全局指定DateTime格式
Log.Logger = new LoggerConfiguration()
    .WriteTo.Console(outputTemplate: "[{Timestamp:yyyy-MM-dd HH:mm:ss}] [{Level:u3}] {Message:lj}{NewLine}{Exception}")
    .CreateLogger();

// 替换MEL默认日志提供者为Serilog
builder.Services.AddLogging(loggingBuilder =>
{
    loggingBuilder.ClearProviders();
    loggingBuilder.AddSerilog();
});

var app = builder.Build();
// ... 其他配置

这种方式下，所有通过ILogger输出的DateTime参数都会自动按照模板中指定的格式输出，无需修改任何现有日志调用。

内容的提问来源于stack exchange，提问作者EM0