Cách đơn giản nhất để lấy XML được thụt lề có ngắt dòng từ XmlDocument là gì?

Khi tôi xây dựng XML từ đầu XmlDocument, thuộc OuterXmltính đã có mọi thứ được thụt lề độc đáo với các dấu ngắt dòng. Tuy nhiên, nếu tôi gọi LoadXmlmột số XML rất "nén" (không có ngắt dòng hoặc thụt lề) thì đầu ra của OuterXmlvẫn như vậy. Vì thế ...

Cách đơn giản nhất để nhận đầu ra XML đẹp từ một phiên bản của là XmlDocumentgì?

Dựa trên các câu trả lời khác, tôi đã xem xét XmlTextWritervà đưa ra phương pháp trợ giúp sau:

static public string Beautify(this XmlDocument doc)
{
    StringBuilder sb = new StringBuilder();
    XmlWriterSettings settings = new XmlWriterSettings
    {
        Indent = true,
        IndentChars = "  ",
        NewLineChars = "\r\n",
        NewLineHandling = NewLineHandling.Replace
    };
    using (XmlWriter writer = XmlWriter.Create(sb, settings)) {
        doc.Save(writer);
    }
    return sb.ToString();
}

Nó nhiều mã hơn một chút so với tôi mong đợi, nhưng nó hoạt động bình thường.

Như được phỏng theo blog của Erika Ehrli , điều này sẽ làm được:

XmlDocument doc = new XmlDocument();
doc.LoadXml("<item><name>wrench</name></item>");
// Save the document to a file and auto-indent the output.
using (XmlTextWriter writer = new XmlTextWriter("data.xml", null)) {
    writer.Formatting = Formatting.Indented;
    doc.Save(writer);
}

Hoặc thậm chí dễ dàng hơn nếu bạn có quyền truy cập vào Linq

try
{
    RequestPane.Text = System.Xml.Linq.XElement.Parse(RequestPane.Text).ToString();
}
catch (System.Xml.XmlException xex)
{
            displayException("Problem with formating text in Request Pane: ", xex);
}

Một phiên bản phương thức mở rộng ngắn hơn

public static string ToIndentedString( this XmlDocument doc )
{
    var stringWriter = new StringWriter(new StringBuilder());
    var xmlTextWriter = new XmlTextWriter(stringWriter) {Formatting = Formatting.Indented};
    doc.Save( xmlTextWriter );
    return stringWriter.ToString();
}

Nếu phương thức Beautify ở trên đang được gọi cho một phương thức XmlDocumentđã chứa một XmlProcessingInstructionnút con thì ngoại lệ sau sẽ được ném ra:

Không thể viết khai báo XML. Phương thức WriteStartDocument đã viết nó.

Đây là phiên bản đã sửa đổi của tôi so với phiên bản gốc để loại bỏ ngoại lệ:

private static string beautify(
    XmlDocument doc)
{
    var sb = new StringBuilder();
    var settings =
        new XmlWriterSettings
            {
                Indent = true,
                IndentChars = @"    ",
                NewLineChars = Environment.NewLine,
                NewLineHandling = NewLineHandling.Replace,
            };

    using (var writer = XmlWriter.Create(sb, settings))
    {
        if (doc.ChildNodes[0] is XmlProcessingInstruction)
        {
            doc.RemoveChild(doc.ChildNodes[0]);
        }

        doc.Save(writer);
        return sb.ToString();
    }
}

Nó hoạt động với tôi bây giờ, có lẽ bạn sẽ cần phải quét tất cả các nút con cho XmlProcessingInstructionnút, không chỉ nút đầu tiên?

Cập nhật tháng 4 năm 2015:

Vì tôi đã gặp một trường hợp mã hóa sai khác, tôi đã tìm kiếm cách thực thi UTF-8 mà không cần BOM. Tôi đã tìm thấy bài đăng trên blog này và tạo một chức năng dựa trên nó:

private static string beautify(string xml)
{
    var doc = new XmlDocument();
    doc.LoadXml(xml);

    var settings = new XmlWriterSettings
    {
        Indent = true,
        IndentChars = "\t",
        NewLineChars = Environment.NewLine,
        NewLineHandling = NewLineHandling.Replace,
        Encoding = new UTF8Encoding(false)
    };

    using (var ms = new MemoryStream())
    using (var writer = XmlWriter.Create(ms, settings))
    {
        doc.Save(writer);
        var xmlString = Encoding.UTF8.GetString(ms.ToArray());
        return xmlString;
    }
}

XmlTextWriter xw = new XmlTextWriter(writer);
xw.Formatting = Formatting.Indented;

    public static string FormatXml(string xml)
    {
        try
        {
            var doc = XDocument.Parse(xml);
            return doc.ToString();
        }
        catch (Exception)
        {
            return xml;
        }
    }

Một cách đơn giản là sử dụng:

writer.WriteRaw(space_char);

Giống như mã mẫu này, mã này là những gì tôi đã sử dụng để tạo cấu trúc dạng xem dạng cây bằng cách sử dụng XMLWriter:

