C#中JSON配置绑定HttpApiClientOptions及Body嵌套读取问题

问题原因 #

.NET Configuration系统默认的绑定逻辑对**复杂嵌套JSON结构（如包含对象的数组）**支持有限，当Body定义为Dictionary<string, object>时，无法正确解析嵌套的数组和内部对象，导致messages这类节点内容丢失。

可行解决方案 #

方案1：使用JsonNode（.NET 6+ 原生支持） #

将Body的类型改为JsonNode?，它可以完整保留任意层级的JSON结构，包括数组、嵌套对象等。

1. 修改HttpApiClientOptions类：

public class HttpApiClientOptions : BaseApiClientOptions
{
    public string Url { get; set; }
    public Dictionary<string, string>? Headers { get; set; }
    public Dictionary<string, string>? Params { get; set; }
    public JsonNode? Body { get; set; }
}

2. 调整绑定逻辑，直接读取并反序列化body节点：

var config = new ConfigurationBuilder()
    .AddJsonFile(configFilePath, false, false)
    .Build();

// 获取body节点的原始JSON字符串并解析为JsonNode
var bodySection = config.GetSection("apiClientOptions").GetSection(apiClientName).GetSection("body");
var bodyJson = bodySection.Value;
apiClientOptions.Body = JsonNode.Parse(bodyJson);

// 绑定其他基础属性
config.GetSection("apiClientOptions").GetSection(apiClientName)
    .Bind(apiClientOptions, options => options.BindNonPublicProperties = false);

方案2：使用Newtonsoft.Json的JObject #

借助Newtonsoft.Json对复杂JSON的良好支持，需要先安装对应NuGet包：Microsoft.Extensions.Configuration.NewtonsoftJson和Newtonsoft.Json。

1. 修改HttpApiClientOptions类：

using Newtonsoft.Json.Linq;

public class HttpApiClientOptions : BaseApiClientOptions
{
    public string Url { get; set; }
    public Dictionary<string, string>? Headers { get; set; }
    public Dictionary<string, string>? Params { get; set; }
    public JObject? Body { get; set; }
}

2. 使用Newtonsoft的配置绑定逻辑：

var config = new ConfigurationBuilder()
    .AddJsonFile(configFilePath, false, false)
    .AddNewtonsoftJson() // 启用Newtonsoft配置支持
    .Build();

config.GetSection("apiClientOptions").GetSection(apiClientName)
    .Bind(apiClientOptions, binder => binder.BindNonPublicProperties = true);

方案3：直接读取原始JSON文件（最灵活） #

绕开Configuration系统的绑定限制，直接读取并解析JSON文件，完全保留所有嵌套结构：

// 读取完整配置文件内容
var jsonContent = File.ReadAllText(configFilePath);
var rootNode = JsonNode.Parse(jsonContent);

// 定位到目标客户端配置节点
var clientNode = rootNode["apiClientOptions"]?[apiClientName];
if (clientNode == null) return;

// 绑定基础属性
apiClientOptions.Url = clientNode["url"].GetValue<string>();
apiClientOptions.Headers = clientNode["headers"].Deserialize<Dictionary<string, string>>();
apiClientOptions.Params = clientNode["params"].Deserialize<Dictionary<string, string>>();

// 直接保留Body的完整JSON结构
apiClientOptions.Body = clientNode["body"];

注意事项 #

• 方案1仅适用于.NET 6及以上版本；
• 方案2需要引入第三方库，但兼容性更好；
• 方案3无需依赖额外组件，适合不确定JSON嵌套深度的场景。

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