LoggerMessageAttribute 高性能的日志记录-Toy模板网

这篇具有很好参考价值的文章主要介绍了LoggerMessageAttribute 高性能的日志记录。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

.NET 6 引入了 LoggerMessageAttribute 类型。使用时，它会以source-generators的方式生成高性能的日志记录 API。

source-generators可在编译代码时，可以提供其他源代码作为编译的输入。

LoggerMessageAttribute依赖于 ILogger 接口和 LoggerMessage.Define 功能。

在 partial 日志记录方法上使用 LoggerMessageAttribute 时，系统会触发源生成器。触发后，它既可以自动生成其修饰的 partial 方法的实现，也可以生成包含正确用法提示的编译时诊断。

与现有的日志记录方法相比，编译时日志记录解决方案在运行时通常要快得多。这是因为它最大限度地消除了装箱、临时分配和副本。

基本用法

使用 LoggerMessageAttribute 时，类和方法必须为 partial。真实记录日志的代码生成器在编译时触发，并生成 partial 方法的实现。

public static partial class Log
{
    [LoggerMessage(
        EventId = 0,
        Level = LogLevel.Error,
        Message = "Can not open SQL connection {err}")]
    public static partial void CouldNotOpenConnection(this ILogger logger, string err);
}

在上面的示例中，日志记录方法为 static，日志级别在属性定义中指定，并使用 this 关键字将方法定义为扩展方法。

在调用时，可按常规方式调用即可

internal class Program
{
    private static async Task Main(string[] args)
    {

        using ILoggerFactory loggerFactory = LoggerFactory.Create(
            builder =>
            builder.AddJsonConsole(
                options =>
                options.JsonWriterOptions = new JsonWriterOptions()
                {
                    Indented = true
                }));

        ILogger logger = loggerFactory.CreateLogger("Program");

        logger.CouldNotOpenConnection("network err");
    }
}