.NET Core Web API程序化修改appsettings及动态读取方案咨询

针对你遇到的场景，要实现修改appsettings.json或环境专属配置文件后无需重启应用就能读取新值，可按以下步骤操作：

1. 让配置源支持自动重载 #

在应用启动时，配置Json文件时开启ReloadOnChange选项，这样配置文件被修改后，配置系统会自动检测到变更并更新内存中的配置。

var builder = WebApplication.CreateBuilder(args);

// 启用appsettings.json自动重载
builder.Configuration.AddJsonFile(
    "appsettings.json",
    optional: false,
    reloadOnChange: true
);

// 环境专属配置文件同样开启重载
builder.Configuration.AddJsonFile(
    $"appsettings.{builder.Environment.EnvironmentName}.json",
    optional: true,
    reloadOnChange: true
);

2. 使用正确的配置注入方式 #

不要用IOptions<T>（它是单例，启动后不会更新），改用以下两种方式获取实时配置：

方式一：IOptionsSnapshot #

适合Web请求场景，每次请求会获取最新的配置值，是范围注入的服务：

public class MyService
{
    private readonly MySettings _settings;

    // 注入IOptionsSnapshot<MySettings>
    public MyService(IOptionsSnapshot<MySettings> settings)
    {
        _settings = settings.Value;
    }

    public void DoWork()
    {
        // 这里获取的是最新配置值
        var apiUrl = _settings.ThirdPartyApiUrl;
    }
}

方式二：IOptionsMonitor #

支持实时监听配置变更，还能订阅变更事件，适合需要主动响应配置变化的场景：

public class MyService
{
    private readonly IOptionsMonitor<MySettings> _settingsMonitor;
    private MySettings _currentSettings;

    public MyService(IOptionsMonitor<MySettings> settingsMonitor)
    {
        _settingsMonitor = settingsMonitor;
        // 初始化当前配置
        _currentSettings = settingsMonitor.CurrentValue;
        // 订阅配置变更事件
        settingsMonitor.OnChange(settings => 
        {
            _currentSettings = settings;
            // 这里可以做配置变更后的逻辑，比如更新HttpClient地址
        });
    }

    public void DoWork()
    {
        var apiUrl = _currentSettings.ThirdPartyApiUrl;
    }
}

3. UI修改配置后的强制刷新（可选） #

如果你的UI是通过接口写入配置文件，写完后可以主动调用IConfigurationRoot.Reload()来强制刷新配置，确保内存中的配置立即更新：

[ApiController]
[Route("api/config")]
public class ConfigController : ControllerBase
{
    private readonly IConfigurationRoot _configurationRoot;
    private readonly IWebHostEnvironment _env;

    public ConfigController(IConfiguration configuration, IWebHostEnvironment env)
    {
        _configurationRoot = (IConfigurationRoot)configuration;
        _env = env;
    }

    [HttpPost]
    public IActionResult UpdateConfig(MySettings newSettings)
    {
        // 将新配置写入appsettings.{Environment}.json文件的逻辑
        var configPath = Path.Combine(_env.ContentRootPath, $"appsettings.{_env.EnvironmentName}.json");
        var json = JsonSerializer.Serialize(newSettings, new JsonSerializerOptions { WriteIndented = true });
        System.IO.File.WriteAllText(configPath, json);

        // 强制刷新配置
        _configurationRoot.Reload();

        return Ok();
    }
}

关键注意事项 #

• 敏感配置保护：不要把密钥、密码等敏感配置暴露在编辑UI里，必须加权限校验，只允许授权人员修改非敏感配置。
• 配置原子性：写入配置文件时要确保原子操作，避免文件被部分写入导致配置损坏，比如先写临时文件再替换原文件。
• 依赖初始配置的服务：如果某些服务（比如HttpClient）在启动时依赖配置初始化，需要改用工厂模式动态创建实例，或者在配置变更时重新初始化服务。

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