C#中XmlDocument加载XML后如何保留特殊字符的原有编码?
核心问题根因
- XML解析阶段的内置行为:按照W3C XML规范,XmlDocument在加载XML内容时,遇到
&、'这类实体引用,默认会自动解码为对应的实际字符(&、单引号),合并存储到相邻的文本节点中,不会单独保留实体引用的节点结构。 - 两个属性的设计逻辑:
InnerText的设计目标就是返回节点下解码后的纯文本内容,输出永远不会包含转义后的实体标记。InnerXml的序列化逻辑是按需做最小必要转义:只会对文本中不符合XML语法要求的<、&做强制转义,对于元素文本中合法的单引号',不会主动转义为',因此最终输出内容和加载时的原始实体编码状态存在差异。
- 注意:
PreserveWhitespace属性仅控制节点间空白的保留/折叠逻辑,完全不影响特殊字符的解码、转义流程,无法解决当前的编码保留问题。
可实现保留原始编码的方案
方案1:通过自定义XmlReader加载,保留独立实体引用节点
核心思路是修改XmlReader的解析规则,不自动展开实体引用,让每个实体引用作为独立的XmlEntityReference节点存在于DOM树中,序列化输出时会原样保留实体标记。
示例代码:
// 自定义XmlReader配置 var readerSettings = new XmlReaderSettings { ConformanceLevel = ConformanceLevel.Fragment, DtdProcessing = DtdProcessing.Prohibit, // 禁止不必要的DTD解析 IgnoreWhitespace = false }; XmlDocument doc = new XmlDocument(); doc.PreserveWhitespace = true; // 通过自定义reader加载XML内容 using (var reader = XmlReader.Create( new StringReader("<item> hello & pepe and maria's </item>"), readerSettings)) { doc.Load(reader); } // 此时输出的OuterXml会完全保留原始的实体编码状态 Console.WriteLine(doc.DocumentElement.OuterXml); // 输出结果:<item> hello & pepe and maria's </item>
这种方式下,<item>节点下的子节点不再是单一个文本节点,而是由普通文本段、独立的XmlEntityReference节点交替组成,序列化时不会对实体节点的内容做解码合并。
方案2:基于默认加载结果做定向转义替换
如果不需要保留DOM树中的实体节点结构,仅需要最终输出的字符串和原始编码完全一致,可以在默认加载完成拿到序列化结果后,做针对性的单引号转义。
示例代码:
XmlDocument doc = new XmlDocument(); doc.PreserveWhitespace = true; doc.LoadXml("<item> hello & pepe and maria's </item>"); // 先拿到序列化结果,此时序列化器已经自动将文本中的&转义为& string output = doc.InnerXml; // 将文本中未转义的单引号替换为',注意跳过已经存在的实体标记,避免重复转义 output = Regex.Replace(output, "(?<!')'", "'"); Console.WriteLine(output); // 输出结果:<item> hello & pepe and maria's </item>
常见避坑提示
- 不要尝试通过给
InnerText赋值来保留编码:InnerText的set操作会自动对赋值内容做全量转义,如果你赋值&,最终存储的内容会被转义为&amp;,序列化后出现双转义的错误。 - 不要混淆XML转义规则的适用场景:默认的序列化逻辑不对元素文本中的单引号做转义是符合XML规范的,并非bug,如果需要强制转义必须手动处理。
内容的提问来源于stack exchange,提问作者Mauricio Escobar
相关产品推荐
相关产品推荐

