Microsoft.Extensions.Logging 与。日志

Question

我看到很多帖子都提到了 Microsoft.Extensions.Logging 和 NLog 的使用。

我想更好地了解 Microsoft.Extensions.Logging 的用途？

特别是为什么需要它或者将它与 NLog 一起使用有什么好处？

Answer 1

使用 NLog 你可以做到：

var logger = NLog.LogManager.GetCurrentClassLogger();
logger.Info("Hello {Name}", "Earth");

这适用于所有平台和所有框架。

Microsoft.Extensions.Logging

在 .NET Core 中，Microsoft 引入了来自 Microsoft.Extensions.Logging 的 ILogger abstraction。您可以在项目中使用该日志记录抽象并将其与 NLog 集成。

例如，在 ASP.NET Core 中，您可以注入 Microsoft.Extensions.Logging.ILogger<HomeController>，这可以将日志发送到 NLog。 （见Getting started with ASP.NET Core 2 · NLog/NLog Wiki）

using Microsoft.Extensions.Logging;

public class HomeController : Controller
{
    private readonly ILogger<HomeController> _logger;

    public HomeController(ILogger<HomeController> logger)
    {
        _logger = logger;
    }

    public IActionResult Index()
    {
        _logger.LogInformation("Index page says hello {Name}", "Universe");
        return View();
    }

包

对于 NLog 和 Microsoft.Extensions.Logging 有以下软件包：

• .NET 核心日志记录抽象在包Microsoft.Extensions.Logging.Abstractions
• 这些抽象的 NLog 集成在包 NLog.Extensions.Logging 中。您可以将此包用于 .NET Core 控制台应用程序。
• 对于 ASP.NET Core，有一个优化的包 NLog.Web.AspNetCore 使用 NLog.Extensions.Logging

比较

NLog 专业人士

直接使用 NLog 的优点

• 最佳性能
• 记录器 API 的更多选项，例如Logger.WithProperty(..)
• 适用于所有平台
• 无需依赖注入，从而节省复杂性。

优点 Microsoft.Extensions.Logging

通过 Microsoft.Extensions.Logging 使用 NLog 的优点：

• 与 ASP.NET Core 完全集成，例如Microsoft 还会写入记录器 API，NLog 也会捕获（并可能过滤）这些内容
• 写入日志抽象将使您的代码日志库独立。
• 适用于 .NET Core 依赖注入
• 新：您可以configure NLog with appsettings.json - 所以使用 JSON 而不是 XML

更新：添加 - Using NLog with appsettings.json

Answer 2

Microsoft.Extensions.Logging 用于依赖注入，这对于单元测试很方便：你可以实现一个带有 LoggedText 属性的记录器来支持Assert.IsTrue(_logger.LoggedText.Contains("expected value"))。下面的例子说明了这样一个类，它实现了Microsoft.Extensions.Logging.ILogger<T>，并且（为了好玩）也使用了 Julian 的建议，将消息发送到 NLog：

using Microsoft.Extensions.Logging;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
    
namespace MyDomain.Tests
{
   internal class WrappedNLogger<T> : ILogger<T>
    {
       private StringBuilder _sb = new StringBuilder(); //Support Assert.IsTrue(_logger.LoggedText == "expected value")
        private NLog.Logger _nlog = NLog.LogManager.GetCurrentClassLogger(); //support use of NLog

        public IDisposable BeginScope<TState>(TState state) => default;

        public bool IsEnabled(LogLevel logLevel) => true;

        public void Log<TState>(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func<TState, Exception, string> formatter)
        {
            var jsonLine = JsonConvert.SerializeObject(new
            {
                timestamp = DateTime.Now.ToLongTimeString(),
                logLevel,
                eventId,
                parameters = (state as IEnumerable<KeyValuePair<string, object>>)?.ToDictionary(i => i.Key, i => i.Value),
                message = formatter(state, exception),
                exception = exception?.GetType().Name
            });

            _sb.AppendLine(jsonLine);
            NLog.LogLevel nloglevel = logLevel == LogLevel.Debug ? NLog.LogLevel.Debug
                                    : logLevel == LogLevel.Information ? NLog.LogLevel.Info
                                    : logLevel == LogLevel.Warning ? NLog.LogLevel.Warn
                                    : logLevel == LogLevel.Error ? NLog.LogLevel.Error
                                    : logLevel == LogLevel.Critical ? NLog.LogLevel.Fatal : NLog.LogLevel.Trace;
            _nlog.Log(nloglevel, jsonLine);
        }

        public string LoggedText { get => _sb.ToString(); }
           
    }
}