W jaki sposób można sterować serializacją .NET DataContract, aby używał atrybutów XML zamiast elementów?

Question

Jeśli mam klasa oznaczona jako DataContract i kilka obiektów na nim zaznaczone DataMember atrybutów mogę szeregować go do XML łatwo, ale byłoby stworzyć wyjście jak:

<Person> 
    <Name>John Smith</Name> 
    <Email>john.smith@acme.com</Email> 
    <Phone>123-123-1234</Phone> 
</Person> 

Co wolałbym to atrybuty jak ...

<Person Name="John Smith" Email="john.smith@acme.com" Phone="123-123-1234" /> 

Atrybut DataMember pozwala mi kontrolować Imię i zamówienie, ale nie tego, czy jest szeregowane jako elementu lub atrybutu. Rozejrzałem się i znalazłem DataContractFormat i IXmlSerializable, ale mam nadzieję, że istnieje łatwiejsze rozwiązanie.

Jaki jest najprostszy sposób to zrobić?

Answer 1

Nie można tego zrobić z DataContractSerializer; jeśli chcesz mieć atrybuty, musisz użyć wartości XmlSerializer. Dzięki klasie DataContractSerializer dozwolony jest bardziej restrykcyjny podzbiór specyfikacji XML, co poprawia wydajność i poprawia współdziałanie opublikowanych usług, ale daje mniejszą kontrolę nad formatem XML.

Jeśli korzystasz z usług WCF, spójrz na XmlSerializerFormatAttribute, który umożliwia korzystanie z XmlSerializer do serializacji.

Answer 2

Można to zrobić z DataContractSerializer - odpowiedź jest przejąć serializacji Xml siebie poprzez wdrożenie IXmlSerializable interfejs . Dla zapisu tylko wsparcie - można zostawić realizację z ReadXml pusty, a zwróci null dla GetSchema, a następnie napisać realizację WriteXml następująco:

public class MyPerson : IXmlSerializable 
{ 
    public string Name { get; set;} 
    public string Email { get; set;} 
    public string Phone { get; set;} 

    public XmlSchema GetSchema() { return null; } 
    public void ReadXml(XmlReader reader) { } 
    public void WriteXml(XmlWriter writer) 
    { 
    writer.WriteAttributeString("name", Name); 
    writer.WriteAttributeString("email", Email); 
    writer.WriteAttributeString("phone", Phone); 
    } 
} 

Jeśli używasz to samo typ, na przykład serializacja JSON, możesz nadal dodawać atrybuty DataContract i DataMember - DataContractSerializer będzie wykorzystywał implementację interfejsu IXmlSerializable tylko podczas pisania Xml.

Zapisałem na blogu o tym here.

Answer 3

Można dokonać konwersji między atrybutami i elementami podczas serializacji/deserializacji. Następujące prace dla tego ostatniego.

private XmlReader AttributesToElements(Stream stream) 
    { 
      var root = XElement.Load(stream); 
      foreach (var element in root.Descendants()) { 
        foreach (var attribute in element.Attributes()) 
          element.Add(new XElement(root.Name.Namespace + attribute.Name.LocalName, (string)attribute)); 
        element.Attributes().Remove(); 
      } 
      return root.CreateReader(); 
    }