如何反序列化含嵌套HTML标签的XML文档并解决属性获取问题

看起来你在XML反序列化时遇到了两个典型问题：属性映射失效和HTML标签嵌套解析异常，我来一步步帮你解决。

一、先搞定block.Name为null的问题 #

这个问题90%都是实体类和XML结构不匹配导致的，你可以按以下步骤排查：

1. 检查属性映射的注解是否正确 #

XML反序列化默认是严格匹配元素/属性名称的，如果你没有显式指定映射关系，很容易因为大小写、名称不一致导致属性为null。比如：

• XML中的block元素是 <block name="MyBlock">
• 你的Block类必须用[XmlAttribute]指定对应XML的属性名：

public class Block
{
    // 关键：用XmlAttribute绑定XML中的name属性
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    // 其他属性...
}

2. 确认实体类的层级结构和XML完全对应 #

如果XML是system -> subsystem -> block的嵌套结构，你的实体类也必须保持一致的层级：

// 根节点类（对应XML的根元素，比如<root>）
[XmlRoot("root")]
public class XmlRootModel
{
    [XmlElement("system")]
    public List<SystemModel> Systems { get; set; }
}

public class SystemModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    [XmlElement("subsystem")]
    public List<SubsystemModel> Subsystems { get; set; }
}

public class SubsystemModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    [XmlElement("block")]
    public List<BlockModel> Blocks { get; set; }
}

public class BlockModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    // 处理HTML嵌套的属性
    [XmlElement("description")]
    public string Description { get; set; }
}

3. 排查命名空间问题 #

如果你的XML带有命名空间（比如<root xmlns="http://example.com">），必须在反序列化时指定命名空间，或者在类注解中添加：

[XmlRoot("root", Namespace = "http://example.com")]
public class XmlRootModel { ... }

4. 快速调试技巧 #

反序列化时捕获SerializationException，里面会明确告诉你哪里不匹配；或者用XmlSerializer.CanDeserialize()方法提前验证XML和类的兼容性。

二、处理XML中的HTML标签嵌套 #

XML中直接嵌套HTML标签会被当作XML元素解析，要么导致反序列化失败，要么丢失HTML结构，解决方式有两种：

1. 用CDATA包裹HTML内容 #

这是最推荐的方式，在XML中把HTML放在<![CDATA[...]]>里，这样反序列化时会把整个内容当作纯文本读取：

<block name="MyBlock">
    <description><![CDATA[<h3>Block Info</h3><p>This is <b>important</b> content</p>]]></description>
</block>

此时你的Description属性会完整拿到包含HTML标签的字符串，不会被解析成XML元素。

2. 调整XmlReader设置强制读取纯文本 #

如果无法修改XML源，你可以通过配置XmlReaderSettings来忽略HTML标签的XML解析：

var settings = new XmlReaderSettings
{
    ConformanceLevel = ConformanceLevel.Auto,
    IgnoreComments = true,
    IgnoreProcessingInstructions = true
};

using (var reader = XmlReader.Create(new StringReader(xmlContent), settings))
{
    var serializer = new XmlSerializer(typeof(XmlRootModel));
    var model = (XmlRootModel)serializer.Deserialize(reader);
    // 此时model中Block的Description会包含完整HTML标签
}

完整示例代码 #

// 实体类定义
[XmlRoot("root")]
public class XmlRootModel
{
    [XmlElement("system")]
    public List<SystemModel> Systems { get; set; }
}

public class SystemModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    [XmlElement("subsystem")]
    public List<SubsystemModel> Subsystems { get; set; }
}

public class SubsystemModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    [XmlElement("block")]
    public List<BlockModel> Blocks { get; set; }
}

public class BlockModel
{
    [XmlAttribute("name")]
    public string Name { get; set; }
    
    [XmlElement("description")]
    public string Description { get; set; }
}

// 反序列化代码
var xml = @"<root>
<system name=""SystemA"">
    <subsystem name=""SubsystemA"">
        <block name=""Block1"">
            <description><![CDATA[<b>Block 1</b> has <i>HTML content</i>]]></description>
        </block>
    </subsystem>
</system>
</root>";

var serializer = new XmlSerializer(typeof(XmlRootModel));
using (var reader = new StringReader(xml))
{
    var root = (XmlRootModel)serializer.Deserialize(reader);
    var blockName = root.Systems[0].Subsystems[0].Blocks[0].Name; // 输出"Block1"
    var htmlContent = root.Systems[0].Subsystems[0].Blocks[0].Description; // 输出带HTML标签的字符串
}

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