XmlSerializer:将类属性序列化为自定义子元素的属性

时间:2012-02-06 11:08:16

标签: c# xml serialization xml-serialization

我正在使用XmlSerializer。我的班级:

[Serializable]
[XmlRoot(ElementName="MyClass")]
public class MyClass
{
    public string Value;
}

我想序列化它,以便Value最终成为名为(例如)“Text”的子元素的属性。

期望的结果:

<MyClass>
    <Text Value="3"/>
</MyClass>

(这会将价值标记为XmlAttribute

<MyClass Value="3">
</MyClass>

NOT (这会将值标记为XmlElement):

<MyClass>
    <Value>3</Value>
</MyClass>

我如何实现这一目标?

我知道我可以将Value的类型从字符串更改为另一个可序列化的自定义类。

不幸的是,我有很多这样的属性,所以我需要创建几十个小类。

有没有更快的解决方案?


修改

回应你的意见:

  • 不,并非每个属性都必须序列化为名为“Text”的子元素。 Subelement的名称是唯一且明确的。

  • 示例输出XML:

    <visibility>
        <site visible="yes"/>
        <comparator visible="no"/>
        <expiration days="7"/>
        <comment>blahblahblah</comment>
    <visibility>
    
  • 示例课程:

<!/ P>

[XmlRoot(ElementName="Visibility")]
public class Visibility
{
    [XPath("/site@visible")] // if only this was possible!
    public string OnSite
    {
        get { return SiteVisible ? "yes" : "no"; }
    }

    [XPath("/comparator@visible")] // as above...
    public string InComparator
    {
        get { return ComparatorVisible ? "yes" : "no"; }
    }

    [XmlIgnore]
    public bool SiteVisible;
    [XmlIgnore]
    public bool ComparatorVisible;

    [XPath("/expiration@days")] // as above...
    public int ExpiresAfterDays; 

    [XmlElement("comment")] // this is easy
    public string Comment;
}

3 个答案:

答案 0 :(得分:4)

不改变Value的类型我认为这是不可能的。您可以在XmlElement(ElementName="Text")上添加属性Value,但您将获得与此类似的结果:

<MyClass> 
    <Text>3</Text> 
</MyClass> 

<强>编辑: 另一个解决方案可能涉及XSLT转换:您可以使用.Net序列化生成xml,并在应用xml转换后生成。

XslTransform myXslTransform = new XslTransform();
myXslTransform.Load(xsltDoc);
myXslTransform.Transform(sourceDoc, resultDoc);

我的例子的变形应该是这样的:

<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
    <xsl:template match="/">
    <root>
        <xsl:apply-templates/>
    </root>
    </xsl:template>
    <xsl:template match="MyClass">
        <MyClass>
            <Text>
               <xsl:attribute name="Value">
                    <xsl:value-of select="Text"/>
               </xsl:attribute>
            </Text>
        </MyClass>
    </xsl:template>
</xsl:stylesheet>

答案 1 :(得分:4)

为了这种灵活性,您应该考虑实施IXmlSerializable,因为这可以让您获得更多控制权:

[XmlRoot("visibility")]
public class Visibility : IXmlSerializable
{
    public string Site;
    public string Comparator;
    public int Expiration;
    public string Comment;

    public XmlSchema GetSchema()
    {
        throw new NotImplementedException();
    }

    public void ReadXml(XmlReader reader)
    {
        // implement me if you want to deserialize too.
        throw new NotImplementedException();
    }

    public void WriteXml(XmlWriter writer)
    {
        WriteProperty(writer, "site", "visible", Site);
        WriteProperty(writer, "comparator ", "visible", Comparator);
        WriteProperty(writer, "expiration ", "days", Expiration);

        if (!string.IsNullOrEmpty(Comment))
        {
            writer.WriteElementString("comment", Comment);
        }
    }

    private void WriteProperty<T>(XmlWriter writer, string elementName, string attibuteName, T value)
    {
        if (value != null)
        {
            writer.WriteStartElement(elementName);
            writer.WriteAttributeString(attibuteName, value.ToString());
            writer.WriteEndElement();
        }
    }
}

显然,这里有一些手工工作,但它确实允许你将所有序列化代码保存在一个地方,而不是增加更小的类。

上面的示例仅实现序列化 - 如果需要从xml反序列化到类型,则需要编写等效的反序列化实现。

答案 2 :(得分:0)

感谢所有答案。遗憾的是,.NET XmlSerialization库不允许这样做(我认为它应该!)。我正在寻找尽可能通用的解决方案。

我能想到的最好的一个(最好考虑最大通用性的标准,同时合理地快速实现)是让XmlSerializer按照自己喜欢的方式序列化我的类,然后只转换输出,将某些元素重新定位到嵌套位置。

类似的东西:

    /// <remarks>
    /// (angle brackets replaced with round ones to avoid confusing the XML-based documentation comments format)
    /// 
    /// Let input XML be:
    /// 
    ///     (root)
    ///         (days)3(/days)
    ///     (/root)
    ///     
    /// Calling Reposition on this input with mappings argument being:
    ///     (key) "days"
    ///     (value) { "time", "days" }
    ///     
    /// Returns:
    /// (root)
    ///     (time days="3" /)
    /// (/root)
    /// </remarks>        
    static XElement Reposition(XElement input, KeyValuePair<string, string[]>[] mappings)
    {
        var result = new XElement(input);
        foreach (var mapping in mappings)
        {
            var element = result.Element(mapping.Key);
            if (element == null)
            {
                continue;
            }
            var value = element.Value;
            element.Remove();

            var insertAt = result;
            foreach (var breadcrumb in mapping.Value)
            {
                if (breadcrumb == mapping.Value.Last())
                {
                    insertAt.Add(new XAttribute(breadcrumb, value));
                }
                else
                {
                    insertAt.Add(new XElement(breadcrumb));
                    insertAt = insertAt.Element(breadcrumb);
                }
            }
        }
        return result;
    }

我想我会将它与自定义属性结合起来(类似于我希望存在的XPath属性:请参阅我的问题中的示例代码),并在我的序列化程序类中包含此功能自己的。

对此方法的任何意见/见解?

我可以想到一个潜在的性能缺陷(在每次序列化后重写/重新分析XML),但是由此产生的XML片段预计不会很大,所以这可能是微不足道的。

反序列化的问题在这一点上并不困扰我(反序列化已经实现并且通过XPath和一些实用方法完全“手动”完成)。