比较 XmlDocument 的相等性（内容方面）

Question

如果我想比较一个XMlDocument的内容，是不是就这样？

XmlDocument doc1 = GetDoc1();
XmlDocument doc2 = GetDoc2();

if(doc1 == doc2)
{

}

我不检查它们是否都是相同的对象引用，而是检查 xml 的内容是否相同。

Answer 1

尝试DeepEquals 方法。

XDocument doc1 = GetDoc1(); 
XDocument doc2 = GetDoc2(); 
 
if(XNode.DeepEquals(doc1, doc2)) 
{ 
 
} 

---

另请参阅 LINQ to XML 树

Answer 2

不。 XmlDocument 不会覆盖 Equals() 方法 的行为，因此，它实际上只是执行引用相等 - 这在您的示例中将会失败，除非文档实际上是同一个对象实例。

如果您想比较文档的内容（属性、元素、注释、PI 等），您必须自己实现该逻辑。 请注意：这并不简单。

根据您的具体情况，您也许能够从文档中删除所有非必要的空格（这本身可能很棘手），然后它们会比较生成的 xml 文本。这并不完美 - 对于语义相同但在命名空间的使用和声明方式、某些值是否转义、元素顺序等方面有所不同的文档，它会失败。正如我之前所说，XML 比较并非微不足道。

您还需要清楚地定义两个 XML 文档“相同”的含义。元素或属性顺序重要吗？大小写（在文本节点中）重要吗？您应该忽略多余的 CDATA 部分吗？处理指令算不算？完全限定命名空间与部分限定命名空间怎么样？

在任何通用实现中，您可能希望将两个文档转换为某种规范形式（XML 或其他表示形式），然后比较规范化内容。

已经存在执行 XML 差异的工具，例如 Microsoft XML Diff/Patch，您可以利用它来识别两个文档之间的差异。据我所知，该工具不是以源代码形式分发的......因此，要在嵌入式应用程序中使用它，您需要编写该过程的脚本（如果您打算使用它，您应该首先验证许可条款是否允许它的使用和重新分发）。

编辑： 查看@Max Toro 的回答（如果您使用的是 .NET 3.5 SP1），显然 XLinq 中的一个选项可能会有所帮助。很高兴知道它的存在。

Answer 3

一种简单的方法是比较 OuterXml。

var a = new XmlDocument();
var b = new XmlDocument();

a.LoadXml("<root  foo='bar'  />");
b.LoadXml("<root foo='bar'/>");

Debug.Assert(a.OuterXml == b.OuterXml);

Answer 4

我知道这个问题有多老了，但我必须通过多个来源才能找到我正在寻找的答案。以下使用 XNode.DeepEquals 但也忽略属性顺序。在这个问题首次提出 13 年后，我需要做大量的工作才能得出这个答案，我想其他人可能会发现这个答案很有帮助。

使用 NUnit 作为我的测试套件，您可以传入 2 个 XmlDocuments 或一个 XmlDocument 和字符串。这会将 XmlDocuments 转换为 XDocuments，对每个节点的属性进行排序，然后执行 XNode.DeepEquals()。

Assert.That(XmlHelperService.XMLCompare(xmlDoc, expectedStr), Is.EqualTo(true));
Assert.That(XmlHelperService.XMLCompare(xmlDoc, expectedXmlDoc), Is.EqualTo(true));

代码

public class XmlHelperService
{
    public static bool XMLCompare(XmlDocument primary, string secondaryStr)
    {
        XmlDocument secondary = new XmlDocument();
        secondary.LoadXml(secondaryStr);

        return XMLCompare(primary, secondary);
    }

    public static bool XMLCompare(XmlDocument primary, XmlDocument secondary)
    {
        return XNode.DeepEquals(NormalizeXElement(primary.ToXDocument().Root), NormalizeXElement(secondary.ToXDocument().Root));
    }

    private static XElement NormalizeXElement(XElement element)
    {
        return new XElement(element.Name,
            element.Attributes().OrderBy(x => x.Name.ToString()),
            element.Nodes().Select(n =>
            {
                XElement e = n as XElement;
                if (e != null)
                    return NormalizeXElement(e);
                return n;
            })
        );
    }
}

public static class DocumentExtensions
{
    public static XDocument ToXDocument(this XmlDocument xmlDocument)
    {
        using (var nodeReader = new XmlNodeReader(xmlDocument))
        {
            nodeReader.MoveToContent();
            return XDocument.Load(nodeReader);
        }
    }
}

Answer 5

LBushkin 是对的，这不是小事。由于 XML 是字符串数据，从技术上讲，您可以对内容执行哈希并进行比较，但这会受到空格等因素的影响。

您可以在两个文档之间执行结构化差异（也称为“XML diffgram”）并比较结果。例如，这就是 .NET 数据集跟踪更改的方式。

除此之外，您必须遍历 DOM 并将元素、属性和值相互比较。如果涉及到模式，那么您还必须考虑职位等。

Answer 6

通常您想要比较以不同顺序排序的 XML 字符串。使用此代码可以轻松完成此操作

class Testing
{
    [Test]
    public void Test()
    {
        Assert.AreEqual(
            "<root><a></a><b></b></root>".SortXml()
            , "<root><b></b><a></a></root>".SortXml());
    }
}

public static class XmlCompareExtension
{
    public static string SortXml(this string @this)
    {
        var xdoc = XDocument.Parse(@this);

        SortXml(xdoc);

        return xdoc.ToString();
    }

    private static void SortXml(XContainer parent)
    {
        var elements = parent.Elements()
            .OrderBy(e => e.Name.LocalName)
            .ToArray();

        Array.ForEach(elements, e => e.Remove());

        foreach (var element in elements)
        {
            parent.Add(element);
            SortXml(element);
        }
    }
}