如何使用 Ninject

Question

我今天一直在尝试使用 Ninject，并有几个问题。首先，我是否需要在所有想要使用注入的构造函数上使用 Inject 属性。这似乎是一个非常蹩脚的设计？我是否需要创建一个内核，然后在传入注入类的任何地方使用它？

Answer 1

开始使用 Ninject 的最佳方法是从小事做起。寻找新的。

在应用程序中间的某个位置，您正在另一个类中创建一个类。这意味着您正在创建依赖项。依赖注入是指通常通过构造函数传入这些依赖项，而不是嵌入它们。

假设您有一个这样的类，用于在 Word 中自动创建特定类型的注释。 （这与我最近在工作中完成的一个项目类似。）

class NoteCreator
{
    public NoteHost Create()
    {
        var docCreator = new WordDocumentCreator();
        docCreator.CreateNewDocument();
        [etc.]

WordDocumentCreator 是一个类，用于处理在 Microsoft Word 中创建新文档的细节（创建 Word 的实例等）。我的类 NoteCreator 依赖 WordDocumentCreator 来执行其工作。

问题是，如果有一天我们决定转向更高级的文字处理程序，我必须找到所有实例化 WordDocumentCreator 的地方，并将它们更改为实例化 WordPerfectDocumentCreator。

现在想象一下，我将我的类更改为如下所示：

class NoteCreator
{
    WordDocumentCreator docCreator;

    public NoteCreator(WordDocumentCreator docCreator)  // constructor injection
    {
        this.docCreator = docCreator;
    }

    public NoteHost Create()
    {
        docCreator.CreateNewDocument();
        [etc.]

我的代码没有改变那么多；我在 Create 方法中所做的就是删除带有 new 的行。但现在我正在注入我的依赖。让我们再做一个小改动：

class NoteCreator
{
    IDocumentCreator docCreator;

    public NoteCreator(IDocumentCreator docCreator)  // change to interface
    {
        this.docCreator = docCreator;
    }

    public NoteHost Create()
    {
        docCreator.CreateNewDocument();
        [etc.]

我提取了一个 IDocumentCreator 接口，而不是传入具体 WordDocumentCreator使用 CreateNewDocument 方法。现在我可以传入实现该接口的任何类，而NoteCreator所要做的就是调用它知道的方法。

现在是棘手的部分。现在，我的应用程序中应该出现编译错误，因为我在某个地方使用不再存在的无参数构造函数创建 NoteCreator。现在我还需要删除该依赖项。换句话说，我经历了与上面相同的过程，但现在我将其应用到创建新 NoteCreator 的类。当您开始提取依赖项时，您会发现它们往往会“冒泡”到应用程序的根目录，这是您应该引用 DI 容器的唯一位置（例如 Ninject ）。

我需要做的另一件事是配置 Ninject。最重要的部分是一个如下所示的类：

class MyAppModule : NinjectModule
{
    public override void Load()
    {
        Bind<IDocumentCreator>()
            .To<WordDocumentCreator>();

这告诉 Ninject，当我尝试创建一个需要 IDocumentCreator 的类时，它应该创建一个 WordDocumentCreator代码>并使用它。 Ninject 经历的过程如下所示：

• 创建应用程序的MainWindow。它的构造函数需要一个 NoteCreator。
• 好的，那么创建一个 NoteCreator。但其构造函数需要一个 IDocumentCreator。
• 我的配置表明，对于 IDocumentCreator，我应该使用 WordDocumentCreator。因此，创建一个 WordDocumentCreator。
• 现在我可以将 WordDocumentCreator 传递给 NoteCreator。
• 现在我可以将该 NoteCreator 传递给 MainWindow。

这个系统的优点有三个。

首先，如果您未能配置某些内容，您会立即知道，因为您的对象是在应用程序运行后立即创建的。 Ninject 会给您一条有用的错误消息，指出您的 IDocumentCreator （例如）无法解析。

其次，如果管理层稍后要求用户使用高级文字处理程序，那么您所要做的就是

• 编写一个实现 IDocumentCreator 的 WordPerfectDocumentCreator。
• 更改上面的 MyAppModule，将 IDocumentCreator 绑定到 WordPerfectDocumentCreator。

第三，如果我想测试我的 NoteCreator，我不必传入 real WordDocumentCreator （或我正在使用的任何东西） 。我可以传递一个假。这样我就可以编写一个测试，假设我的 IDocumentCreator 工作正常，并且只测试 NoteCreator 本身的移动部分。我的假 IDocumentCreator 除了返回正确的响应之外什么也不做，我的测试将确保 NoteCreator 做正确的事情。

有关如何以这种方式构建应用程序的更多信息，请参阅 Mark Seemann 最近的书 .NET 中的依赖注入。不幸的是，它没有涵盖 Ninject，但它确实涵盖了许多其他 DI 框架，并且讨论了如何按照我上面描述的方式构建应用程序。

另请参阅 Michael Feathers 撰写的有效使用旧代码。他谈到了上面的测试方面：如何打破接口并传入伪造品以隔离行为并对其进行测试。

Answer 2

首先，我是否需要在所有构造函数上使用 Inject 属性
我想用注射来实现。这看起来真的很蹩脚
设计？

不，实际上您根本不必这样做。由于您使用 ASP.NET MVC，因此只需安装 Ninject.MVC3 Nuget 包即可。这将使您开始使用 App_Start 文件夹中的 NinjectMVC3 类。您可以使用 RegisterServices 方法向 Ninject 注册您的接口/类。所有与这些接口有依赖关系的控制器将由 Ninject 自动解析，不需要 Inject 属性。

我是否需要创建一个内核，然后在我传入的任何地方使用它
注入类？

不 - 您所描述的听起来更像 服务定位器模式，而不是依赖项注入 - 您需要传递依赖项理想情况下，在构造函数中，而不是使用内核在特定类中解析它们。应该只有一个完成解析的中央组合根，它位于上面提到的 RegisterServices 方法中的组合根内，或者在那里实例化一个单独的 Ninject 模块 - 后一种方法将允许您在改变解决依赖关系的方式方面具有更大的灵活性和模块化性（没有双关语）。

这是一个很好的关于使用 Ninject 和 MVC3 进行依赖注入的初学者教程。

Answer 3

不要忘记有文档，包括一个介绍，考虑到您提出的问题，我认为这是非常合适的 在 Ninject Wiki 上。如果您在没有从头到尾阅读 Ninject 的情况下尝试使用 Ninject，那么您只是在烦恼自己。

将目录放在书签栏上一段时间。

我还强烈推荐 Mark Seemann 的 Dependency Injection in .Net 作为基于 DI 的架构的姊妹书（尽管它不直接涵盖 Ninject）。