C# 规范化日志记录方法 C#如何使用High-performance logging source generator

直接用 logger 不够高性能，因为每次调用需运行时反射解析参数、拼接模板、构造元数据；而源生成器可编译期生成强类型日志方法，消除运行时开销。

为什么直接用 Logger<t></t> 不够高性能

因为每次调用 LogInformation 等方法时，编译器无法在编译期确定日志事件 ID、参数名、占位符结构，导致运行时必须反射解析参数、拼接消息模板、构造 EventId 和 LogLevel 元数据——这部分开销在高频日志场景（如每秒万级请求）下会明显拖慢吞吐量。

High-performance Logging source generator 的核心价值，就是把日志语句“固化”成编译期生成的强类型方法，跳过所有运行时解析逻辑。

关键前提：你必须使用 .NET 6+、C# 10+，且项目启用源生成器支持（SDK 风格项目默认开启）。

如何启用 microsoft.Extensions.Logging.Generators

这不是 NuGet 包，而是随 .NET SDK 自带的源生成器，但需要显式启用。在 .csproj 中添加以下配置：

<PropertyGroup>   <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>   <CompilerGeneratedFilesOutputPath>obj/GeneratedFiles</CompilerGeneratedFilesOutputPath> </PropertyGroup> <p><ItemGroup> <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" /> </ItemGroup>

注意：Microsoft.Extensions.Logging.Generators 不需要单独安装包，只要引用了 Microsoft.Extensions.Logging（≥6.0），SDK 就会自动发现并启用它。

• 不加 EmitCompilerGeneratedFiles 会导致生成失败且无提示，只看到日志方法没被生成
• 生成的代码默认输出到 obj/GeneratedFiles，可查证是否生成成功（搜索 *LoggingExtensions.g.cs）
• 如果用了第三方日志框架（如 Serilog），该生成器不兼容——它只适配 Microsoft.Extensions.Logging 原生日志抽象

定义 [LoggerMessage] 静态方法的正确姿势

不能写在任意类里。必须放在 Static partial class 中，且方法本身是 static、void 返回、参数不能含 ref/out，且第一个参数必须是 ILogger。

示例：

public static partial class MyLoggingExtensions {     [LoggerMessage(EventId = 100, Level = LogLevel.Information, Message = "User {UserId} logged in from {IpAddress}")]     public static partial void LogUserLogin(this ILogger logger, int userId, string ipAddress); <pre class='brush:php;toolbar:false;'>[LoggerMessage(Level = LogLevel.Error, Message = "Failed to process order {OrderId}: {ErrorMessage}")] public static partial void LogOrderProcessingFailure(this ILogger logger, Guid orderId, string errorMessage);

}

要点：

• 方法名任意，但推荐见名知意；修饰符必须是 public static partial
• EventId 推荐显式指定，避免运行时自增导致 ID 不稳定
• 占位符名称（如 {UserId}）必须与参数名严格一致（大小写敏感），否则生成失败或参数绑定为空
• 不支持复杂表达式（如 {user.Name}），只能是简单参数名
• 生成后，调用 logger.LogUserLogin(123, "192.168.1.1") 就是纯方法调用，零分配、无字符串格式化开销

常见错误和调试技巧

生成失败时，编译器通常只报“找不到方法”，不会提示生成器问题。建议按顺序排查：

• 检查是否遗漏 partial —— 类和方法都必须带 partial 关键字
• 确认 ILogger 参数是第一个，且没有默认值或 Nullable 注解干扰（如 ILogger? 会失败）
• 查看 obj/GeneratedFiles 下是否有对应 .g.cs 文件；没有则说明生成器未触发
• 在 visual studio 中启用“显示所有文件”，展开 obj 目录手动查看生成内容
• 错误信息如 CS8795: Partial method '...' must have an implementation part because it has accessibility modifiers，大概率是 partial 缺失或修饰符不匹配

真正容易被忽略的是：生成器只对 partial 方法生效，一旦你给方法体写了 { }，哪怕空实现，编译器就认为这是你手动实现的，不再调用生成器——所以务必保持方法声明无大括号、无分号后的任何内容。