日志记录器包装器最佳实践

本文关键字：最佳 记录器 包装 日志 | 更新日期: 2023-09-27 17:49:49

我想在我的应用程序中使用nlogger，也许在将来我需要更改日志记录系统。所以我想使用日志facade。

对于现有的例子，你有什么建议吗?或者给我这个领域的一些最佳实践的链接。

日志记录器包装器最佳实践

我曾经使用像Common这样的日志记录facade。日志记录(甚至隐藏我自己的CuttingEdge)。日志库)，但现在我使用依赖注入模式。这允许我将记录器隐藏在应用程序定义的抽象之后，该抽象遵循依赖反转原则和接口隔离原则(ISP)，因为它有一个成员，而且接口是由我的应用程序定义的;不是外部库。

尽量减少你的应用程序的核心部分对外部库存在的了解，越好;即使您不打算替换日志库。对外部库的硬依赖使测试代码变得更加困难，并且使用从未专门为应用程序设计的API使应用程序复杂化。

这是我的应用程序中经常出现的抽象:

public interface ILogger
{
    void Log(LogEntry entry);
}
public sealed class ConsoleLogger : ILogger
{
    public void Log(LogEntry entry)
}
public enum LoggingEventType { Debug, Information, Warning, Error, Fatal };
// Immutable DTO that contains the log information.
public struct LogEntry
{
    public LoggingEventType Severity { get; }
    public string Message { get; }
    public Exception Exception { get; }
    public LogEntry(LoggingEventType severity, string msg, Exception ex = null)
    {
        if (msg is null) throw new ArgumentNullException("msg");
        if (msg == string.Empty) throw new ArgumentException("empty", "msg");
        this.Severity = severity;
        this.Message = msg;
        this.Exception = ex;
    }
}

可选地，这个抽象可以用一些简单的扩展方法进行扩展(允许接口保持狭窄并保持遵循ISP)。这使得这个接口的使用者的代码更加简单:

public static class LoggerExtensions
{
    public static void Log(this ILogger logger, string message) =>
        logger.Log(new LogEntry(LoggingEventType.Information, message));
    public static void Log(this ILogger logger, Exception ex) =>
        logger.Log(new LogEntry(LoggingEventType.Error, ex.Message, ex));
    // More methods here.
}

因为接口只包含一个方法，所以很容易创建一个代理到log4net、Serilog、Microsoft.Extensions的ILogger实现。Logging, NLog或任何其他日志库，并配置您的DI容器将其注入到在其构造函数中具有ILogger的类中。创建一个写入控制台的实现或者一个可用于单元测试的伪实现也很容易，如下面的清单所示:

public class ConsoleLogger : ILogger
{
    public void Log(LogEntry entry) => Console.WriteLine(
      $"[{entry.Severity}] {DateTime.Now} {entry.Message} {entry.Exception}");
}
public class FakeLogger : List<LogEntry>, ILogger
{
    public void Log(LogEntry entry) => this.Add(entry);
}

在具有单个方法的接口上使用静态扩展方法与具有许多成员的接口是完全不同的。扩展方法只是创建LogEntry消息并通过ILogger接口上的唯一方法传递它的辅助方法。这些扩展方法本身不包含Volatile行为，因此不会妨碍可测试性。如果你愿意，你可以很容易地测试它们，它们就会成为用户代码的一部分;不是抽象的一部分。

这不仅允许扩展方法在不需要改变抽象的情况下发展，而且当使用日志记录器抽象时，扩展方法和LogEntry构造函数总是被执行，即使日志记录器是存根/模拟的。这使得在测试套件中运行时对日志记录器调用的正确性更加确定。我已经多次这样做了，在我的单元测试中，我对所使用的第三方记录器抽象的调用成功了，但在生产环境中执行时仍然失败。

单成员接口也使测试更容易;具有许多成员的抽象使创建实现(如模拟、适配器和装饰器)变得困难。

当您这样做时，几乎不需要日志facade(或任何其他库)可能提供的一些静态抽象。

尽管如此，即使有了ILogger的设计，我还是更喜欢用这样的方式来设计应用程序:只有少数类需要依赖于ILogger的抽象。这个答案更详细地讨论了这一点。

我使用了来自https://github.com/uhaciogullari/NLog.Interface的小接口包装器+适配器，也可以通过NuGet获得:

PM> Install-Package NLog.Interface

目前，最好的办法是使用Microsoft.Extensions.Logging包(正如Julian指出的)。大多数日志框架都可以这样使用。

定义你自己的接口，就像Steven在回答中解释的那样，对于简单的情况是可以的，但是它忽略了一些我认为重要的事情:

  • 结构化日志和反结构化对象(Serilog和NLog中的@符号)
  • 延迟字符串构建/格式化:当它接受字符串时，它必须在调用时评估/格式化所有内容，即使最终事件不会被记录，因为它低于阈值(性能成本，见前一点)
  • 出于性能原因，您可能需要IsEnabled(LogLevel)这样的条件检查，再次

您可能可以在自己的抽象中实现所有这些，但这时您将重新发明轮子。

这个问题的一个很好的解决方案已经以LibLog项目的形式出现了。

LibLog是一个日志抽象，内置了对主要日志记录器的支持，包括Serilog、NLog、Log4net和Enterprise logger。它通过NuGet包管理器作为源文件(.cs)而不是.dll引用安装到目标库中。这种方法允许包含日志抽象，而无需强制库采用外部依赖项。它还允许库作者包含日志记录，而无需强制消费应用程序显式地向库提供日志记录器。LibLog使用反射来找出正在使用的具体记录器，并将其连接起来，而无需在库项目中使用任何显式的连接代码。

所以，LibLog是在库项目中记录日志的一个很好的解决方案。只需在主应用程序或服务中引用和配置一个具体的日志记录器(Serilog)，并将LibLog添加到您的库中!

通常我更喜欢创建一个像

这样的界面
public interface ILogger
{
 void LogInformation(string msg);
 void LogError(string error);
}

，并在运行时注入一个由该接口实现的具体类。

您可以使用Castle Logging Services或Simple Logging farade来代替编写自己的facade。

都包含NLog和Log4net的适配器。

从2015年开始，如果你正在构建。net核心应用程序，你也可以使用。net Core Logging。

NLog要挂接的包是:

  • NLog.Web。ASP的AspNetCore。NET核心用户
  • NLog.Extensions。.NET Core用户的日志记录，例如控制台项目
相关文章：