.NET 6中基于Options模式实现命令行参数与默认配置动态加载

在采用依赖注入与Options模式的.NET 6控制台应用中，需要实现以下需求：

• 加载用户输入的命令行参数
• 以工厂式方式解析IOptions<ArgSettings>
• 当命令行参数未提供（为空或无效）时，自动回退使用appsettings.json中的默认配置

现有代码实现 #

实体与服务定义 #

public class ArgSettings
{
    public string Name { get; set; }
    public string Region { get; set; }
}

public interface IService
{
    void DoSomthing();
}

public class MyService: IService
{
    private readonly ArgSettings _argSettings;

    public MyService(IOptions<ArgSettings> cfg)
    {
        _argSettings = cfg.Value;
    }
    public void DoSomthing()
    {
        // 业务逻辑实现
    }
}

现有Program入口代码 #

public class Program
{
    static void Main(string[] args)
    {
        ArgSettings argsSettings = BindArgsSettings(Environment.GetCommandLineArgs());

        var host = Host.CreateDefaultBuilder(args)
          .ConfigureServices((context, services) =>
          {
              var configurationRoot = context.Configuration;

              services.Configure<ArgSettings>(
                  configurationRoot.GetSection("Defaults:Args"));

              services.AddTransient<IService, MyService>();

          }).Build();
    }

    // 待完善的命令行参数绑定方法
    private static ArgSettings BindArgsSettings(string[] commandLineArgs)
    {
        return new ArgSettings();
    }
}

appsettings.json默认配置 #

{
  "Defaults": {
    "Args": {
        "Name": "John",
        "Region": "USA"
    }
  }
}

解决方案实现 #

1. 完善命令行参数解析逻辑 #

实现BindArgsSettings方法，支持--Name、--Region格式的命令行参数解析：

private static ArgSettings BindArgsSettings(string[] commandLineArgs)
{
    var settings = new ArgSettings();
    for (int i = 0; i < commandLineArgs.Length; i++)
    {
        switch (commandLineArgs[i].ToLower())
        {
            case "--name":
                if (i + 1 < commandLineArgs.Length)
                    settings.Name = commandLineArgs[i + 1];
                break;
            case "--region":
                if (i + 1 < commandLineArgs.Length)
                    settings.Region = commandLineArgs[i + 1];
                break;
        }
    }
    return settings;
}

2. 工厂式合并配置与Options注册 #

通过AddOptions的配置逻辑，实现命令行参数优先、默认配置兜底的合并策略：
修改Program中的ConfigureServices代码块：

var host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((context, services) =>
    {
        var configurationRoot = context.Configuration;
        // 加载appsettings中的默认配置
        var defaultSettings = configurationRoot.GetSection("Defaults:Args").Get<ArgSettings>();
        // 解析命令行参数
        var cmdLineSettings = BindArgsSettings(Environment.GetCommandLineArgs());

        // 工厂式配置Options：合并命令行参数与默认配置，命令行非空参数覆盖默认值
        services.AddOptions<ArgSettings>()
            .Configure(options =>
            {
                // 先赋值默认配置
                options.Name = defaultSettings.Name;
                options.Region = defaultSettings.Region;
                // 用命令行参数覆盖非空项
                if (!string.IsNullOrEmpty(cmdLineSettings.Name))
                    options.Name = cmdLineSettings.Name;
                if (!string.IsNullOrEmpty(cmdLineSettings.Region))
                    options.Region = cmdLineSettings.Region;
            });

        services.AddTransient<IService, MyService>();
    }).Build();

3. 可选：添加配置有效性验证 #

如果需要确保配置合法性，可给ArgSettings添加数据注解，并启用Options验证：

using System.ComponentModel.DataAnnotations;

public class ArgSettings
{
    [Required(ErrorMessage = "Name参数不能为空")]
    public string Name { get; set; }
    [Required(ErrorMessage = "Region参数不能为空")]
    public string Region { get; set; }
}

在注册Options时添加验证逻辑：

services.AddOptions<ArgSettings>()
    .Configure(options =>
    {
        // 合并逻辑同上
    })
    .ValidateDataAnnotations()
    .ValidateOnStart();

工作原理说明 #

• 默认配置从appsettings.json的Defaults:Args节点加载
• 命令行参数解析后，仅覆盖非空的配置字段
• 最终注入MyService的IOptions<ArgSettings>.Value是合并后的结果，命令行参数优先级高于默认配置，未提供则使用预设默认值

内容的提问来源于stack exchange，提问作者Jornia Kabakum