.NET6新东西--Logging Source Generator

喵叔

发布于 2022-01-04 10:19:10

3810

发布于 2022-01-04 10:19:10

文章被收录于专栏：喵叔's 专栏

Logging source generator是.NET6加入的新功能，它以Source Generator为基础来实现的，具有更好的性能以及灵活性，这在注重性能的项目中是一个非常好的功能，但是因为它要用到C# 9中的partial method（分部方法），因此如果要使用它就必须是C#9及以上版本。下面我们来看看如何使用Logging source generator。

简单的例子

一般来说类库里的日志模块会使用静态方法，将日志的各种操作放在一个静态类中，比如下面的代码：

public static void MiaoShuLog(this ILogger logger, string miaoshuLog) => logger.Log(
    LogLevel.Information,
    new EventId(1, "喵叔Log"),
    requestLog);

日志代码这么编写后就可以很方便地进行EventId的管理，避免了EventId重复导致的冲突，但是使用了Logging Source Generator之后代码可以更简单：

[LoggerMessage(LogLevel = LogLevel.Information, EventId=1, EventName= "喵叔Log", Message = "{miaoshuLog}")]
public static void MiaoShuLog(this ILogger logger, string miaoshuLog);

官方示例代码

下面的代码是微软官方提供的一些案列代码：

[LoggerMessage(Level = LogLevel.Information, EventId = 0, Message = "Logging generator sample begin")]
public static partial void TestBegin(this ILogger logger);

[LoggerMessage(Level = LogLevel.Information, EventId = 1, Message = "Logging generator sample end", SkipEnabledCheck = true)]
public static partial void TestEnd(this ILogger logger);

[LoggerMessage(EventId = 2, Message = "Logging generator sample user {userName}")]
public static partial void TestWithArgument(this ILogger logger, LogLevel logLevel, string userName);

// warning SYSLIB1015: Argument 'host' is not referenced from the logging message
[LoggerMessage(EventId = 3)]
public static partial void TestWithEmptyMessage(this ILogger logger, LogLevel logLevel, string host);

[LoggerMessage(
    EventId = 9,
    Level = LogLevel.Trace,
    Message = "Fixed message",
    EventName = "CustomEventName")]
public static partial void LogWithCustomEventName(this ILogger logger);

在上面的代码中静态方法作为扩展方法使用，当然你也可以不作为扩展方法来使用，我们可以根据自己需要和习惯来选择。下面的代码是调用上面定义的Log方法，同样代码也是来自于微软官方：

var loggerFactory = LoggerFactory.Create(builder => builder.AddJsonConsole(options =>
        {
            options.JsonWriterOptions = new JsonWriterOptions()
            {
                Indented = true,
                Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
            };
        }));
var logger = loggerFactory.CreateLogger<LoggingGeneratorSample>();
logger.TestBegin();
logger.TestWithArgument(LogLevel.Warning, Environment.UserName);
logger.TestWithEmptyMessage(LogLevel.Information, Environment.MachineName);
logger.TestEnd();

实例使用示例

除了作为静态方法使用外也可以作为实例方法去使用，实际项目中不关注EventId的日志记录比较多，下面就是这样的一个例子：

new InstanceLoggingGenerator(logger).LoggingTest();
internal partial class InstanceLoggingGenerator
{
    private readonly ILogger _logger;
    public InstanceLoggingGenerator(ILogger logger)
    {
        _logger = logger;
    }
    [LoggerMessage(EventId = 0, EventName = "Test", Level = LogLevel.Information, Message = "Instance logging generator test")]
    public partial void LoggingTest();
}

在上面代码中，实例方法使用可以不传ILogger实例，它会自动从类型中寻找ILogger类型的字段，可以想一下如果类型中有多个ILogger 字段会怎么样？如果没有的话又会怎么样呢？你可以去试试。

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2021/12/31 ，如有侵权请联系 cloudcommunity@tencent.com 删除

日志服务