使用c#属性将友好名称属性添加到xml元素以进行序列化?

时间:2015-10-03 03:59:17

标签: c# .net xml xml-serialization

我有一些从数据库生成的实体,我想将它们序列化为XML。问题是某些实体的列名不是那么用户友好,这反映在生成的实体的字段中。

是否有可以应用于类字段的C#属性,以便我可以向xml元素本身添加包含友元名称值的xml属性?例如,使用类似于XmlAttribute的东西:

public class Book
{
    public string Title { get; set; }

    [XmlAttribute("friendlyName","International Standard Book Number")]
    public string ISBN { get; set; }
} 

在序列化时会产生类似的结果:

<Book>
  <Title>To Kill a Mockingbird</Title>
  <ISBN friendlyName="International Standard Book Number">9780061120084</ISBN>
</Book>

2 个答案:

答案 0 :(得分:1)

没有属性会这样做。将元素文档与xml数据混合并不常见。通常,您希望使用xsd文档或其他方法来记录xml架构。

话虽如此,这就是你如何做到的。您需要将ISBN属性从字符串更改为具有可以序列化的friendlyName属性的自定义类型。

public class Book
{
    public string Title { get; set; }

    public ISBN ISBN { get; set; }
}

public class ISBN
{
    [XmlText]
    public string value { get; set; }

    [XmlAttribute]
    public string friendlyName { get; set; }
}

以下内容将与您在问题中的内容完全一致。

Book b = new Book
{
    Title = "To Kill a Mockingbird",
    ISBN = new ISBN
    {
        value = "9780061120084",
        friendlyName = "International Standard Book Number",
    }
};

<强>更新

好的,另一种方法是创建一个自定义XmlWriter,它可以拦截序列化程序创建元素的调用。为要为其添加友好名称的属性创建元素时,可以使用自己的自定义属性进行编写。

public class MyXmlTextWriter : XmlTextWriter
{
    public MyXmlTextWriter(TextWriter w)
        : base(w)
    {
    }

    public override void WriteStartElement(string prefix, string localName, string ns)
    {
        base.WriteStartElement(prefix, localName, ns);

        switch(localName)
        {
            case "ISBN":
                WriteAttributeString("friendlyName", "International Standard Book Number");
                break;
        }
    }
}

以下是一个如何使用它的示例(来自控制台应用程序):

XmlSerializer serializer = new XmlSerializer(typeof(Book));
serializer.Serialize(new MyXmlTextWriter(Console.Out), b);

如果您需要能够写入XmlTextWriter之类的其他内容,则可以实现Stream的其他构造函数。

答案 1 :(得分:0)

试试这个

    [XmlRoot("Book")]
    public class Book
    {
        [XmlElement("Title")]
        public string Title { get; set; }

        [XmlElement("ISBN")]
        public ISBN isbn { get; set; }
    }
    [XmlRoot("ISBN")]
    public class ISBN
    {
        [XmlAttribute("friendlyName")]
        public string friendlyName { get; set; }

        [XmlText]
        public string value { get; set; }
    }​