揭秘.NET Core控制台程序：如何优雅地读取配置、注入依赖、配置日志与使用IOptions(.NET Core控制台程序深度解析：优雅实现配置读取、依赖注入、日志配置及IOptions使用技巧)

原创

ithorizon 4周前 (10-21) 阅读数 49 #后端开发

一、引言

在.NET Core中，控制台应用程序是一种非常常见和基础的程序类型。它不仅可以作为自立的应用程序运行，还可以作为其他纷乱应用程序的基石。本文将深入解析.NET Core控制台程序中怎样优雅地读取配置、注入依赖性、配置日志以及使用IOptions。我们将通过实际的代码示例和详细分析，帮助开发者更好地明白和应用这些技巧。

二、优雅地读取配置

在.NET Core中，配置信息的读取是通过配置系统来完成的。配置系统赞成多种配置源，如JSON文件、环境变量、内存配置等。以下是怎样优雅地读取配置的步骤。

2.1 创建配置文件

通常，我们会在项目根目录下创建一个名为appsettings.json的配置文件。例如：


{
  "ConnectionStrings": {
    "DefaultConnection": "Server=.;Database=MyDatabase;Trusted_Connection=True;MultipleActiveResultSets=true;"
  },
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
}

2.2 配置配置类

在项目中创建一个配置类，用于映射appsettings.json中的配置数据。


public class ConnectionStrings
{
    public string DefaultConnection { get; set; }
}
public class AppSettings
{
    public ConnectionStrings ConnectionStrings { get; set; }
    public LoggingConfig Logging { get; set; }
}

2.3 读取配置

在Startup.cs或Program.cs中，使用ConfigurationBuilder来构建配置对象。


var builder = new ConfigurationBuilder()
    .SetBasePath(AppContext.BaseDirectory)
    .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
IConfiguration configuration = builder.Build();
AppSettings appSettings = configuration.GetSection<AppSettings>("AppSettings").Get<AppSettings>();

三、依赖性注入

依赖性注入（DI）是.NET Core的核心功能之一，它可以帮助我们更灵活地管理对象的生命周期和依赖性关系。

3.1 定义服务接口和实现类

首先，定义一个服务接口和对应的实现类。


public interface IMyService
{
    void DoWork();
}
public class MyService : IMyService
{
    public void DoWork()
    {
        Console.WriteLine("Service is working.");
    }
}

3.2 配置依赖性注入

在Startup.cs或Program.cs中，配置依赖性注入。


public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddSingleton();
    }
}

3.3 使用服务

在需要使用服务的地方，通过构造函数注入来获取服务实例。


public class Program
{
    private readonly IMyService _myService;
    public Program(IMyService myService)
    {
        _myService = myService;
    }
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.AddSingleton();
            });
    }
}

四、配置日志

日志记录是应用程序监控和调试的重要手段。在.NET Core中，日志系统提供了灵活的日志配置对策。

4.1 配置日志提供者

在appsettings.json中配置日志级别和输出格式。


{
  "Logging": {
    "IncludeScopes": false,
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    },
    "Console": {
      "LogLevel": {
        "Default": "Debug"
      }
    }
  }
}

4.2 配置日志服务

在Startup.cs或Program.cs中配置日志服务。


public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddLogging(loggingBuilder =>
        {
            loggingBuilder.ClearProviders();
            loggingBuilder.SetMinimumLevel(LogLevel.Trace);
            loggingBuilder.AddConsole();
        });
    }
}

4.3 使用日志记录

在需要记录日志的地方，通过构造函数注入ILogger实例。


public class Program
{
    private readonly ILogger<Program> _logger;
    public Program(ILogger<Program> logger)
    {
        _logger = logger;
    }
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.AddLogging(loggingBuilder =>
                {
                    loggingBuilder.ClearProviders();
                    loggingBuilder.SetMinimumLevel(LogLevel.Trace);
                    loggingBuilder.AddConsole();
                });
            });
}

五、使用IOptions

IOptions 是用于访问配置数据的便捷对策，它允许我们在类中注入配置数据。

5.1 配置类和配置文件

假设我们有以下配置类和配置文件。


public class AppSettings
{
    public string Title { get; set; }
}
appsettings.json:
{
  "AppSettings": {
    "Title": "My Application"
  }
}

5.2 配置依赖性注入

在Startup.cs或Program.cs中配置AppSettings的依赖性注入。


public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.Configure<AppSettings>(Configuration.GetSection("AppSettings"));
    }
}

5.3 使用IOptions读取配置

在需要使用配置数据的类中，通过构造函数注入IOptions。


public class Program
{
    private readonly IOptions<AppSettings> _appSettings;
    public Program(IOptions<AppSettings> appSettings)
    {
        _appSettings = appSettings;
    }
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }
    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureServices((hostContext, services) =>
            {
                services.Configure<AppSettings>(hostContext.Configuration.GetSection("AppSettings"));
            });
}