如何在运行内存测试服务器时读取appsettings.Local.json配置？

我有一个ASP.NET Core 8 Web API项目，包含以下配置文件：

• appsettings.json
• appsettings.Local.json

我创建了一个使用内存测试服务器的测试项目，当前测试项目配置如下：

var factory = new WebApplicationFactory<Program>()
            .WithWebHostBuilder(builder =>
            {
                builder.ConfigureServices(services => 
                {
                });

                builder.ConfigureTestServices(services =>
                {
                });

                builder.ConfigureAppConfiguration(config =>
                {
                    config.AddConfiguration(Configuration);
                });
            });

问题是测试项目运行内存测试服务器时，Web API的Program.cs读取的是appsettings.json而非appsettings.Local.json的配置值，比如这段代码：

var builder = WebApplication.CreateBuilder(args);

//...一些服务注册代码

builder.Configuration["ConnectionsStrings:MyData"] // 这里读取的是appsettings.json里的值，而非appsettings.Local.json

var app = builder.Build();

请问如何配置测试项目，让Program.cs加载appsettings.Local.json的配置值？

方法1：手动添加appsettings.Local.json配置源 #

在测试项目的ConfigureAppConfiguration中，直接指定Web API项目里的appsettings.Local.json文件路径，让测试服务器加载该配置：

var factory = new WebApplicationFactory<Program>()
    .WithWebHostBuilder(builder =>
    {
        builder.ConfigureAppConfiguration(config =>
        {
            // 清除默认配置源（可选，避免与测试配置冲突）
            config.Sources.Clear();
            
            // 添加Web API的基础配置文件
            var apiProjectPath = Path.Combine(Directory.GetCurrentDirectory(), "../YourApiProjectName");
            config.AddJsonFile(Path.Combine(apiProjectPath, "appsettings.json"), optional: false, reloadOnChange: true);
            // 添加Local配置文件，路径需匹配你的项目结构
            config.AddJsonFile(Path.Combine(apiProjectPath, "appsettings.Local.json"), optional: true, reloadOnChange: true);
            
            // 保留测试项目自身的配置（如果需要）
            config.AddConfiguration(Configuration);
        });
    });

替换YourApiProjectName为Web API项目的实际名称，确保路径能正确定位到配置文件。

方法2：设置测试环境为Local，让框架自动加载对应配置 #

ASP.NET Core会根据当前环境自动加载appsettings.{Environment}.json格式的配置文件。如果你的appsettings.Local.json对应Local环境，直接在测试中设置环境变量即可：

var factory = new WebApplicationFactory<Program>()
    .WithWebHostBuilder(builder =>
    {
        // 指定运行环境为Local，框架会自动加载appsettings.Local.json
        builder.UseEnvironment("Local");
        
        builder.ConfigureAppConfiguration(config =>
        {
            config.AddConfiguration(Configuration);
        });
    });

这种方式下，Local配置会自动覆盖appsettings.json中的同名配置项，符合实际运行时的配置优先级逻辑。

方法3：配置ContentRoot指向Web API项目目录 #

默认测试服务器的ContentRoot是测试项目的输出目录，可能无法找到Web API的配置文件。将ContentRoot设置为Web API项目根目录，配合环境设置，就能完全复用项目的默认配置加载逻辑：

// 定位Web API项目根目录
var apiProjectDir = Path.Combine(Directory.GetCurrentDirectory(), "../YourApiProjectName");

var factory = new WebApplicationFactory<Program>()
    .WithWebHostBuilder(builder =>
    {
        // 设置ContentRoot为Web API项目目录
        builder.UseContentRoot(apiProjectDir);
        // 指定运行环境为Local
        builder.UseEnvironment("Local");
    });

注意事项 #

• 确保Web API项目中appsettings.Local.json的“复制到输出目录”属性设置为“如果较新则复制”或“始终复制”，避免文件无法被测试服务器读取。
• 如果你的项目习惯用appsettings.Development.json对应本地开发配置，只需将环境设置为Development即可，无需修改文件名。

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