使用ConfigurationBuilder.AddJsonFile提示文件不存在但实际存在的原因排查

可能的原因 #

• 相对路径解析的上下文差异：
  File.Exists 和 ConfigurationBuilder.AddJsonFile 默认都基于当前工作目录，但如果在执行 File.Exists 后，代码中存在修改 Environment.CurrentDirectory 的操作，会导致后续 AddJsonFile 解析路径时上下文变化，找不到文件。
• 跨平台大小写不匹配：
  在 Linux/macOS 环境下，文件名区分大小写。如果代码中路径的大小写与实际文件不一致，File.Exists（若在 Windows 开发环境测试）可能返回 true，但部署到 Linux/macOS 运行时，AddJsonFile 会因大小写不匹配找不到文件。
• ConfigurationBuilder 基础路径被修改：
  如果项目中其他代码提前调用了 SetBasePath 修改了配置构建器的基础路径，后续使用相对路径时会基于新的基础路径解析，而非当前工作目录，导致路径不匹配。

解决方法 #

1. 使用绝对路径
   将相对路径转换为绝对路径，彻底避免上下文差异问题：

   string relative_path = "../../../../appsettings_global.json";
   string absolute_path = Path.GetFullPath(relative_path);
   if (File.Exists(absolute_path)) {
       IConfigurationRoot global_config = new ConfigurationBuilder()
           .AddJsonFile(absolute_path, false, true)
           .Build();
       global_settings = global_config.GetRequiredSection("Settings").Get<GLOBAL_SETTINGS>();
   }
   

2. 显式设置配置构建器的基础路径
   明确指定 ConfigurationBuilder 的基础路径为当前工作目录，确保路径解析一致：

   string relative_path = "../../../../appsettings_global.json";
   if (File.Exists(relative_path)) {
       IConfigurationRoot global_config = new ConfigurationBuilder()
           .SetBasePath(Directory.GetCurrentDirectory())
           .AddJsonFile(relative_path, false, true)
           .Build();
       global_settings = global_config.GetRequiredSection("Settings").Get<GLOBAL_SETTINGS>();
   }
   

3. 检查文件复制属性
   确保项目中的 appsettings_global.json 文件属性设置为 复制到输出目录：始终复制 或 如果较新则复制，保证编译后文件出现在程序运行目录中。

4. 排查工作目录变更
   在 File.Exists 和 AddJsonFile 之间添加调试代码，检查 Environment.CurrentDirectory 是否被修改：

   string relative_path = "../../../../appsettings_global.json";
   if (File.Exists(relative_path)) {
       Console.WriteLine($"Current Directory: {Environment.CurrentDirectory}");
       IConfigurationRoot global_config = new ConfigurationBuilder().AddJsonFile(relative_path, false, true).Build();
       global_settings = global_config.GetRequiredSection("Settings").Get<GLOBAL_SETTINGS>();
   }
   

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