.NET 8应用启动时如何为缺失的appSettings配置项设默认值？

下面提供几种满足需求的实现方式，核心是配置文件存在的项优先，缺失项用硬编码默认值填充，且不修改实际的appSettings文件：

1. 配置类内直接设置默认值（最简单） #

直接在TokenOptions类的属性上赋值默认值，配置绑定过程中，配置文件里存在的项会覆盖默认值，缺失项则保留默认值：

public class TokenOptions
{
    // 硬编码默认值，配置缺失时自动生效
    public string BaseUri { get; set; } = "a-hardcoded-default-value";
    public string Username { get; set; } = string.Empty;
    public string Password { get; set; } = string.Empty;
}

原有ConfigureServices中的代码无需修改，保持原样即可：

serviceCollection.Configure<TokenOptions>(configuration.GetSection(nameof(TokenOptions)));
serviceCollection.AddTransient(resolver => resolver.GetService<IOptionsMonitor<TokenOptions>>().CurrentValue);

2. 配置绑定后手动补全默认值 #

如果不想在配置类中写死默认值，可以在绑定配置后，手动检查并补全缺失的属性：

serviceCollection.Configure<TokenOptions>(options =>
{
    // 先绑定配置文件中的内容
    configuration.GetSection(nameof(TokenOptions)).Bind(options);
    
    // 仅当属性为null/空时，设置默认值
    options.BaseUri ??= "a-hardcoded-default-value";
    options.Username ??= string.Empty;
    options.Password ??= string.Empty;
});

serviceCollection.AddTransient(resolver => resolver.GetService<IOptionsMonitor<TokenOptions>>().CurrentValue);

3. 启动时检查配置段，按需加载默认值 #

如果需要明确判断配置段是否存在，再决定是否使用默认配置：

var tokenConfigSection = configuration.GetSection(nameof(TokenOptions));

if (!tokenConfigSection.Exists())
{
    // 配置段完全缺失，直接使用全量默认值
    serviceCollection.Configure<TokenOptions>(options =>
    {
        options.BaseUri = "a-hardcoded-default-value";
        options.Username = string.Empty;
        options.Password = string.Empty;
    });
}
else
{
    // 配置段存在，绑定后补全缺失属性
    serviceCollection.Configure<TokenOptions>(options =>
    {
        tokenConfigSection.Bind(options);
        options.BaseUri ??= "a-hardcoded-default-value";
    });
}

serviceCollection.AddTransient(resolver => resolver.GetService<IOptionsMonitor<TokenOptions>>().CurrentValue);

额外：添加配置验证（确保关键配置存在） #

如果需要确保某些配置项（比如Username/Password）必须存在，否则应用启动失败，可以添加验证逻辑：

第一步：给配置类添加数据注解 #

using System.ComponentModel.DataAnnotations;

public class TokenOptions
{
    public string BaseUri { get; set; } = "a-hardcoded-default-value";
    
    [Required(ErrorMessage = "Username配置项不能为空")]
    public string Username { get; set; } = string.Empty;
    
    [Required(ErrorMessage = "Password配置项不能为空")]
    public string Password { get; set; } = string.Empty;
}

第二步：在ConfigureServices中启用验证 #

serviceCollection.AddOptions<TokenOptions>()
    .Bind(configuration.GetSection(nameof(TokenOptions)))
    .ValidateDataAnnotations() // 启用数据注解验证
    // 也可以添加自定义验证逻辑
    .Validate(options => 
    {
        return !string.IsNullOrWhiteSpace(options.Username) && !string.IsNullOrWhiteSpace(options.Password);
    }, "Username和Password不能为空白");

serviceCollection.AddTransient(resolver => resolver.GetService<IOptionsMonitor<TokenOptions>>().CurrentValue);

这样当配置不满足要求时，应用启动阶段就会抛出异常，避免运行时出现配置缺失问题。

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