.NET Core 3.1应用K8s优先读环境变量缺省回退appsettings.json配置问题

问题原因 #

你遇到的问题由两个核心错误导致：

• 你初始化ConfigurationBuilder时仅注册了环境变量配置源，没有加载appsettings.json文件，自然无法读取json中的预设值
• appsettings.json中的DB_NAME是嵌套在AppSettings:Data层级下的，和你直接读取的顶级DB_NAME键不匹配，就算加载了json文件也无法直接获取到对应值

解决方案 #

1. 调整配置源注册顺序 #

.NET Core的配置源优先级遵循后注册优先级更高的规则，要实现环境变量优先、缺失时回退appsettings的效果，需要先加载json文件，再注册环境变量：

var configuration = new ConfigurationBuilder()
    // 指定配置文件的基础路径为应用根目录
    .SetBasePath(AppContext.BaseDirectory)
    // 加载appsettings.json配置
    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
    // 后注册环境变量，优先级高于json配置，存在时自动覆盖json同名配置
    .AddEnvironmentVariables()
    .Build();

2. 匹配配置键读取路径 #

appsettings.json中DB_NAME的完整层级键为AppSettings:Data:DB_NAME，读取时需要匹配全路径：

// 写法1：直接读取全路径键
var dbname = configuration["AppSettings:Data:DB_NAME"];

// 写法2：先绑定父节点再读取对应值
var dbname = configuration.GetSection("AppSettings:Data").GetValue<string>("DB_NAME");

3. 跨平台环境变量适配说明 #

如果你希望保持环境变量的层级匹配规则，可使用双下划线__替代层级分隔符:（跨平台兼容，Linux/macOS仅支持双下划线作为层级分隔符），示例设置命令如下：

setx AppSettings__Data__DB_NAME "Kube_test_db"

该写法下无需调整读取代码，环境变量存在时会自动覆盖json中的对应值，缺失时自动回退json预设值。

注意：你之前使用的setx DB_NAME ="Kube_test_db"写法存在错误，变量名和等号之间的空格会导致最终生成的环境变量名包含尾部空格，导致程序无法正常读取，正确写法需去掉空格：setx DB_NAME "Kube_test_db"

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