.NET Options读取appsettings.Development.json数组配置未覆盖默认值问题

问题原因说明 #

你遇到的数组追加问题是.NET Options配置绑定的默认行为导致的：绑定数组、List这类集合类型属性时，系统默认不会清空属性已初始化的内容，而是将配置中的元素逐个追加到集合中，因此你在属性初始化器里预置的["*"]会和配置文件里的["1010","2020","3030"]合并，最终得到4个元素的数组。

问题1：通过类属性初始化器给配置类设置默认值是否合理？ #

这个方案的合理性要分场景看：

• 对字符串、数字、布尔值这类非集合类型属性，方案完全可用，配置绑定时会直接覆盖初始化的默认值，不会出现异常逻辑。
• 对数组、列表等集合类型属性，方案存在固有缺陷：受默认追加绑定行为影响，很容易出现默认值和配置值意外合并的问题，不推荐使用。
• 结合你「SettingB仅在开发环境生效，生产环境不允许用户修改」的需求，这个方案还有额外风险：如果用户在随发布包提供的appsettings.json里手动添加SettingB配置段，内容会被自动绑定生效，直接突破你设置的修改限制。

问题2：如何实现配置绑定，让开发环境下ItemB得到预期的覆盖值？ #

根据你的场景，优先推荐按环境隔离配置注册逻辑的方案，从根源上避免默认值合并、生产配置被篡改的问题：

1. 首先修改SettingB类，去掉集合属性的默认值初始化，避免触发追加逻辑：

   public class SettingB
   {
       public string[] ItemB { get; set; } = Array.Empty<string>();
   }
   

2. 在服务注册阶段，根据当前运行环境选择不同的Options配置逻辑：

   var builder = WebApplication.CreateBuilder(args);
   
   // 其他服务注册逻辑...
   
   if (builder.Environment.IsDevelopment())
   {
       // 开发环境：绑定appsettings.Development.json中的SettingB配置段
       // 绑定目标是空数组，配置值会直接填充，不会出现追加问题
       services.AddOptions<SettingB>()
               .BindConfiguration("SettingB");
   }
   else
   {
       // 生产环境：不绑定任何配置源，直接写入硬编码默认值
       // 即使用户手动修改appsettings.json添加SettingB配置，也不会生效
       services.AddOptions<SettingB>()
               .Configure(setting =>
               {
                   setting.ItemB = new[] { "*" };
               });
   }
   

这个方案完全匹配你的需求：开发环境读取到的ItemB就是配置文件里的["1010","2020","3030"]，生产环境固定返回["*"]，用户无法通过修改发布包的配置文件篡改SettingB的值。

如果你不想拆分环境注册逻辑，且项目使用的是.NET 8及以上版本，也可以通过修改集合绑定规则实现值替换：

services.AddOptions<SettingB>()
        .BindConfiguration("SettingB", binderOpt =>
        {
            // 关键配置：绑定集合时直接替换原有内容，而非追加
            binderOpt.CollectionBindingBehavior = CollectionBindingBehavior.Replace;
        })
        // 兜底：配置中不存在对应节点时应用默认值
        .ConfigureDefault(setting =>
        {
            if (setting.ItemB.Length == 0)
            {
                setting.ItemB = new[] { "*" };
            }
        });

注意该方案存在安全隐患：生产环境下用户手动添加的SettingB配置会被正常绑定生效，不符合你「不允许用户修改SettingB」的要求，仅适合内部使用的场景。

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