private void generateXML(string filename)
        {
            using (XmlWriter writer = XmlWriter.Create(filename))
            {
                writer.WriteStartDocument();
                //new line
                writer.WriteRaw("\n");
                writer.WriteStartElement("treeitems");
                //new line
                writer.WriteRaw("\n");
                foreach (RootItem root in roots)
                {
                    //indent
                    writer.WriteRaw("\t");
                    writer.WriteStartElement("treeitem");
                    writer.WriteAttributeString("name", root.name);
                    writer.WriteAttributeString("uri", root.uri);
                    writer.WriteAttributeString("fontsize", root.fontsize);
                    writer.WriteAttributeString("icon", root.icon);
                    if (root.children.Count != 0)
                    {
                        foreach (ChildItem child in children)
                        {
                            //indent
                            writer.WriteRaw("\t");
                            writer.WriteStartElement("treeitem");
                            writer.WriteAttributeString("name", child.name);
                            writer.WriteAttributeString("uri", child.uri);
                            writer.WriteAttributeString("fontsize", child.fontsize);
                            writer.WriteAttributeString("icon", child.icon);
                            writer.WriteEndElement();
                            //new line
                            writer.WriteRaw("\n");
                        }
                    }
                    writer.WriteEndElement();
                    //new line
                    writer.WriteRaw("\n");
                }

                writer.WriteEndElement();
                writer.WriteEndDocument();

            }

        }

Bằng cách này, bạn có thể thêm tab hoặc ngắt dòng theo cách bạn thường làm, tức là \ t hoặc \ n

Khi thực hiện các đề xuất được đăng ở đây, tôi đã gặp sự cố với mã hóa văn bản. Có vẻ như XmlWriterSettingsmã hóa của luồng bị bỏ qua và luôn bị mã hóa của luồng ghi đè. Khi sử dụng mộtStringBuilder , đây luôn là mã hóa văn bản được sử dụng nội bộ trong C #, cụ thể là UTF-16.

Vì vậy, đây là một phiên bản cũng hỗ trợ các mã hóa khác.

LƯU Ý QUAN TRỌNG: Định dạng hoàn toàn bị bỏ qua nếu XMLDocumentđối tượng của bạn đã preserveWhitespacebật thuộc tính khi tải tài liệu. Điều này đã làm tôi bối rối trong một thời gian, vì vậy hãy đảm bảo không bật điều đó.

Mã cuối cùng của tôi:

public static void SaveFormattedXml(XmlDocument doc, String outputPath, Encoding encoding)
{
    XmlWriterSettings settings = new XmlWriterSettings();
    settings.Indent = true;
    settings.IndentChars = "\t";
    settings.NewLineChars = "\r\n";
    settings.NewLineHandling = NewLineHandling.Replace;

    using (MemoryStream memstream = new MemoryStream())
    using (StreamWriter sr = new StreamWriter(memstream, encoding))
    using (XmlWriter writer = XmlWriter.Create(sr, settings))
    using (FileStream fileWriter = new FileStream(outputPath, FileMode.Create))
    {
        if (doc.ChildNodes.Count > 0 && doc.ChildNodes[0] is XmlProcessingInstruction)
            doc.RemoveChild(doc.ChildNodes[0]);
        // save xml to XmlWriter made on encoding-specified text writer
        doc.Save(writer);
        // Flush the streams (not sure if this is really needed for pure mem operations)
        writer.Flush();
        // Write the underlying stream of the XmlWriter to file.
        fileWriter.Write(memstream.GetBuffer(), 0, (Int32)memstream.Length);
    }
}

Thao tác này sẽ lưu xml được định dạng vào đĩa, với mã hóa văn bản đã cho.

Nếu bạn có một chuỗi XML, thay vì một tài liệu đã sẵn sàng để sử dụng, bạn có thể thực hiện theo cách này:

var xmlString = "<xml>...</xml>"; // Your original XML string that needs indenting.
xmlString = this.PrettifyXml(xmlString);

private string PrettifyXml(string xmlString)
{
    var prettyXmlString = new StringBuilder();

    var xmlDoc = new XmlDocument();
    xmlDoc.LoadXml(xmlString);

    var xmlSettings = new XmlWriterSettings()
    {
        Indent = true,
        IndentChars = " ",
        NewLineChars = "\r\n",
        NewLineHandling = NewLineHandling.Replace
    };

    using (XmlWriter writer = XmlWriter.Create(prettyXmlString, xmlSettings))
    {
        xmlDoc.Save(writer);
    }

    return prettyXmlString.ToString();
}

Một cách tiếp cận đơn giản hơn dựa trên câu trả lời được chấp nhận:

static public string Beautify(this XmlDocument doc) {
    StringBuilder sb = new StringBuilder();
    XmlWriterSettings settings = new XmlWriterSettings
    {
        Indent = true
    };

    using (XmlWriter writer = XmlWriter.Create(sb, settings)) {
        doc.Save(writer);
    }

    return sb.ToString(); 
}

Đặt dòng mới là không cần thiết. Ký tự thụt lề cũng có hai khoảng trắng mặc định nên tôi không muốn đặt nó nữa.