0

0

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

幻夢星雲

幻夢星雲

发布时间:2026-02-20 01:41:33

|

417人浏览过

|

来源于php中文网

原创

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

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

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

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

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 中,且方法本身是 staticvoid 返回、参数不能含 ref/out,且第一个参数必须是 ILogger

v0.dev
v0.dev

Vercel推出的AI生成式UI工具,通过文本描述生成UI组件代码

下载

示例:

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 方法生效,一旦你给方法体写了 { },哪怕空实现,编译器就认为这是你手动实现的,不再调用生成器——所以务必保持方法声明无大括号、无分号后的任何内容。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

574

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

216

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1555

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

965

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

917

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

185

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

89

2025.08.07

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

660

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C# 教程
C# 教程

共94课时 | 9.7万人学习

C 教程
C 教程

共75课时 | 4.8万人学习

C++教程
C++教程

共115课时 | 18.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号