Serilog格式化输出中文乱码如何解决？

Question

在使用Serilog进行日志记录时，若日志中包含中文字符，在控制台或文件输出中出现乱码（如“中文”），通常是由于编码未正确设置所致。尤其在Windows平台，默认控制台编码可能为GB2312或非UTF-8，而Serilog输出未显式指定编码格式，导致中文无法正确解析。常见于Console、File等接收器。如何确保Serilog在格式化输出时正确显示中文？

Answer 1

一、Serilog中文乱码问题的根源分析

在使用Serilog进行日志记录时，若日志中包含中文字符，在控制台或文件输出中出现类似“中文”的乱码现象，本质上是字符编码不一致导致的解析错误。尤其在Windows系统中，控制台默认使用GBK或GB2312编码（代码页936），而Serilog默认以UTF-8格式写入日志，但未显式声明编码方式，导致接收端（如控制台、文本编辑器）误用本地编码解码UTF-8字节流，从而产生乱码。

该问题常见于以下接收器：

• Serilog.Sinks.Console：控制台输出依赖系统默认编码
• Serilog.Sinks.File：文件写入未指定编码时可能使用环境默认编码
• Serilog.Sinks.RollingFile：滚动日志文件同样受编码影响

二、编码基础与平台差异

平台/环境	默认控制台编码	推荐日志编码	典型表现
Windows (简体中文)	GB2312 / Code Page 936	UTF-8	中文显示为“中垇”类乱码
Linux / macOS	UTF-8	UTF-8	通常正常显示
PowerShell	Unicode 或 OEM	需手动设置	部分终端显示异常
Visual Studio 输出窗口	依赖项目配置	建议统一为 UTF-8	调试时可能出现乱码

三、解决方案层级递进

1. 设置控制台输出编码为UTF-8
2. 配置文件接收器显式指定UTF-8编码
3. 全局环境层面统一编码策略
4. 结合日志结构化与序列化编码处理

四、具体实施步骤

using Serilog;

Log.Logger = new LoggerConfiguration()
    .WriteTo.Console(outputTemplate: "[{Timestamp:HH:mm:ss} {Level:u3}] {Message:lj}{NewLine}{Exception}")
    .WriteTo.File("logs/log.txt", 
                  encoding: System.Text.Encoding.UTF8, 
                  rollingInterval: RollingInterval.Day)
    .CreateLogger();
    

关键参数说明：

• encoding: Encoding.UTF8：确保文件写入使用UTF-8编码
• 控制台可通过程序启动时设置：Console.OutputEncoding = Encoding.UTF8;
• 对于Windows CMD，可运行 chcp 65001 切换到UTF-8代码页

五、流程图：Serilog中文日志输出处理流程

graph TD
            A[应用程序生成中文日志] --> B{是否指定编码?}
            B -- 否 --> C[使用系统默认编码]
            C --> D[控制台/文件按本地编码解析]
            D --> E[出现乱码]
            B -- 是 --> F[强制使用UTF-8编码输出]
            F --> G[接收端以UTF-8解码]
            G --> H[正确显示中文]
            H --> I[日志可读性保障]

六、高级配置建议

在实际企业级应用中，建议将编码设置纳入基础设施标准化范畴：

• 在Program.cs或入口点添加：
  System.Console.OutputEncoding = System.Text.Encoding.UTF8;
• 使用appsettings.json配置文件定义Sink行为，包括编码选项
• 对远程日志聚合系统（如Seq、Elasticsearch），确保传输过程保持UTF-8一致性
• 测试环节加入多语言日志验证用例，覆盖中文、日文、特殊符号等场景
• 避免使用过时的Serilog.Sinks.RollingFile，推荐升级至Serilog.Sinks.File支持更好编码控制
• 考虑启用BOM（Byte Order Mark）以帮助编辑器识别UTF-8：
  new StreamWriter(stream, new UTF8Encoding(encoderShouldEmitUTF8Identifier: true))