使用XDocument加载XML文件时头部声明丢失该如何解决

问题原因 #

你遇到的XML头部声明丢失问题和LoadOptions配置无关，本质是输出阶段的配置问题：XDocument.Load加载XML时会正常读取头部声明并存储在XDocument.Declaration属性中，只是默认的输出逻辑（比如直接调用ToString()）不会带出该声明。

可行修复方案 #

1. 加载时补全声明（兼容原文件无声明的场景） #

加载完成后手动判断并补充XML声明：

using (MemoryStream stream = new MemoryStream(xmlFile.Content))
{
    using (System.Xml.XmlReader xmlReader = System.Xml.XmlReader.Create(stream))
    {
        var xmlDocument = XDocument.Load(xmlReader, LoadOptions.None);
        // 不存在声明时手动添加
        if (xmlDocument.Declaration == null)
        {
            xmlDocument.Declaration = new XDeclaration("1.0", "utf-8", null);
        }
    }
}

2. 输出时选择带声明的方式 #

不要直接调用XDocument.ToString()，该方法默认不输出XML头部声明，根据你的使用场景选择对应输出方式：

场景1：保存为本地文件

直接调用Save方法即可自动带出声明：

xmlDocument.Save("输出文件路径.xml");

场景2：转成字符串使用

如果需要得到带声明的XML字符串，使用StringWriter输出：

using (var writer = new StringWriter())
{
    xmlDocument.Save(writer);
    string 带声明的XML内容 = writer.ToString();
}

如果需要指定输出编码为UTF-8（默认StringWriter输出编码为UTF-16），可以自定义StringWriter实现：

// 自定义UTF8编码的StringWriter
public class Utf8StringWriter : StringWriter
{
    public override Encoding Encoding => Encoding.UTF8;
}

// 调用示例
using (var writer = new Utf8StringWriter())
{
    xmlDocument.Save(writer);
    string 编码为UTF8的带声明XML内容 = writer.ToString();
}

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