.NET CORE——Console中使用依赖注入

时间:2022-04-22
本文章向大家介绍.NET CORE——Console中使用依赖注入,主要内容包括1. 在 Console 中使用内置 DI 组件、2. 在 Console 中使用第三方 Autofac DI 组件、基本概念、基础应用、原理机制和需要注意的事项等,并结合实例形式分析了其使用技巧,希望通过本文能帮助到大家理解应用这部分内容。

我们都知道,在 ASP.NET CORE 中通过依赖注入的方式来使用服务十分的简单,而在 Console 中,其实也只是稍微绕了个小弯子而已。不管是内置 DI 组件或者第三方的 DI 组件(如Autofac),通过 IServiceCollection 接口我们都可以做到和应用程序的无缝连接。本文将在别给出内置组件和第三方组件(主要是Autofac)在 Console 应用程序中的依赖注入实现方式。

1. 在 Console 中使用内置 DI 组件

  • 网上已经有几篇相关的博客讲解 Console 中的依赖注入,链接都会附于文章末尾。不像 ASP.NET CORE 在应用框架启动时便将 DI 容器初始化完成并且注入了大部分开发者需要的服务,我们只能从零开始。
// 安装 DI 组件
Install-Package Microsoft.Extensions.DependencyInjection
// 安装日志输出组件
Install-Package Microsoft.Extensions.Logging.Console
  • 添加模拟的应用服务
public interface ICounterAppService
{
    void Count(int loops);
}

public class CounterAppService : ICounterAppService
{
    private readonly ILogger _logger;

    public CounterAppService(ILoggerFactory logger)
    {
        _logger = logger.CreateLogger<CounterAppService>();
    }

    public void Count(int loops)
    {
        for (var i = 0; i < loops; i++)
            _logger.LogInformation($"We have got the {i} Loop");
    }
}
  • Program 中对 DI 组件的初始化和服务的注册
private static void Main(string[] args)
{
    var serviceProvider = new ServiceCollection()
        .AddLogging()
        .AddSingleton<ICounterAppService, CounterAppService>()
        .BuildServiceProvider();

    serviceProvider
        .GetService<ILoggerFactory>()
        .AddConsole(LogLevel.Debug);

    var logger = serviceProvider.GetService<ILoggerFactory>()
        .CreateLogger<Program>();
    logger.LogDebug("Starting application");

    var counter = serviceProvider.GetService<ICounterAppService>();
    counter.Count(10);

    logger.LogDebug("All done!");
}

我们手动创建 serviceProvider 的过程其实就是 ASP.NET CORE 执行 ConfigureServices 方法的过程,同样的,上述代码也展示了手动解析 Logger 实例和通过构造函数注入解析 Logger 实例的两种方式。其中 AddLogging 方法的背后代码如下所示:

public static IServiceCollection AddLogging(this IServiceCollection services)
{
  if (services == null)
    throw new ArgumentNullException("services");
  services.TryAdd(ServiceDescriptor.Singleton<ILoggerFactory, LoggerFactory>());
  services.TryAdd(ServiceDescriptor.Singleton(typeof (ILogger<>), typeof (Logger<>)));
  return services;
}

2. 在 Console 中使用第三方 Autofac DI 组件

笔者曾经写过在 ASP.NET CORE 使用 Autofac 组件的例子,而在 Console 中,注册流程也没有什么变化。以下是 Program 中的代码

private static void Main(string[] args)
{
    var serviceCollection = new ServiceCollection();
    
    serviceCollection.AddLogging();

    var containerBuilder = new ContainerBuilder();
    
    // 将原本注册在内置 DI 组件中的依赖迁移入 Autofac 中
    containerBuilder.Populate(serviceCollection);
    
    // 也可以把 ICounterAppService 预先注入到内置 DI 中再使用 Populate 方法迁移
    containerBuilder.RegisterType<CounterAppService>().As<ICounterAppService>();
    
    var container = containerBuilder.Build();
    var serviceProvider = new AutofacServiceProvider(container);
    
    serviceProvider
        .GetService<ILoggerFactory>()
        .AddConsole(LogLevel.Debug);

    var logger = serviceProvider.GetService<ILoggerFactory>()
        .CreateLogger<Program>();
    logger.LogDebug("Starting!");

    var counter = serviceProvider.GetService<ICounterAppService>();
    counter.Count(10);

    logger.LogDebug("Done!");
}

同时,Autofac中也提供了诸如 RegisterAssemblyTypes 的方法用于程序集中服务的批量注入,这也是第三方容器的优势所在。

Using dependency injection in a .Net Core console application ASP.NET Core Dependency Injection Deep Dive