如何在 ASP.Net Core 中使用 LoggerMessage

ASP.NET Core 是一个开源的、跨平台的、轻量级模块化框架，可用于构建高性能、可伸缩的web应用程序，你也许不知道 ASP.NET Core 中有一个藏得很深，而且非常强大的特性，那就是 LoggerMessage，与内建的 Logger 相比，前者具有更高的性能，这篇文章我们来一起讨论 LoggerMessage 到底能带来什么好处，以及如何在 ASP.NET Core 3.0 中使用 LoggerMessage 。

LoggerMessage VS Logger

与内置的 Logger 相比，LoggerMessage提供了以下几个优点。

性能

LoggerMessage 比 Logger 具有更少的对象分配和计算开销，内建的 Logger 有装箱操作，而 LoggerMessage 巧妙的利用了静态字段，静态方法，以及具有强类型扩展方法来避免装箱开销。

解析

与 Logger 相比，LoggerMessage 的解析机制更加高效，Logger 会在每次写入消息的时候都要解析模板，而 LoggerMessage 只需在消息定义的时候解析一次。

使用 LoggerMessage.Define 方法

在 Microsoft.Extensions.Logging 命名空间下的 LoggerMessage.Define<T> 方法可用于高性能的记录日志，要使用这个方法，需要指定正确的强类型参数。

下面是 LoggerHelper.Define<T>() 源码定义

接下来我们看一下如何使用 LoggerMessage.Define 方法，先定义一个静态的 LoggerExtensions 类，如下代码所示：


internal static class LoggerExtensions
{}

接下来创建一个用来记录日志的扩展方法，内部使用的是 LoggerMessage.Define 方法，代码如下：

internal static class LoggerExtensions{public static void RecordNotFound(this ILogger logger, int id) => NotFound(logger, id, null);private static readonly Action<ILogger, int, Exception> NotFound = LoggerMessage.Define<int> (LogLevel.Error, new EventId(1234, nameof(NotFound)),"The record is not found: {Id}");}

Action 中使用 LoggerMessage

接下来在项目默认的 HomeController.Index() 方法中使用刚才创建的日志扩展方法，如下代码所示：

public class HomeController : Controller{private readonly ILogger<HomeController> _logger;public HomeController(ILogger<HomeController> logger){_logger = logger;}public IActionResult Index(){_logger.RecordNotFound(1);return View();}}internal static class LoggerExtensions{public static void RecordNotFound(this ILogger logger, int id) => NotFound(logger, id, null);private static readonly Action<ILogger, int, Exception> NotFound = LoggerMessage.Define<int>(LogLevel.Error, new EventId(1234, nameof(NotFound)), "The record is not found: {Id}");}

LoggerMessage.Define 可以用来创建能够缓冲日志消息的委托，这种方法相比内建的 Logger 具有更高的性能，最后你可以在 https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/loggermessage?view=aspnetcore-3.1 上了解更多关于 LoggerMessage 的知识。