Azure Functions隔离模式下自定义名称配置文件无法生效

环境信息 #

• Function App名称: microServiceBus.functions
• 使用工具: VS2022 - Version 17.4.4 & Version 17.7.4
• .Net运行时: 6
• Runtime: dotnet-isolated
• 语言: C#
• Core Tools Version: 4.0.5390 Commit hash: N/A (64-bit)
• Function Runtime Version: 4.25.3.21264

问题背景 #

我们有一个服务多客户的Function App，之前在v4进程内模式下，需要根据对接客户修改local.settings.json。迁移到v4隔离模式后，参照Web应用的做法为每个客户创建独立配置文件，但自定义名称的配置文件无法正常工作。

代码实现 #

var host = new HostBuilder()
    .ConfigureAppConfiguration((context, config) => {
        //config.AddJsonFile("local.settings.json", optional: true);
        config.AddJsonFile("local.settings.CUSTOMER.json", optional: true);
        
        config.AddEnvironmentVariables();
    })
.ConfigureLogging(logging => ...)
.ConfigureFunctionsWorkerDefaults()
.ConfigureServices((context, services) => ...)
.Build();

host.Run();

问题现象 #

如果不存在local.settings.json，进程无法启动，报错如下：

Azure Functions Core Tools
Core Tools Version:       4.0.5390 Commit hash: N/A  (64-bit)
Function Runtime Version: 4.25.3.21264

Can't determine project language from files. Please use one of [--csharp, --javascript, --typescript, --java, --python, --powershell, --custom]
Can't determine project language from files. Please use one of [--csharp, --javascript, --typescript, --java, --python, --powershell, --custom]
Can't determine project language from files. Please use one of [--csharp, --javascript, --typescript, --java, --python, --powershell, --custom]
[2023-10-06T10:30:41.620Z] Microsoft.Azure.WebJobs.Host: Error indexing method 'Functions.IncidentHandler_SendEmail'. Microsoft.Azure.WebJobs.Host:

另外，配置似乎在ConfigureAppConfiguration方法执行前就已被评估：在该方法中设置断点时，会先看到函数列表输出，才触发断点。

解决方案 #

1. 保留local.settings.json基础配置 #

Azure Functions Core Tools启动时会依赖这个文件识别项目类型、加载基础运行配置，不能直接删除。可以在文件中只保留最基础的配置项：

{
  "IsEncrypted": false,
  "Values": {
    "FUNCTIONS_WORKER_RUNTIME": "dotnet-isolated",
    "AzureWebJobsStorage": "UseDevelopmentStorage=true"
  }
}

2. 调整配置加载逻辑 #

在ConfigureAppConfiguration中先加载基础配置，再加载客户自定义配置，确保客户配置能覆盖基础值：

var host = new HostBuilder()
    .ConfigureAppConfiguration((context, config) => {
        // 加载基础配置，必须存在
        config.AddJsonFile("local.settings.json", optional: false, reloadOnChange: true);
        // 通过环境变量动态指定客户配置文件，不存在时忽略
        var customerName = Environment.GetEnvironmentVariable("CUSTOMER_NAME");
        if (!string.IsNullOrEmpty(customerName))
        {
            config.AddJsonFile($"local.settings.{customerName}.json", optional: true, reloadOnChange: true);
        }
        
        config.AddEnvironmentVariables();
    })
.ConfigureLogging(logging => ...)
.ConfigureFunctionsWorkerDefaults()
.ConfigureServices((context, services) => ...)
.Build();

host.Run();

3. 用环境变量切换客户配置 #

在VS项目的调试-环境变量中添加CUSTOMER_NAME变量，值设为对应客户标识（比如CustomerA），启动时就会自动加载local.settings.CustomerA.json。

4. 关于配置提前评估的说明 #

Functions Worker启动初期会先读取基础配置初始化运行环境，所以ConfigureAppConfiguration的断点在函数列表输出后触发是正常现象。如果需要确保配置在函数索引前生效，可将配置依赖的逻辑注入到服务中，或者直接在函数里通过IConfiguration读取最新加载的配置。

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