IConfigurationRoot.GetRequiredSection()无法找到XML配置节问题求助

问题原因 #

你的问题源于两处关键错误：

1. 配置节路径错误：从GetDebugView()的输出可见，serial1并非根配置节点的直接子节点，它嵌套在section节点下。直接用"serial1"作为路径自然找不到对应配置节。
2. XML结构与配置绑定不兼容：当前XML中key节点用name属性指定配置项名称、节点文本存值的结构，无法直接映射到SerialPortSettings类的属性，即便找到配置节，后续的Get<SerialPortSettings>()也会绑定失败。

解决方案 #

1. 修正配置节获取路径

将获取配置节的代码改为以下任意一种写法：

// 方式1：使用冒号分隔完整路径
SerialPortSettings? portSettings = configRoot.GetRequiredSection("section:serial1").Get<SerialPortSettings>();

// 方式2：先定位父节点再获取子节点
SerialPortSettings? portSettings = configRoot.GetSection("section").GetRequiredSection("serial1").Get<SerialPortSettings>();

2. 调整XML结构适配绑定

当前XML不符合Microsoft.Extensions.Configuration的默认XML解析规则，需修改为以下两种结构之一：

结构一：直接用配置项名称作为节点

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <section>
        <serial1>
            <PortName>COM1</PortName>
            <Parity>Odd</Parity>
            <DataBits>8</DataBits>
            <StopBits>One</StopBits>
            <BaudRate>9600</BaudRate>
        </serial1>
        <serial2>
            <PortName>COM2</PortName>
            <BaudRate>4800</BaudRate>
            <DataBits>8</DataBits>
            <Parity>Odd</Parity>
            <StopBits>One</StopBits>
        </serial2>
    </section>
</configuration>

结构二：保留section的name属性，调整配置项结构

若想保留原section name的形式，可将配置项值直接作为节点内容，去掉冗余的key节点：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <section name="serial1">
        <PortName>COM1</PortName>
        <Parity>Odd</Parity>
        <DataBits>8</DataBits>
        <StopBits>One</StopBits>
        <BaudRate>9600</BaudRate>
    </section>
    <section name="serial2">
        <PortName>COM2</PortName>
        <BaudRate>4800</BaudRate>
        <DataBits>8</DataBits>
        <Parity>Odd</Parity>
        <StopBits>One</StopBits>
    </section>
</configuration>

注：这种结构下，若要通过name属性定位section，需自定义XML配置提供器或遍历section节点下的子项筛选匹配的name属性。

3. 验证绑定结果

修改完成后，可添加以下代码确认绑定是否成功：

if (portSettings != null)
{
    Console.WriteLine($"PortName: {portSettings.PortName}");
    Console.WriteLine($"BaudRate: {portSettings.BaudRate}");
    Console.WriteLine($"Parity: {portSettings.Parity}");
}

额外说明 #

Microsoft.Extensions.Configuration的默认XML解析规则：

• XML元素名称对应配置节点的键
• XML元素的文本内容对应节点的值
• XML属性会被解析为对应节点的子节点，键为属性名，值为属性值

原XML中<key name="PortName">value COM1</key>会被解析为key节点下的PortName子节点，值为value COM1，这显然无法直接映射到类的PortName属性。

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