.NET命令行应用如何在启动时添加Options验证？

问题根源 #

ValidateOnStart()方法并非来自Microsoft.Extensions.Options.DataAnnotations包，而是**Microsoft.Extensions.Hosting**包提供的扩展方法。Web项目的WebApplicationBuilder默认集成了Host相关功能，所以能直接调用该方法；而纯控制台项目若未引用Host包，自然找不到这个方法。

解决方案步骤 #

1. 安装必要NuGet包

在命令行项目中安装Microsoft.Extensions.Hosting包：

Install-Package Microsoft.Extensions.Hosting

也可通过NuGet包管理器搜索安装。

2. 使用HostBuilder替代直接创建ServiceCollection

不要手动实例化ServiceCollection，改用Host.CreateDefaultBuilder构建服务容器，它会自动处理配置加载、服务生命周期管理，以及启动时的Options验证流程：

var host = Host.CreateDefaultBuilder(args)
    .ConfigureServices((context, services) =>
    {
        // 配置Options并启用启动时验证
        services.AddOptions<MailConfig>()
            .ValidateDataAnnotations()
            .ValidateOnStart()
            .BindConfiguration("Mail");
        
        // 注入Options实例（和Web项目逻辑一致）
        services.AddSingleton(resolver => resolver.GetRequiredService<IOptions<MailConfig>>().Value);

        // 注册你的定时任务服务等其他依赖
    })
    .Build();

// 启动Host，此时会自动触发Options的启动时验证
await host.RunAsync();

3. （可选）若坚持用ServiceCollection手动构建

如果不想用HostBuilder，也可以手动触发验证（模拟ValidateOnStart()的效果），但这种方式不够规范：

var collection = new ServiceCollection();

// 先添加配置服务（BindConfiguration依赖IConfiguration）
collection.AddSingleton<IConfiguration>(new ConfigurationBuilder()
    .AddJsonFile("appsettings.json")
    .AddCommandLine(args)
    .Build());

// 配置Options
collection.AddOptions<MailConfig>()
    .ValidateDataAnnotations()
    .BindConfiguration("Mail");

collection.AddSingleton(resolver => resolver.GetRequiredService<IOptions<MailConfig>>().Value);

var provider = collection.BuildServiceProvider();

// 手动访问Options.Value触发验证，验证失败会抛出ValidationException
_ = provider.GetRequiredService<IOptions<MailConfig>>().Value;

// 后续执行定时任务逻辑

关键说明 #

• Host.CreateDefaultBuilder会自动加载appsettings.json、命令行参数等配置源，无需手动构建IConfiguration。
• 启动Host时，ValidateOnStart()会强制验证所有标记了该方法的Options配置，若验证失败会直接抛出异常，阻止程序启动，和Web项目的行为完全一致。

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