如何将API硬编码设置迁移至配置文件，避免调整设置即重编译且兼容现有客户端JS调用

完整实现流程 #

1. 修正强类型类的可绑定属性 #

原定义的Settings类存在配置绑定兼容问题，需要调整：

• 为所有属性添加公共set访问器，否则.NET配置引擎无法完成属性赋值
• 补充原硬编码返回值中存在的可选chips字段，避免序列化时丢失字段
  修正后的完整类定义：

/// <summary>
/// 单条配置项的强类型定义
/// </summary>
public class ConfigItem
{
    public int Id { get; set; }
    public string Size { get; set; }
    public int Order { get; set; }
    public int[] Arrays { get; set; }
    public object Chips { get; set; }
}

/// <summary>
/// 配置文件根绑定模型
/// </summary>
public class Settings
{
    public List<ConfigItem> ConfigItems { get; set; } = new();
}

2. 将硬编码值迁移到配置文件 #

打开项目根目录下的appsettings.json，保留原有所有配置节点不动，新增和强类型模型结构完全对应的配置段，把原来硬编码的10条配置值逐行录入：

{
  // ... 原有配置保持不变
  "Settings": {
    "ConfigItems": [
      { "id": 1, "size": "big", "order": 6 },
      { "id": 2, "size": "small", "order": 4 },
      { "id": 3, "size": "medium", "order": 2 },
      { "id": 4, "size": "small", "order": 5 },
      { "id": 5, "size": "small", "order": 8, "chips": {} },
      { "id": 6, "size": "small", "order": 7 },
      { "id": 7, "size": "big", "order": 1, "chips": {} },
      { "id": 8, "size": "small", "order": 3 },
      { "id": 10, "size": "big", "order": 9 },
      { "id": 20, "size": "big", "order": 10 }
    ]
  }
}

后续新增配置项只需要编辑这个JSON文件，保存后即可生效，不需要重新编译项目；如果需要修改配置后不重启API就生效，可以开启配置热重载能力。

3. 注册配置绑定规则 #

在项目的服务注册阶段（.NET 6+为Program.cs，旧版本为Startup.cs），将配置节点绑定到强类型类并注册为可注入服务：

// 将appsettings中的Settings节点绑定到强类型模型
builder.Services.Configure<Settings>(builder.Configuration.GetSection("Settings"));

// 注册直接可注入的配置实例
builder.Services.AddSingleton(sp => 
    sp.GetRequiredService<IOptions<Settings>>().Value
);

4. 替换原API端点的硬编码逻辑 #

修改原来返回硬编码列表的端点，直接注入绑定好的强类型配置，返回对应列表即可：

[HttpGet("get-app-config")]
public IActionResult GetAppConfig([FromServices] Settings appSettings)
{
    // 返回的JSON结构和原硬编码输出完全一致，无字段差异
    return new JsonResult(appSettings.ConfigItems);
}

前端兼容性说明 #

你提供的基于XMLHttpRequest的Promise封装逻辑不需要做任何修改，可正常对接改造后的接口：

• 接口返回标准JSON格式，xhr.response、xhr.responseText均可正常取到值
• 返回结构和原硬编码输出完全一致，不会出现前端解析字段缺失、结构错乱的问题
• 正常返回200状态码时会触发Promise的resolve逻辑，和现有前端代码的判断规则完全匹配

注意事项 #

• 配置绑定默认不区分大小写，JSON节点名称和强类型属性名保持一致即可，无需严格对齐大小写
• 原Settings类的只读属性必须补充setter，否则会出现所有属性值为默认值的绑定失败问题
• 新增Arrays字段的配置项时，直接在JSON对应节点添加数组格式的值即可，会自动绑定到强类型类的int[] Arrays属性
• 不要在控制器中重新硬编码配置值，所有配置内容统一维护在appsettings.json中，满足免编译生效的需求

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