如何在ASP.NET Core的ConfigurationBuilder中设置必填环境变量

你可以借助ASP.NET Core的Options模式结合数据注解（或第三方验证库）来实现自动标记并验证必填配置项，无需手动逐一检查。以下是具体实现方案：

方案一：使用内置数据注解验证 #

1. 修改配置类，添加必填标记 #

引用System.ComponentModel.DataAnnotations命名空间，用[Required]注解标记必填字段：

using System.ComponentModel.DataAnnotations;

public class Config
{
    [ConfigurationKeyName("NOT_REQUIRED_VARIABLE")]
    public string? First { get; set; } = "first";

    [Required(ErrorMessage = "必须设置环境变量REQUIRED_VARIABLE")]
    [ConfigurationKeyName("REQUIRED_VARIABLE")]
    public string? Second { get; set; }
}

2. 配置Options并启用启动时验证 #

在Program.cs中替换原有的手动绑定逻辑，改用Options模式绑定配置并启用验证：

var builder = WebApplication.CreateBuilder(args);

// 绑定配置并启用验证
builder.Services.AddOptions<Config>()
    .Bind(builder.Configuration) // 自动从所有配置源（含环境变量）绑定
    .ValidateDataAnnotations() // 启用数据注解验证
    .ValidateOnStart(); // 应用启动时立即验证，而非首次使用时

var app = builder.Build();

// 后续中间件配置...

app.Run();

如果未设置REQUIRED_VARIABLE环境变量，应用启动时会直接抛出验证异常，阻止服务器启动，完全符合你的需求。

方案二：复杂验证用FluentValidation #

如果需要更灵活的验证规则（比如格式校验、自定义逻辑），可以用FluentValidation扩展：

1. 安装依赖包 #

dotnet add package Microsoft.Extensions.Options.FluentValidation
dotnet add package FluentValidation.AspNetCore

2. 创建自定义验证器 #

using FluentValidation;

public class ConfigValidator : AbstractValidator<Config>
{
    public ConfigValidator()
    {
        // 验证Second字段非空，对应环境变量REQUIRED_VARIABLE必须设置
        RuleFor(config => config.Second)
            .NotEmpty()
            .WithMessage("环境变量REQUIRED_VARIABLE为必填项");
    }
}

3. 配置验证逻辑 #

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddOptions<Config>()
    .Bind(builder.Configuration)
    .ValidateFluentValidation() // 启用FluentValidation验证
    .ValidateOnStart();

var app = builder.Build();

// 后续配置...

app.Run();

为什么不推荐原构造函数绑定方式？ #

你原代码中在构造函数手动创建ConfigurationBuilder并绑定的方式，需要自己编写验证逻辑，无法利用框架内置的启动时验证机制。改用Options模式后，不仅能自动完成绑定，还能集成多种验证方式，代码更简洁规范。

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