.NET IOptions框架如何标记配置项为必填并实现启动校验？

可以实现这个需求，核心思路是结合数据注解验证+在应用启动阶段主动触发配置校验，同时支持解析[ConfigurationKeyName]特性来显示正确的配置键名，而非类属性名。

实现步骤与代码示例 #

1. 定义带验证特性的Options类

给必填字段添加[Required]注解，同时用[ConfigurationKeyName]指定配置文件中的键名：

using System.ComponentModel.DataAnnotations;
using Microsoft.Extensions.Configuration;

public class MyOptions
{
    public string OptionalOption { get; set; }

    [Required]
    [ConfigurationKeyName("REQUIRED_OPTION")]
    public string RequiredOption { get; set; }
}

2. 编写配置验证扩展方法

封装一个扩展方法，用来在启动时验证Options，并自动解析ConfigurationKeyName生成正确的错误信息：

using System.ComponentModel.DataAnnotations;
using System.Reflection;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Options;

public static class OptionsValidationExtensions
{
    public static void ValidateRequiredOptions<T>(this IServiceProvider serviceProvider, string configSectionPath)
        where T : class
    {
        var options = serviceProvider.GetRequiredService<IOptions<T>>().Value;
        var validationContext = new ValidationContext(options);
        var validationResults = new List<ValidationResult>();

        if (!Validator.TryValidateObject(options, validationContext, validationResults, validateAllProperties: true))
        {
            foreach (var result in validationResults)
            {
                foreach (var memberName in result.MemberNames)
                {
                    var property = typeof(T).GetProperty(memberName);
                    var keyAttr = property?.GetCustomAttribute<ConfigurationKeyNameAttribute>();
                    var configKey = keyAttr?.Name ?? memberName;
                    var fullConfigPath = $"{configSectionPath}:{configKey}";
                    
                    throw new InvalidOperationException($"Required configuration {fullConfigPath} not found in Configuration");
                }
            }
        }
    }
}

3. 在启动时触发校验

在注册完Options后，立即构建服务提供者并执行验证，确保配置缺失时应用启动失败：

var builder = WebApplication.CreateBuilder(args);

// 绑定配置到Options
builder.Services.Configure<MyOptions>(builder.Configuration.GetSection("MyOptions"));

// 构建临时服务提供者并执行校验
var serviceProvider = builder.Services.BuildServiceProvider();
serviceProvider.ValidateRequiredOptions<MyOptions>("MyOptions");

var app = builder.Build();

// 后续应用配置...

app.Run();

效果说明 #

当appsettings.json中缺少MyOptions:REQUIRED_OPTION时，应用在启动阶段就会抛出异常，错误信息为：

Required configuration MyOptions:REQUIRED_OPTION not found in Configuration

完全符合需求，不需要等到消费IOptions<MyOptions>时才发现配置缺失。

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