将记录器作为单身人士是一个好习惯吗？

Question

我有将记录器传递给构造函数的习惯，例如：

public class OrderService : IOrderService {
     public OrderService(ILogger logger) {
     }
}

但这很烦人，所以我已经用它这个属性有一段时间了：

private ILogger logger = NullLogger.Instance;
public ILogger Logger
{
    get { return logger; }
    set { logger = value; }
}

这也很烦人——它并不枯燥，我需要在每节课上重复一遍。我可以使用基类，但话又说回来 - 我使用的是 Form 类，所以需要 FormBase 等。 所以我认为，暴露 ILogger 的单例会有什么缺点，所以每个人都会知道从哪里获取记录器：

    Infrastructure.Logger.Info("blabla");

更新：正如 Merlyn 正确注意到的，我应该提到，在第一个和第二个示例中，我使用的是 DI。

Answer 1

我在我的依赖注入容器中放置了一个记录器实例，然后将记录器注入到需要的类中。

Answer 2

这也越来越烦人了——不是DRY

确实如此。但是，对于遍及您拥有的每种类型的横切关注点，您能做的只有这么多。您必须在任何地方使用记录器，因此您必须拥有这些类型的属性。

让我们看看我们能做些什么。

单例

单身太可怕了<flame-suit-on>。

我建议您坚持使用属性注入，就像您在第二个示例中所做的那样。这是您可以在不诉诸魔法的情况下进行的最佳分解。有一个显式的依赖比通过单例隐藏它更好。

但是，如果单例可以为您节省大量时间，包括您将不得不做的所有重构（水晶球时间！），我想您也许可以忍受它们。如果单例有什么用处，可能就是这样。请记住，如果您曾经想要改变主意，所付出的代价将是最高的。

如果您这样做，请使用the Registry pattern（参见说明）查看其他人的答案，以及那些注册（可重置）单例工厂而不是单例记录器实例的人。

还有其他替代方案也可以在没有太大妥协的情况下发挥同样的作用，因此您应该先检查一下。

Visual Studio 代码 sn-ps

您可以使用Visual Studio code snippets 来加快进入该重复代码的速度。您将能够输入类似loggertab 的内容，代码会神奇地出现在您面前。

使用 AOP 来 DRY 关闭

您可以通过使用an Aspect Oriented Programming (AOP) framework like PostSharp 自动生成一些属性注入代码来消除一些属性注入代码。

完成后可能看起来像这样：

[InjectedLogger]
public ILogger Logger { get; set; }

您还可以使用their method tracing sample code 自动跟踪方法入口和退出代码，这可能会消除将一些记录器属性一起添加的需要。您可以在类级别或命名空间范围内应用该属性：

[Trace]
public class MyClass
{
    // ...
}

// or

#if DEBUG
[assembly: Trace( AttributeTargetTypes = "MyNamespace.*",
    AttributeTargetTypeAttributes = MulticastAttributes.Public,
    AttributeTargetMemberAttributes = MulticastAttributes.Public )]
#endif

Answer 3

好问题。我相信在大多数项目中记录器是一个单身人士。

我突然想到了一些想法：

• 使用ServiceLocator（或其他Dependency Injection容器，如果您已经使用任何容器）允许您在服务/类之间共享记录器，这样您可以实例化记录器甚至多个不同的记录器并通过ServiceLocator共享显然是一个单身人士，某种Inversion of Control。这种方法在记录器实例化和初始化过程中为您提供了很大的灵活性。
• 如果您几乎在任何地方都需要记录器 - 为Object 类型实现扩展方法，这样每个类都可以调用记录器的方法，例如LogInfo()、LogDebug()、LogError()

Answer 4

单例是个好主意。一个更好的主意是使用Registry 模式，它可以更好地控制实例化。在我看来，单例模式太接近全局变量了。使用注册表处理对象的创建或重用，将来可以更改实例化规则。

Registry 本身可以是一个静态类，以提供简单的语法来访问日志：

Registry.Logger.Info("blabla");

Answer 5

普通的单例不是一个好主意。这使得更换记录器变得困难。我倾向于为我的记录器使用过滤器（一些“嘈杂”的类可能只记录警告/错误）。

我将单例模式与记录器工厂的代理模式结合使用：

public class LogFactory
{
    private static LogFactory _instance;

    public static void Assign(LogFactory instance)
    {
        _instance = instance;
    }

    public static LogFactory Instance
    {
        get { _instance ?? (_instance = new LogFactory()); }
    }

    public virtual ILogger GetLogger<T>()
    {
        return new SystemDebugLogger();
    }
}

这使我可以在不更改任何代码的情况下创建FilteringLogFactory 或仅创建SimpleFileLogFactory（因此符合开放/封闭原则）。

示例扩展

public class FilteredLogFactory : LogFactory
{
    public override ILogger GetLogger<T>()
    {
        if (typeof(ITextParser).IsAssignableFrom(typeof(T)))
            return new FilteredLogger(typeof(T));

        return new FileLogger(@"C:\Logs\MyApp.log");
    }
}

并使用新工厂

// and to use the new log factory (somewhere early in the application):
LogFactory.Assign(new FilteredLogFactory());

在你应该记录的班级中：

public class MyUserService : IUserService
{
    ILogger _logger = LogFactory.Instance.GetLogger<MyUserService>();

    public void SomeMethod()
    {
        _logger.Debug("Welcome world!");
    }
}

Answer 6

.NET 中有一本书 Dependency Injection。根据您的需要，您应该使用拦截。

本书中有一张图帮助决定是否使用构造函数注入、属性注入、方法注入、环境上下文、拦截。

这就是使用此图表的原因之一：

1. 你有依赖还是需要它？ - 需要它
2. 是横切关注点吗？ - 是的
3. 您需要它的答案吗？ - 没有

使用拦截

Answer 7

我个人认为最简单的另一个解决方案是使用静态 Logger 类。您可以从任何类方法调用它，而无需更改类，例如添加属性注入等。它非常简单易用。

Logger::initialize ("filename.log", Logger::LEVEL_ERROR); // only need to be called once in your application

Logger::log ("my error message", Logger::LEVEL_ERROR); // to be used in every method where needed

Answer 8

如果您想寻找一个好的日志记录解决方案，我建议您查看带有 python 的 google app engine，其中日志记录与 import logging 一样简单，然后您可以只使用 logging.debug("my message") 或 logging.info("my message")，它确实保持为应该很简单。

Java 没有很好的日志记录解决方案，即应该避免使用 log4j，因为它实际上会迫使您使用单例，这里的回答是“可怕的”，而且我在尝试使日志记录输出相同的日志记录方面有过可怕的经历当我怀疑双重日志记录的原因是我在同一虚拟机的两个类加载器中有一个单例日志记录对象时，仅声明一次（！）

请您原谅我对 C# 没有那么具体，但从我所看到的 C# 解决方案看起来与我们有 log4j 的 Java 类似，我们也应该将其设为单例。

这就是我真正喜欢solution with GAE / python 的原因，它非常简单，您不必担心类加载器、获取双重日志语句或任何设计模式。

我希望其中一些信息与您相关，我希望您想看看我推荐的日志记录解决方案，而不是因为无法拥有一个单例而被怀疑有多少问题。当它必须在多个类加载器中实例化时是真正的单例。