使用哪种模式进行日志记录？依赖注入还是服务定位器？

Question

考虑这种情况。我有一些业务逻辑，不时需要写入日志。

interface ILogger
{
    void Log(string stuff);
}

interface IDependency
{
    string GetInfo();
}

class MyBusinessObject
{
    private IDependency _dependency;

    public MyBusinessObject(IDependency dependency)
    {
        _dependency = dependency;
    }

    public string DoSomething(string input)
    {
        // Process input
        var info = _dependency.GetInfo();
        var intermediateResult = PerformInterestingStuff(input, info);

        if (intermediateResult== "SomethingWeNeedToLog")
        {
            // How do I get to the ILogger-interface?
        }

        var result = PerformSomethingElse(intermediateResult);

        return result;
    }
}

如何获得 ILogger 界面？我看到了两种主要的可能性；

1. 在构造函数上使用依赖注入传递它。
2. 通过单例服务定位器获取它。

您更喜欢哪种方法，为什么？还是有更好的模式？

更新： 请注意，我不需要记录所有方法调用。我只想记录一些在我的方法中可能发生也可能不会发生的（罕见）事件。

Answer 1

我个人是两者兼而有之。

这是我的约定：

• 来自静态上下文 - 服务位置
• 从实例上下文 - 依赖注入

我觉得这给了我可测试性的正确平衡。我发现针对使用服务位置的类设置测试比使用 DI 更难，所以这就是为什么服务位置最终成为例外而不是规则的原因。不过，我对它的使用是一致的，所以不难记住我需要编写什么类型的测试。

有些人担心 DI 会使构造函数变得混乱。我不觉得这是个问题，但如果你有这种感觉，有很多使用 DI 的替代方案，但要避免构造函数参数。以下是 Ninject 的 DI 方法列表： http://ninject.codeplex.com/wikipage?title=Injection%20Patterns

您会发现大多数 Inversion of Control 容器都具有与 Ninject 相同的功能。我选择展示 Ninject 是因为他们有最简洁的样本。

希望这会有所帮助。

编辑：为了清楚起见，我使用 Unity 和 Common Service Locator。我有一个用于 DI 的 Unity 容器的单例实例，而 IServiceLocator 的实现只是该单例 Unity 容器的包装器。这样我就不必做任何类型映射两次或类似的事情了。

我也没有发现 AOP 除了跟踪之外特别有用。我更喜欢手动记录，因为它更清晰。我知道大多数 AOP 日志框架都具备这两种功能，但大多数时候我不需要前者（AOP 的生计）。当然，这只是个人喜好。

Answer 2

记录器显然是您的业务逻辑所依赖的服务，因此应该像处理IDependency 一样将其视为依赖项。在构造函数中注入记录器。

注意： 尽管 AOP 被提及为 注入日志记录的方式，但我不同意它是这种情况下的解决方案。 AOP 非常适合执行跟踪，但永远不会成为将日志记录作为业务逻辑一部分的解决方案。

Answer 3

我的小经验法则：

• 如果它在类库中，请使用构造函数注入或具有空对象模式的属性注入。

• 如果它在主应用程序中，请使用服务定位器（或单例）。

我发现这在使用 log4net 时非常适用。您不希望类库访问可能不存在的东西，但在应用程序中，您知道记录器将存在，并且像 log4net 之类的库在很大程度上基于服务位置模式。

我倾向于认为日志记录是一种足够静态的东西，它并不真正需要 DI。我不太可能更改应用程序中的日志记录实现，尤其是因为那里的每个日志记录框架都非常灵活且易于扩展。当您的库可能需要由已经使用不同记录器的多个应用程序使用时，它在类库中更为重要。

当然是 YMMV。 DI 很棒，但这并不意味着一切都需要 DI。

Answer 4

也许这有点离题，但是当我们可以在课程的开头键入时，为什么我们还需要注入记录器：

Logger logger = LogManager.GetLogger("MyClassName");

Logger 在开发期间和以后的维护期间不会更改。现代记录器是高度可定制的，所以争论

如果我想用数据库替换文本记录器怎么办？

错过了。

我不否定使用依赖注入，我只是好奇你的想法。

Answer 5

我们将所有的 Logging/Tracing 切换为 PostSharp（AOP 框架）属性。为方法创建日志记录所需要做的就是为其添加属性。

好处：

• 轻松使用AOP
• 清除关注点分离
• 发生在编译时 -> 最小的性能影响

查看this。

Answer 6

我更喜欢单例服务。

依赖注入会使构造函数混乱。

如果你可以使用AOP，那就最好了。

Answer 7

您可以派生另一种类型，例如LoggableBusinessObject 在其构造函数中接受一个记录器。这意味着您只传递将使用它的对象的记录器：

public class MyBusinessObject
{
    private IDependency _dependency;

    public MyBusinessObject(IDependency dependency)   
    {   
        _dependency = dependency;   
    }   

    public virtual string DoSomething(string input)   
    {   
        // Process input   
        var info = _dependency.GetInfo();   
        var result = PerformInterestingStuff(input, info);   
        return result;   
    }   
}

public class LoggableBusinessObject : MyBusinessObject
{
    private ILogger _logger;

    public LoggableBusinessObject(ILogger logger, IDependency dependency)
        : base(dependency)
    {
        _logger = logger;
    }

    public override string DoSomething(string input)
    {
        string result = base.DoSomething(input);
        if (result == "SomethingWeNeedToLog")
        {
             _logger.Log(result);
        }
    }
}

Answer 8

DI 在这里可以很好地工作。另一件事是AOP。

Answer 9

我不推荐这两种方法。最好使用面向方面的编程。日志记录是 AOP 的“hello world”。