我的XDeclaration在哪裏？

Question

出於某種原因，下面的代碼生成的XML不包含聲明：

 XDocument xDocument = new XDocument(new XDeclaration("1.0", "utf-8", "yes"), 
      new XElement("project", 
       new XAttribute("number", project.ProjectNumber), 
       new XElement("store", 
        new XAttribute("number", project.StoreNumber) 
       ), 

       // User Element 
       new XElement("user", 
        new XAttribute("owner-id", project.OwnerID ?? 0), 
        new XElement("email", new XCData(project.OwnerEmail ?? "")), 
        new XElement("project-name", new XCData(project.ProjectName ?? "")) 
       ), 

       // Nested Project Element 
       new XElement("nested-project", 
        new XAttribute("version", new Version(1, 0)), 
        new XElement("project", 
         new XAttribute("version", new Version(1, 0)), 
         xProjectItems = new XElement("project-items") 
        ), 
        new XElement("price-per-part", project.PricePerPart), 
        new XElement("sheet-quantity", project.SheetQuantity), 
        new XElement("edge-length", project.EdgeLength), 
        new XElement("price", project.Price), 
        new XElement("status", project.Status), 
        xMaterialItems = new XElement("alternative-material-items"), 
        xProductItems = new XElement("project-product-items") 
       ) 
      ) 
     ); 

     String strXML = xDocument.ToString(); 

它之前生產的聲明。我錯過了明顯的東西嗎？

謝謝。

Answer 1

當您使用XDocument.Save methods之一的XDeclaration將可用。例如：

var doc = new XDocument (
      new XDeclaration ("1.0", "utf-8", "yes"), 
      new XElement ("test", "data") 
     ); 

string path = Path.Combine(Path.GetTempPath(), "temp.xml"); 
doc.Save(path); 
Console.WriteLine(File.ReadAllText(path)); 

或者你可以使用這種方法：

var sw = new StringWriter(); 
doc.Save(sw); 
string result = sw.GetStringBuilder().ToString(); 
Console.WriteLine(result); 

編輯：注意一些方法將在UTF-8指定轉換爲UTF-16。如果你想強制它是UTF-8，你將不得不使用這種不同的方法：

using (var mem = new MemoryStream()) 
using (var writer = new XmlTextWriter(mem, System.Text.Encoding.UTF8)) 
{ 
    writer.Formatting = Formatting.Indented; 
    doc.WriteTo(writer); 
    writer.Flush(); 
    mem.Flush(); 
    mem.Seek(0, SeekOrigin.Begin); 
    using (var reader = new StreamReader(mem)) 
    { 
     var xml = reader.ReadToEnd(); 
     Console.WriteLine(xml); 
    } 
} 

Answer 2

的documentation沒有明確指出xDocument.ToString()將輸出XML聲明，只說：「返回縮進XML爲這個節點。「。

在我的測試中，我發現下面的方法將輸出聲明：

使用ToString在Declaration屬性：

string strXML = string.Concat(xDocument.Declaration.ToString(), "\r\n", 
           xDocument.ToString()); 

或使用Save方法：

string strXml; 
using(var ms = new MemoryStream()) 
{ 
    xDocument.Save(ms); 
    ms.Position = 0; 
    using(var sr = new StreamReader(ms)) 
    { 
     strXml = sr.ReadToEnd(); 
    } 
} 

Answer 3

我的回答（靈感來自the answer by @rsbarro）：

string xml = xDocument.Declaration.ToString() + 
    xDocument.ToString(); 

- 或 -

string xml = xDocument.Declaration.ToString() + 
    xDocument.ToString(SaveOptions.DisableFormatting); 

至於爲什麼我相信使用+操作的是在這種情況下適當的，看到this answer的問題What's the best string concatenation method using C#?。