我应该将XML声明存储在数据库中并使用WebApi返回吗

Question

public async IActionResult Post([FromBody]XDocument xml)
{
   var entity = new MyDocument();
   entity.Xml = xml.ToString(); //?? 
   db.Documents.Add(entity);
   db.SaveChanges();
   return Created();
}

public async Task<IActionResult> Get(int id)
{
   var entity = db.Documents.Find(id);
   return Content(entity.Xml, "application/xml"); //missing xml declaration
}

var xml = XDocument.Load(@"<?xml version=""1.0"" encoding=""utf-8""?>
                           <Root><Child>Content</Child></Root>");
xml.ToString(); //<Root><Child>Content</Child></Root>

很容易包括它，但我认为这可能是有原因的。

当响应不包括XML声明时，Edge浏览器不显示XML：

public IActionResult Get()
{
    return Content("<Root><Child>Content</Child></Root>", "application/xml")
}

当响应包含xml声明，但声明中的编码与响应编码不匹配时，它也会以“无法切换编码”而失败：

public IActionResult Get()
{
    return Content(@"<?xml version=""1.0"" encoding=""utf-8""?>
                     <Root><Child>Content</Child></Root>", "application/xml");
}

public IActionResult Get()
{
    string xml = @"<?xml version=""1.0"" encoding=""utf-8""?>
                   <Root><Child>Content</Child></Root>")
    var xmlDoc = XDocument.Parse(xml);
    return Content(xml, "application/xml", Encoding.GetEncoding(xmlDoc.Declaration.Encoding));
}

Answer 1

我将这些规则确定为最佳实践：

>

不应将XML编码存储在数据库中

• 声明是可选的，但如果存在，则不能包括编码

null

很明显，您不想将编码存储在数据库中，因为数据库本身就威胁到XML列。但是，将XML声明存储在数据库中是有意义的，因为它可以包含其他信息（版本、独立）。

您的REST服务应该始终在响应中返回XML声明。如果它不存储在数据库中，您可以在运行时构造它。

public async IActionResult Post([FromBody]XDocument xml)
{
   var entity = new MyDocument();
   var declarationWithoutEncoding = new XDeclaration(xml.Declaration?.Version, null, xml.Declaration?.Standalone);
   entity.Xml = $@"{declarationWithoutEncoding}\n\r{xml.ToString()}"
   db.Documents.Add(entity);
   db.SaveChanges();
   return Created();
}

public async Task<IActionResult> Get(int id)
{
   var entity = db.Documents.Find(id);
   return Content(entity.Xml, "application/xml"); //in case XML Declaration is in database
}

或者

public async Task<IActionResult> Get(int id)
{
   var entity = db.Documents.Find(id);
   XDocument xmlDoc = XDocument.Parse(entity.xml);

   var declaration = new XDeclaration(xml.Declaration?.Version ?? "1.0", null, xml.Declaration?.Standalone ? "no");

   //you may change enccoding information to match response encoding, or just skip it
   //declaration.Encoding = ...

   string xml = $@"{declaration}\n\r{xml.ToString()}"

   return Content(xml, "application/xml"); 
}