为什么 XML 文档会显示“根级别的数据无效。第 1 行，第 1 个位置。”的错误信息？

Question

我在使用一个第三方DLL，它通过互联网传输XML文档。

为什么这个DLL会抛出以下异常？

 

根级别上的数据无效。第1行，第1个位置。(请参见下面的完整异常文本。)

以下是XML文档的前几行：

<?xml version="1.0" encoding="utf-8"?> <REQUEST>   <HEADER>
    <REQUESTID>8a5f6d56-d56d-4b7b-b7bf-afcf89cd970d</REQUESTID>
    <MESSAGETYPE>101</MESSAGETYPE>
    <MESSAGEVERSION>3.0.2</MESSAGEVERSION>

异常：

System.ApplicationException was caught
      Message=Unexpected exception.
      Source=FooSDK
      StackTrace:
           at FooSDK.RequestProcessor.Send(String SocketServerAddress, Int32 port)
           at Foo.ExecuteRequest(Int32 messageID, IPayload payload, Provider prov)
           at Foo.SendOrder(Int32 OrderNo)
      InnerException: System.Xml.XmlException
           LineNumber=1
           LinePosition=1
           Message=Data at the root level is invalid. Line 1, position 1.
           Source=System.Xml
           SourceUri=""
           StackTrace:
                at System.Xml.XmlTextReaderImpl.Throw(Exception e)
                at System.Xml.XmlTextReaderImpl.Throw(String res, String arg)
                at System.Xml.XmlTextReaderImpl.ParseRootLevelWhitespace()
                at System.Xml.XmlTextReaderImpl.ParseDocumentContent()
                at System.Xml.XmlTextReaderImpl.Read()
                at System.Xml.XmlLoader.Load(XmlDocument doc, XmlReader reader, Boolean preserveWhitespace)
                at System.Xml.XmlDocument.Load(XmlReader reader)
                at System.Xml.XmlDocument.LoadXml(String xml)
                at XYZ.RequestProcessor.GetObjectFromXML(String xmlResult)
                at XYZ.RequestProcessor.Send(String SocketServerAddress, Int32 port)
           InnerException:

- CJ7

---

XML文件是如何通过互联网传输的？使用HTTP协议吗？如果是，需要检查a)文件是否有BOM，b)HTTP头部是否指定了非UTF8字符集。 - Mr Lister

从堆栈跟踪来看，我认为这是问题所在： https://stackoverflow.com/a/1660695/2862 - undefined

Answer 1

最终我发现有一个字节标记异常，使用以下代码将其移除：

 string _byteOrderMarkUtf8 = Encoding.UTF8.GetString(Encoding.UTF8.GetPreamble());
    if (xml.StartsWith(_byteOrderMarkUtf8))
    {
        var lastIndexOfUtf8 = _byteOrderMarkUtf8.Length-1;
        xml = xml.Remove(0, lastIndexOfUtf8);
    }

- James Brankin

---

这是一个从零开始的字符数组 - 我必须使用 xml = xml.Remove(0, _byteOrderMarkUtf8.Length-1)。 - Roi Shabtai

第二个参数是要删除的字符数，从 startIndex 开始计算，因此应该这样写：xml = xml.Remove(0, _byteOrderMarkUtf8.Length);。参考 MSDN 文档。 - snark

为了使这段代码在Windows Server 2012和Windows 7上都能正常工作，我不得不使用 if (xml.StartsWith(_byteOrderMarkUtf8, StringComparison.Ordinal))。请访问https://dev59.com/w2Ik5IYBdhLWcg3wMLmI#19495964获取详细信息。 - snark

Answer 2

我可以给你两个建议:

1. 看起来你正在使用"LoadXml"而不是"Load"方法。在某些情况下，这会对我有所帮助。
2. 你有一个编码问题。你能检查一下XML文件的编码并将其写出来吗？

- E-Max

---

刚看到评论。是的，请尝试将文件编码设置为UTF8-WITHOUT-BOM。 - E-Max

Answer 3

将 <?xml version="1.0" encoding="utf-8"?> 之前的所有内容删除。

有时候，文本编辑器中可能会存在一些“隐形”的内容（并非所有文本编辑器都可见）。一些程序会添加这些内容。

这被称为 BOM，您可以在这里阅读更多信息：https://en.wikipedia.org/wiki/Byte_order_mark#Representations_of_byte_order_marks_by_encoding。

- Tadej

Answer 4

如果您使用XDocument.Load(url);从另一个域获取xml，主机可能会拒绝请求并返回意外的（非xml）结果，这将导致上述XmlException。

请参阅此处针对此情况的解决方案： XDocument.Load(feedUrl) 返回“根级别的数据无效。第1行，第1个位置。”

- Adam Hey

Answer 5

这个错误的主要原因是在将Stream或byte[]数组转换为.NET string时确定编码的逻辑。

使用第二个构造参数设置为true的StreamReader可以检测字节顺序标记并确定正确的编码，从而创建不会破坏XmlDocument.LoadXml方法的string。

public string GetXmlString(string url)
{
    using var stream = GetResponseStream(url);
    using var reader = new StreamReader(stream, true);
    return reader.ReadToEnd(); // no exception on `LoadXml`
}

常见的错误是在流或字节数组上盲目使用UTF8编码。下面的代码将产生一个在Visual Studio调试器中检查时看起来有效的字符串，或者复制到其他地方，但如果文件编码与UTF8不同且没有BOM，则在使用Load或LoadXml时会产生异常。

public string GetXmlString(string url)
{
    byte[] bytes = GetResponseByteArray(url);
    return System.Text.Encoding.UTF8.GetString(bytes); // potentially exception on `LoadXml`
}

因此，在您的第三方库的情况下，它们可能使用第二种方法将XML流解码为字符串，因此会出现异常。

- Nenad