Xóa không gian tên trong XML từ ASP.NET Web API

Question

Làm cách nào để xóa không gian tên khỏi phản hồi xml dưới đây bằng API Web?

<ApiDivisionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GrassrootsHoops.Models.Api.Response"> 
<Divisions xmlns:d2p1="http://schemas.datacontract.org/2004/07/GrassrootsHoops.Data.Entities"> 
<d2p1:Page>1</d2p1:Page> 
<d2p1:PageSize>10</d2p1:PageSize> 
<d2p1:Results xmlns:d3p1="http://schemas.datacontract.org/2004/07/GrassrootsHoops.Models.Api.Response.Divisions"/> 
<d2p1:Total>0</d2p1:Total> 
</Divisions> 
</ApiDivisionsResponse> 

Answer 1

Lựa chọn 1 là để chuyển sang sử dụng XmlSerializer trong GlobalConfiguration:

config.Formatters.XmlFormatter.UseXmlSerializer = true; 

Lựa chọn 2 là để trang trí mô hình của bạn với

[DataContract(Namespace="")] 

(và nếu bạn làm như vậy, bạn muốn cần phải trang trí các thành viên với các thuộc tính [DataMember]).

Answer 2

Nếu bạn sẵn sàng trang trí cho mô hình của mình bằng XmlRoot, đây là cách hay để thực hiện. Giả sử bạn có một chiếc xe có cửa ra vào. Cấu hình WebAPI mặc định sẽ trở lại một cái gì đó như:

<car 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 
    <doors> 
     <door> 
      <color>black</color> 
     </door> 
    </doors> 
</car> 

Đây là những gì bạn muốn:

<car> 
    <doors> 
     <door> 
      <color>black</color> 
     </door> 
    </doors> 
</car> 

Dưới đây là mô hình:

[XmlRoot("car")] 
public class Car 
{ 
    [XmlArray("doors"), XmlArrayItem("door")] 
    public Door[] Doors { get; set; } 
} 

Những gì bạn phải làm là tạo ra một XmlFormatter tùy chỉnh sẽ có một không gian tên trống nếu không có không gian tên được định nghĩa trong thuộc tính XmlRoot. Vì một số lý do, trình định dạng mặc định luôn thêm hai không gian tên mặc định.

public class CustomNamespaceXmlFormatter : XmlMediaTypeFormatter 
{ 
    public override Task WriteToStreamAsync(Type type, object value, Stream writeStream, HttpContent content, 
              TransportContext transportContext) 
    { 
     try 
     { 
      var xns = new XmlSerializerNamespaces(); 
      foreach (var attribute in type.GetCustomAttributes(true)) 
      { 
       var xmlRootAttribute = attribute as XmlRootAttribute; 
       if (xmlRootAttribute != null) 
       { 
        xns.Add(string.Empty, xmlRootAttribute.Namespace); 
       } 
      } 

      if (xns.Count == 0) 
      { 
       xns.Add(string.Empty, string.Empty); 
      } 

      var task = Task.Factory.StartNew(() => 
       { 
        var serializer = new XmlSerializer(type); 
        serializer.Serialize(writeStream, value, xns); 
       }); 

      return task; 
     } 
     catch (Exception) 
     { 
      return base.WriteToStreamAsync(type, value, writeStream, content, transportContext); 
     } 
    } 
} 

Điều cuối cùng cần làm là thêm trình định dạng mới trong WebApiContext. Hãy chắc chắn xóa (hoặc xóa) XmlMediaTypeFormatter cũ

public static class WebApiContext 
{ 
    public static void Register(HttpConfiguration config) 
    { 
     ... 
     config.Formatters.Clear(); 
     config.Formatters.Add(new CustomNamespaceXmlFormatter{UseXmlSerializer=true}); 
     ... 
    } 
} 

Answer 3

Tôi thích câu trả lời của pobed2. Nhưng tôi cần CustomNamespaceXmlFormatter để cho phép tôi chỉ định không gian tên gốc mặc định sẽ được sử dụng khi thuộc tính XmlRoot bị thiếu và cũng khi nó hiện diện và không có giá trị trong thuộc tính Namespace (nghĩa là thuộc tính được sử dụng để đặt chỉ tên phần tử gốc). Vì vậy, tôi đã tạo ra một phiên bản cải tiến, ở đây nó được trong trường hợp nó rất hữu ích cho ai đó:

public class CustomNamespaceXmlFormatter : XmlMediaTypeFormatter 
{ 
    private readonly string defaultRootNamespace; 

    public CustomNamespaceXmlFormatter() : this(string.Empty) 
    { 
    } 

    public CustomNamespaceXmlFormatter(string defaultRootNamespace) 
    { 
     this.defaultRootNamespace = defaultRootNamespace; 
    } 

    public override Task WriteToStreamAsync(
     Type type, 
     object value, 
     Stream writeStream, 
     HttpContent content, 
     TransportContext transportContext) 
    { 
     var xmlRootAttribute = type.GetCustomAttribute<XmlRootAttribute>(true); 
     if(xmlRootAttribute == null) 
      xmlRootAttribute = new XmlRootAttribute(type.Name) 
      { 
       Namespace = defaultRootNamespace 
      }; 
     else if(xmlRootAttribute.Namespace == null) 
      xmlRootAttribute = new XmlRootAttribute(xmlRootAttribute.ElementName) 
      { 
       Namespace = defaultRootNamespace 
      }; 

     var xns = new XmlSerializerNamespaces(); 
     xns.Add(string.Empty, xmlRootAttribute.Namespace); 

     return Task.Factory.StartNew(() => 
     { 
      var serializer = new XmlSerializer(type, xmlRootAttribute); 
      serializer.Serialize(writeStream, value, xns); 
     }); 
    } 
} 

Answer 4

Trong dự án mà giữ mô hình phản ứng đi đến Properties/AssemblyInfo.cs

Thêm

using System.Runtime.Serialization;

và tại phần dưới cùng thêm

[assembly: ContractNamespace("", ClrNamespace = "Project.YourResponseModels")] 

Thay thế Project.YourResponseModels bằng không gian tên thực tế nơi mô hình phản hồi được đặt. Bạn cần phải thêm một mỗi namespace

Answer 5

này hoạt động hoàn hảo

public ActionResult JsonAction(string xxx) 
{ 
    XmlDocument xmlDoc2 = new XmlDocument(); 
    xmlDoc2.Load(xmlStreamReader); 

    XDocument d = XDocument.Parse(optdoc2.InnerXml); 
    d.Root.Attributes().Where(x => x.IsNamespaceDeclaration).Remove(); 

    foreach (var elem in d.Descendants()) 
    elem.Name = elem.Name.LocalName; 

    var xmlDocument = new XmlDocument(); 
    xmlDocument.Load(d.CreateReader()); 

    var jsonText = JsonConvert.SerializeXmlNode(xmlDocument); 
    return Content(jsonText); 
}