将带app.config的C#类库作为Azure Function引用后无法读取密钥

问题根源 #

你的类库通过ConfigurationManager.AppSettings读取app.config配置，但Azure Functions的local.settings.json配置不会自动注入到ConfigurationManager的配置集合中——Azure Functions默认采用IConfiguration接口或环境变量来管理配置，和普通类库的读取逻辑不兼容。

可行解决方案 #

方案1：重构类库用IConfiguration读取（推荐） #

让类库依赖IConfiguration，和Azure Functions的配置体系对齐：

1. 给类库安装Microsoft.Extensions.Configuration NuGet包
2. 修改类库的配置读取逻辑，通过注入IConfiguration实现：

public class SecretReader
{
    private readonly IConfiguration _config;

    public SecretReader(IConfiguration config)
    {
        _config = config;
    }

    public string GetMySecret()
    {
        return _config["YourSecretKey"];
    }
}

3. 在Azure Function项目中，通过依赖注入传递IConfiguration给类库实例：

public class MyFunction
{
    private readonly SecretReader _secretReader;

    public MyFunction(IConfiguration config)
    {
        _secretReader = new SecretReader(config);
    }

    [FunctionName("MyFunction")]
    public async Task<IActionResult> Run(...)
    {
        var secret = _secretReader.GetMySecret();
        // 业务逻辑实现
    }
}

方案2：手动同步配置到ConfigurationManager（兼容旧代码） #

如果不想修改类库代码，可以在Function启动时将local.settings.json的配置同步到ConfigurationManager：

1. 若使用隔离进程模型，在Program.cs中添加以下代码：

var host = new HostBuilder()
    .ConfigureFunctionsWorkerDefaults()
    .ConfigureAppConfiguration((context, config) =>
    {
        var builtConfig = config.Build();
        foreach (var setting in builtConfig.AsEnumerable())
        {
            ConfigurationManager.AppSettings[setting.Key] = setting.Value;
        }
    })
    .Build();

host.Run();

注意：该方式仅适用于本地调试；部署到Azure后，需在Function App的配置-应用程序设置中添加密钥，Azure会自动将这些设置转为环境变量，届时可再次同步到ConfigurationManager，或直接修改类库读取环境变量。

方案3：类库直接读取环境变量 #

Azure Functions会将local.settings.json中Values节点的配置加载为环境变量，类库可直接读取环境变量获取密钥：

public string GetMySecret()
{
    return Environment.GetEnvironmentVariable("YourSecretKey");
}

这种方式无需修改Function项目配置，只要local.settings.json的Values节点中存在对应密钥名即可。

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