从类序列化XML文档的最佳实践

Question

我目前的解决方案工作正常。 我有一个C＃类Person ，正在使用XmlSerializer对象将其序列化为XML文档。 我知道以下类结构将被序列化为XML文档（也在下面）。

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
    [XmlAttribute("recordId")]
    public int recordId { get; set; }
}

...将被序列化为以下XML：

<?xml version="1.0" encoding="utf-8"?>
<Person recordId="1">
  <FirstName>John</FirstName>
  <LastName>Doe</LastName>
  <Age>32</Age>
</Person>

假设每个属性具有相同的属性，我应该像使用XmlAttribute ，显式地为每个元素加上XmlElement标签作为前缀; 还是离开上面定义的Person类完全可以接受？

这样做或不这样做的含义是什么？

[XmlRoot("Person")]
public class Person
{
    [XmlElement("FirstName")]
    public string FirstName { get; set; }
    [XmlElement("LastName")]
    public string LastName { get; set; }
    [XmlElement("Age")]
    public int Age { get; set; }
    [XmlAttribute("recordId")]
    public int recordId { get; set; }
}

Answer 1

默认情况下， XmlSerializer使用属性名称作为XML元素名称，并且有99％的时间使用该名称。 在极端情况下，需要将自定义元素名称映射到属性名称（例如，您正在从XML创建代码模型，而XML元素以无效字符开头）。

对我来说，显式装饰它们只是代码膨胀。 如果默认名称正确，则让XmlSerializer使用名称执行其默认操作。 在极少数情况下（令人反感），显式修饰名称可以让您更改基础属性名称而不会破坏序列化，但是如果必须这样做，则可以在那时添加属性。

因此，就其价值而言，只要结果合适，我就将其保留，仅添加它们以表示该特定属性有所不同。 例如，您提供了代码：

public class Person
{
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public int Age { get; set; }
    [XmlAttribute("recordId")]
    public int recordId { get; set; }
}

这立即引起了recordId与众不同的注意。 如果您在所有项目上都明确设置了属性，那么不太需要对其进行序列化。

Answer 2

XmlRoot属性将允许您控制元素的名称，而无需更改类的名称。

如果类名与XML元素名相同，则无需包含它。

Answer 3

基本上，如何处理都没有关系。 但是，就我而言，当我拥有显式XML序列化协定时，它看起来更具可读性-一种无需属性即可进行序列化的适当类型。 但是，有时XML文档需要的元素名称不适合C＃lang。 命名规范，您必须使用属性:)