Azure Function v6读取local.settings.json嵌套配置值为null的问题

在Azure Function(v6)中读取local.settings.json的嵌套配置值时，Url、Method、NotificationRecipients等值始终返回null，以下是相关代码片段及问题分析：

local.settings.json #

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "EndpointDetails": {
      "GetAllTaskDetails": {
        "Url": "https://localhost:7000/api/Task/GetAllTaskDetails",
        "Method": "GET",
        "NotificationRecipients": "user1@domain.com"
      },
      "GetTaskDetails": {
        "Url": "https://localhost:7000/api/Task/GetTaskDetails",
        "Method": "GET",
        "NotificationRecipients": "user2@domain.com"
      }
    }
  }
}

Startup.cs #

using Microsoft.Azure.Functions.Extensions.DependencyInjection;
using Microsoft.Extensions.DependencyInjection;

[assembly: FunctionsStartup(typeof(HealthChecker.Startup))]
namespace HealthChecker
{
    public class Startup : FunctionsStartup
    {
        public override void Configure(IFunctionsHostBuilder builder)
        {
            var configuration = builder.GetContext().Configuration;
            builder.Services.AddHealthChecks();
            HealthCheckDefinitions.ConfigureHealthChecks(builder.Services.AddHealthChecks(), configuration);
        }
    }
}

HealthCheckDefinitions.cs #

public static class HealthCheckDefinitions
{
 private static Dictionary<string, List<string>> endpointDetails = new Dictionary<string, List<string>>();

 public static void ConfigureHealthChecks(IHealthChecksBuilder builder, IConfiguration configuration){
     private static IConfigurationSection endpointDetailsListConfig;
     private static string getAllTaskDetails;
     private static string getTaskDetails;
     List<string> endpoints = new List<string>();

     InitializeConfigValues(configuration);

     endpoints.AddRange(new List<string>
            {
                 getAllTaskDetails,
                 getTaskDetails
            });

     foreach (var endpoint in endpoints)
            {
                var endpointDetailsConfig 
                  = endpointDetailsListConfig.GetSection(endpoint);
                GetEndpointDetails(endpointDetailsConfig, endpoint);
               
                foreach (var endpointDetail in endpointDetails)
                {
                  builder.AddCheck(endpointDetail.Key, () =>
                  {
                    // 健康检查逻辑代码
                    // .....
                  });
                }
            }
   }
 
 private static void InitializeConfigValues(IConfiguration configuration)
    {
        endpointDetailsListConfig = configuration.GetSection("EndpointDetails");
        getAllTaskDetails = endpointDetailsListConfig.GetSection("GetAllTaskDetails").Key;
        getTaskDetails = endpointDetailsListConfig.GetSection("GetTaskDetails").Key;
    }

   private static void GetEndpointDetails(IConfigurationSection endpointDetailsConfig, string endpoint)
    {
        if (!string.IsNullOrEmpty(endpointDetailsConfig["Url"]) && !string.IsNullOrEmpty(endpointDetailsConfig["Method"])
            && !string.IsNullOrEmpty(endpointDetailsConfig["NotificationRecipients"]))
            {
                endpointDetails.Add(endpoint, new List<string>
                {
                    endpointDetailsConfig["Url"],
                    endpointDetailsConfig["Method"],
                    endpointDetailsConfig["NotificationRecipients"]
                });
            }
    }
}

问题点 #

以下值始终返回null：

endpointDetailsConfig["Url"],
endpointDetailsConfig["Method"],
endpointDetailsConfig["NotificationRecipients"]

错误原因分析 #

1. local.settings.json格式不兼容
   Azure Functions的配置系统要求Values节点下的配置必须是字符串键值对，不支持直接嵌套JSON对象。你当前的EndpointDetails是嵌套对象，无法被配置系统正确解析，导致后续读取不到对应值。

2. 代码语法与逻辑错误

• ConfigureHealthChecks方法内部定义了private static变量，这是非法的C#语法，编译会报错，变量无法正确初始化。
• InitializeConfigValues中通过GetSection("GetAllTaskDetails").Key获取节点名称，虽然能得到"GetAllTaskDetails"，但由于配置本身未被正确解析，后续通过该名称获取子节点时，对应的Url等值仍为空。

解决方案 #

方案1：扁平化配置键名 #

修改local.settings.json，将嵌套结构转为扁平化的键名（用冒号:分隔层级），这是Azure Functions推荐的配置方式：

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "UseDevelopmentStorage=true",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "EndpointDetails:GetAllTaskDetails:Url": "https://localhost:7000/api/Task/GetAllTaskDetails",
    "EndpointDetails:GetAllTaskDetails:Method": "GET",
    "EndpointDetails:GetAllTaskDetails:NotificationRecipients": "user1@domain.com",
    "EndpointDetails:GetTaskDetails:Url": "https://localhost:7000/api/Task/GetTaskDetails",
    "EndpointDetails:GetTaskDetails:Method": "GET",
    "EndpointDetails:GetTaskDetails:NotificationRecipients": "user2@domain.com"
  }
}

方案2：使用配置绑定到实体类 #

定义对应配置结构的实体类，通过IConfiguration.Bind方法直接绑定配置，更简洁易维护：

1. 定义实体类：

public class EndpointSettings
{
    public Dictionary<string, EndpointConfig> EndpointDetails { get; set; }
}

public class EndpointConfig
{
    public string Url { get; set; }
    public string Method { get; set; }
    public string NotificationRecipients { get; set; }
}

2. 在Startup中绑定配置：

public override void Configure(IFunctionsHostBuilder builder)
{
    var configuration = builder.GetContext().Configuration;
    var endpointSettings = new EndpointSettings();
    configuration.Bind(endpointSettings);
    
    builder.Services.AddHealthChecks();
    HealthCheckDefinitions.ConfigureHealthChecks(builder.Services.AddHealthChecks(), endpointSettings);
}

3. 修改HealthCheckDefinitions，直接使用绑定后的实体类：

public static void ConfigureHealthChecks(IHealthChecksBuilder builder, EndpointSettings endpointSettings)
{
    foreach (var kvp in endpointSettings.EndpointDetails)
    {
        var endpointName = kvp.Key;
        var config = kvp.Value;
        
        if (!string.IsNullOrEmpty(config.Url) && !string.IsNullOrEmpty(config.Method) && !string.IsNullOrEmpty(config.NotificationRecipients))
        {
            builder.AddCheck(endpointName, () =>
            {
                // 健康检查逻辑
                return Task.FromResult(HealthCheckResult.Healthy());
            });
        }
    }
}

修正代码语法错误 #

无论采用哪种方案，都需要移除ConfigureHealthChecks方法内部的private static变量定义，改为局部变量或类级别变量：

public static void ConfigureHealthChecks(IHealthChecksBuilder builder, IConfiguration configuration)
{
    IConfigurationSection endpointDetailsListConfig;
    string getAllTaskDetails;
    string getTaskDetails;
    List<string> endpoints = new List<string>();

    InitializeConfigValues(configuration, out endpointDetailsListConfig, out getAllTaskDetails, out getTaskDetails);
    // 后续逻辑...
}

private static void InitializeConfigValues(IConfiguration configuration, out IConfigurationSection endpointDetailsListConfig, out string getAllTaskDetails, out string getTaskDetails)
{
    endpointDetailsListConfig = configuration.GetSection("EndpointDetails");
    getAllTaskDetails = "GetAllTaskDetails"; // 直接使用字符串，无需通过GetSection取Key
    getTaskDetails = "GetTaskDetails";
}

内容的提问来源于stack exchange，提问作者The Inquisitive Coder