.net 记录器包装器最佳实践

我以前使用Common.Logging这样的日志(log)外观(甚至隐藏我自己的CuttingEdge.Logging库)，但现在我使用Dependency Injection pattern.这允许我将记录器隐藏在一个应用程序定义的抽象后面，该抽象同时遵循Dependency Inversion Principle和Interface Segregation Principle(ISP)，因为它有一个成员，而且接口是由我的应用程序定义的；不是外部图书馆.

最大限度地减少应用程序核心部分对外部库存在的了解就更好了；即使您不打算替换您的日志(log)库.对外部库的硬依赖使得测试代码变得更加困难，而且它会使应用程序复杂化，因为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.
}

因为该接口只包含一个方法，所以可以很容易地创建一个包含proxies to log4net、to Serilog、Microsoft.Extensions.Logging、NLog或任何其他日志(log)记录库的ILogger实现，并将DI容器配置为将其注入到构造函数中包含ILogger的类中.还可以很容易地创建一个写入控制台的实现，或者创建一个可用于单元测试的假实现，如下面的 list 所示:

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接口上的唯一方法传递它的帮助器方法.这些扩展方法本身不包含自身的易失性行为，因此不会妨碍可测试性.如果愿意，您可以很容易地测试它们，它们将成为消费者代码的一部分，而不是抽象的一部分.

这不仅允许扩展方法在不需要更改抽象的情况下发展，而且当使用记录器抽象时，扩展方法和LogEntry构造函数总是被执行，即使记录器被存根/模拟.这使得在测试套件中运行时对记录器的调用的正确性更加确定.我曾多次用这个攻击自己，在单元测试期间，我对使用过的第三方记录器抽象的调用成功了，但在生产中执行时仍然失败.

单成员接口也使测试更容易；拥有一个包含许多成员的抽象会使创建实现(例如模拟、适配器和decorator )变得困难.

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

尽管如此，即使使用了ILogger设计，您还是更愿意以这样的方式设计应用程序，即只有少数类需要依赖于ILogger抽象.This answer人详细讨论了这一点.