《ASP.NET Core 依赖注入：玩转构造函数、方法和属性注入的终极指南！》

ASP.NET Core 中的依赖注入（Dependency Injection）详解

依赖注入（Dependency Injection，简称 DI）是现代软件开发中的一种设计模式，它通过将对象的依赖关系从外部注入，而不是在内部创建，从而使代码更加模块化、易于维护和测试。在 ASP.NET Core 中，依赖注入被广泛应用，并且框架原生支持这一模式。本篇博客将详细介绍 ASP.NET Core 中的依赖注入，涵盖构造函数注入、方法注入和属性注入三种实现方式，帮助你全面掌握这一技术。

一、依赖注入的基本概念

依赖注入是将类的依赖项通过外部传递，而不是在类内部创建实例。例如，一个 OrderService 类需要访问数据库来处理订单，传统方式可能会在 OrderService 内部创建数据库上下文实例，这会导致紧耦合的代码，难以维护和测试。通过依赖注入，DbContext 的实例从外部注入到 OrderService，使其只依赖接口，而不关心具体的实现细节。

二、ASP.NET Core 中的依赖注入机制

ASP.NET Core 提供了一个内置的依赖注入容器，用于管理应用程序中的服务和它们的生命周期。

1. 服务的生命周期

在 ASP.NET Core 中，服务可以通过以下三种方式注册，分别根据它们的生命周期进行管理：

• Transient（瞬时）：每次请求都会创建一个新的实例，适用于无状态的轻量级服务。
• Scoped（范围）：在同一个请求范围内，每次注入都会返回相同的实例，适用于在请求期间共享数据的服务。
• Singleton（单例）：应用程序启动时创建实例，并在整个应用程序生命周期内共享该实例，适用于跨请求共享的服务或开销较大的服务。

2. 注册服务

在 Startup.cs 文件的 ConfigureServices 方法中注册服务，例如：

public void ConfigureServices(IServiceCollection services)
{
    services.AddTransient<ITransientService, TransientService>();
    services.AddScoped<IScopedService, ScopedService>();
    services.AddSingleton<ISingletonService, SingletonService>();
}

三、依赖注入的实现方式

1. 构造函数注入

构造函数注入是最常见的依赖注入方式。它通过类的构造函数将依赖项传递进来。这种方式保证了依赖项在类实例化时就被注入，是一种简单、有效的依赖管理方式。

实现步骤

1. 定义服务接口和实现类：

   public interface IMyService
   {
       string GetMessage();
   }
   
   public class MyService : IMyService
   {
       public string GetMessage()
       {
           return "Hello from MyService!";
       }
   }
   

2. 注册服务：

   public void ConfigureServices(IServiceCollection services)
   {
       services.AddTransient<IMyService, MyService>();
   }
   

3. 使用构造函数注入服务：

   public class HomeController : Controller
   {
       private readonly IMyService _myService;
   
       public HomeController(IMyService myService)
       {
           _myService = myService;
       }
   
       public IActionResult Index()
       {
           var message = _myService.GetMessage();
           return View("Message", message);
       }
   }
   

2. 方法注入

方法注入是一种灵活的方式，允许在需要时通过方法参数传递依赖项。与构造函数注入相比，方法注入更适合某些依赖项仅在特定方法中使用的场景。

实现步骤

1. 定义服务接口和实现类：

   （与构造函数注入相同）

2. 注册服务：

   （与构造函数注入相同）

3. 使用方法注入服务：

   public class HomeController : Controller
   {
       public IActionResult Index([FromServices] IMyService myService)
       {
           var message = myService.GetMessage();
           return View("Message", message);
       }
   }
   

   在这个示例中，IMyService 通过方法参数注入到 Index 方法中。ASP.NET Core 的 [FromServices] 属性用于指定从 DI 容器中解析依赖项。

3. 属性注入

属性注入允许通过类的属性来注入依赖项。尽管它不如构造函数注入和方法注入常用，但在某些特定场景下非常有用，特别是当依赖项的注入是可选的，或者依赖项数量较多时。

实现步骤

1. 定义服务接口和实现类：

   （与构造函数注入相同）

2. 注册服务：

   （与构造函数注入相同）

3. 使用属性注入服务：

   public class HomeController : Controller
   {
       [Inject]
       public IMyService MyService { get; set; }
   
       public IActionResult Index()
       {
           var message = MyService.GetMessage();
           return View("Message", message);
       }
   }
   

   注意：ASP.NET Core 原生并不支持属性注入，因此上面的例子中的 [Inject] 是一个假设的标记。若要使用属性注入，可以通过使用第三方 DI 容器（如 Autofac）或手动在 Startup 中解析和赋值。

四、自定义服务的依赖注入

除了框架内置的服务（如 ILogger、IConfiguration），你还可以注册和使用自定义服务。以下是一个综合了多种注入方式的示例。

public interface ICustomService
{
    string PerformOperation();
}

public class CustomService : ICustomService
{
    public string PerformOperation()
    {
        return "Operation performed!";
    }
}

public class ComplexController : Controller
{
    // 属性注入
    [Inject]
    public ICustomService CustomService { get; set; }

    // 构造函数注入
    private readonly IMyService _myService;

    public ComplexController(IMyService myService)
    {
        _myService = myService;
    }

    // 方法注入
    public IActionResult Execute([FromServices] ICustomService customService)
    {
        var result = customService.PerformOperation();
        return View("Result", result);
    }
}

五、在 Windows 环境中调试和测试依赖注入

在 Windows 环境下开发 ASP.NET Core 项目时，Visual Studio 提供了丰富的调试工具，可以方便地调试和测试依赖注入的实现。

1. 断点调试

在 Visual Studio 中，你可以在构造函数、方法或属性的设置位置设置断点，启动调试模式（F5），然后观察依赖项的注入情况和服务的调用流程。

2. 单元测试

依赖注入使得服务更易于测试。你可以为服务创建 mock 对象，从而在单元测试中独立验证服务逻辑，而不依赖实际的实现。以下是一个简单的单元测试示例：

public class ComplexControllerTests
{
    [Fact]
    public void Execute_ReturnsOperationResult()
    {
        // Arrange
        var mockService = new Mock<ICustomService>();
        mockService.Setup(service => service.PerformOperation()).Returns("Mocked Operation Result");
        var controller = new ComplexController(mockService.Object);

        // Act
        var result = controller.Execute(mockService.Object) as ViewResult;

        // Assert
        Assert.Equal("Mocked Operation Result", result?.ViewData["Result"]);
    }
}

六、总结

依赖注入是 ASP.NET Core 中的一个核心概念，通过解耦依赖关系，使代码更加模块化、易于维护和测试。本文详细介绍了构造函数注入、方法注入和属性注入三种方式，每种方式都有其适用场景和实现方法。在 Windows 环境下，借助 Visual Studio 的调试功能和单元测试工具，你可以高效地开发、调试和测试基于依赖注入的 ASP.NET Core 应用。

通过全面掌握这些技术，你将能够更灵活地管理依赖项，使你的 ASP.NET Core 项目更加健壮和可维护。