.NET 6 API项目中能否用IOptionsSnapshot读取SQL数据库配置？

可以，但IOptionsSnapshot本身并不关心配置的来源——它是基于.NET的配置系统工作的，只要你把SQL数据库中的配置数据集成到配置系统里，就能用IOptionsSnapshot来读取这些数据。

实现步骤 #

1. 定义配置模型类 #

先创建一个和数据库配置项对应的模型类，用来绑定配置数据：

public class AppSettings
{
    public string ApiKey { get; set; }
    public int MaxRequestCount { get; set; }
}

2. 实现自定义SQL配置提供器 #

需要创建自定义的IConfigurationSource和ConfigurationProvider，负责从SQL数据库读取配置并加载到配置系统中：

// 配置源，用于创建配置提供器
public class SqlConfigurationSource : IConfigurationSource
{
    private readonly string _connectionString;

    public SqlConfigurationSource(string connectionString)
    {
        _connectionString = connectionString;
    }

    public IConfigurationProvider Build(IConfigurationBuilder builder)
    {
        return new SqlConfigurationProvider(_connectionString);
    }
}

// 配置提供器，负责实际读取SQL数据
public class SqlConfigurationProvider : ConfigurationProvider
{
    private readonly string _connectionString;

    public SqlConfigurationProvider(string connectionString)
    {
        _connectionString = connectionString;
    }

    // 加载配置数据的核心方法
    public override void Load()
    {
        var configDict = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);

        using var conn = new SqlConnection(_connectionString);
        conn.Open();
        // 假设数据库表名为AppConfigurations，有ConfigKey和ConfigValue两个字段
        var cmd = new SqlCommand("SELECT ConfigKey, ConfigValue FROM AppConfigurations", conn);
        using var reader = cmd.ExecuteReader();
        
        while (reader.Read())
        {
            var key = reader["ConfigKey"].ToString();
            var value = reader["ConfigValue"].ToString();
            configDict[key] = value;
        }

        // 将读取到的数据赋值给配置提供器的Data属性
        Data = configDict;
    }
}

3. 将SQL配置源添加到配置系统 #

在Program.cs中，把自定义的SQL配置源添加到配置构建器里：

var builder = WebApplication.CreateBuilder(args);

// 从现有配置（比如appsettings.json）获取数据库连接字符串
var dbConnString = builder.Configuration.GetConnectionString("DefaultConnection");
// 添加SQL配置源到配置系统
builder.Configuration.Add(new SqlConfigurationSource(dbConnString));

// 注册IOptionsSnapshot，绑定到配置模型
builder.Services.Configure<AppSettings>(builder.Configuration);

var app = builder.Build();

// 示例接口：使用IOptionsSnapshot读取配置
app.MapGet("/api/config", (IOptionsSnapshot<AppSettings> settingsSnapshot) =>
{
    return Results.Ok(settingsSnapshot.Value);
});

app.Run();

4. 可选：实现配置自动刷新 #

IOptionsSnapshot的特性是每次请求都会获取配置的快照，如果需要SQL中的配置更新后能自动同步，可以给配置提供器添加刷新逻辑：

// 在SqlConfigurationProvider中添加刷新方法
public void RefreshConfig()
{
    Load(); // 重新读取SQL数据
    OnReload(); // 触发配置重载事件
}

// 在Program.cs中设置定时刷新
var app = builder.Build();

var sqlProvider = app.Services.GetRequiredService<IConfiguration>().Providers
    .OfType<SqlConfigurationProvider>()
    .FirstOrDefault();

if (sqlProvider != null)
{
    // 每5分钟刷新一次配置
    var timer = new Timer(_ => sqlProvider.RefreshConfig(), null, TimeSpan.Zero, TimeSpan.FromMinutes(5));
    // 确保应用关闭时释放定时器
    app.Lifetime.ApplicationStopping.Register(() => timer.Dispose());
}

关键说明 #

• IOptionsSnapshot的核心是基于配置系统的快照机制，不管配置来自文件、数据库还是其他来源，只要配置系统能获取到数据，它就能读取。
• 自定义配置提供器是连接SQL和.NET配置系统的桥梁，你可以根据自己的数据库结构调整Load方法中的查询逻辑。

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