Color 结构最优雅的 XML 序列化

Question

一个问题困扰着我，足以在 Stack Overflow 上注册。目前，如果我想将 Color 序列化为 XML 字符串作为命名颜色，或#rrggbb，或#aarrggbb，我这样做：

[XmlIgnore()]
public Color color;

[XmlElement(ElementName = "Color")]
public String color_XmlSurrogate
{
  get { return MyColorConverter.SetColor(color); }
  set { color = MyColorConverter.GetColor(value); }
}

MyColorConverter 以我喜欢的方式进行序列化。但这一切感觉就像一个杂物，还有额外的领域和所有东西。有没有办法让它在更少的行中工作，也许将 TypeDescriptor 与与 XML 相关的 C# 属性连接起来？

Answer 1

很痛苦，不是吗？这就是你可以用XmlSerializer 做的所有事情，除非你实现IXmlSerializable（我确实不推荐）。选项：

• 坚持这一点，但也将 color_XmlSurrogate 标记为 [Browsable(false), EditorBrowsable(EditorBrowsableState.Never)] - 这将阻止它出现在大多数数据绑定视图中，以及在将程序集引用为 dll 时出现在代码编辑器中
• 使用DataContractSerializer，它支持私有属性（但不支持xml属性；你赢不了...）

顺便说一句，我会将color 作为属性，而不是字段：

[XmlIgnore]
public Color Color {get;set;}

Answer 2

这是我用来序列化 XML 中的 Color 结构的东西。在我看来，这比隐藏主要的Color 属性要好。欢迎提出任何建议。

XmlColor 类主要依靠implicit operator 语言功能来提供关键数据转换。没有这个，这个类基本上是没用的。添加了其他一些功能来完善课程。

XmlColor 助手还提供了一种方便的方法来分离颜色分量。我添加了 Alpha 属性来显示这一点。请注意，如果Alpha 组件一直上升到 255，则不会被序列化。

反序列化Web 颜色值会结合当前存储在实例中的Alpha 值。解析属性的顺序无关紧要。如果 XML 源中缺少 Alpha 属性，则实例组件值将用于设置 Alpha 级别。这可以说是错误的；但是，在 XML 序列化的情况下，XmlColor 类将使用 Color.Black 初始化，将 Alpha 设置为 255。

我正在使用 VS2010 环境并针对 .Net 4 进行构建。我不知道代码与以前版本的兼容性如何。

这是一个应序列化为 XML 的示例属性：

    [XmlElement(Type=typeof(XmlColor))]
    public Color MyColor { get; set; }

这里是 XmlColor 助手类：

public class XmlColor
{
    private Color color_ = Color.Black;

    public XmlColor() {}
    public XmlColor(Color c) { color_ = c; }


    public Color ToColor()
    {
        return color_;
    }

    public void FromColor(Color c)
    {
        color_ = c;
    }

    public static implicit operator Color(XmlColor x)
    {
        return x.ToColor();
    }

    public static implicit operator XmlColor(Color c)
    {
        return new XmlColor(c);
    }

    [XmlAttribute]
    public string Web
    {
        get { return ColorTranslator.ToHtml(color_); }
        set {
            try
            {
                if (Alpha == 0xFF) // preserve named color value if possible
                    color_ = ColorTranslator.FromHtml(value);
                else
                    color_ = Color.FromArgb(Alpha, ColorTranslator.FromHtml(value));
            }
            catch(Exception)
            {
                color_ = Color.Black;
            }
        }
    }

    [XmlAttribute]
    public byte Alpha
    {
        get { return color_.A; }
        set { 
            if (value != color_.A) // avoid hammering named color if no alpha change
                color_ = Color.FromArgb(value, color_); 
        }
    }

    public bool ShouldSerializeAlpha() { return Alpha < 0xFF; }
}

Answer 3

我找到了另一个解决方案，

可以使用 System.Windows.Media.Color 代替 System.Drawing.Color。
它可以序列化为 XML。

Answer 4

由于这是我在这里的第一个问题，因此我决定对其进行更多调查。 @bvj 给出了一个很好的答案。我调整了他的代码，所以就在这里。 XmlColor 类已更改，以便序列化的字符串进入标签的文本，如果字符串应序列化为 XML 属性而不是标签，则有公共静态函数。不幸的是，属性仍然必须使用代理字段进行序列化，但如果我错了，请纠正我。使用类：

// Color as tag
[XmlElement(Type = typeof(XmlColor))]
public Color ColorAsTag { get; set; }

// Color as attribute
[XmlIgnore]
public Color ColorAsAttribute { get; set; }

[XmlAttribute("ColorAsAttribute")]
public string ColorAsAttribute_XmlSurrogate
{
    get { return XmlColor.FromColor(ColorAsAttribute); }
    set { ColorAsAttribute = XmlColor.ToColor(value); }
}

实现它的类：

public class XmlColor
{
    private Color color_ = Color.Black;

    public XmlColor() { }
    public XmlColor(Color c) { color_ = c; }


    public static implicit operator Color(XmlColor x)
    {
        return x.color_;
    }

    public static implicit operator XmlColor(Color c)
    {
        return new XmlColor(c);
    }

    public static string FromColor(Color color)
    {
        if (color.IsNamedColor)
            return color.Name;

        int colorValue = color.ToArgb();

        if (((uint)colorValue >> 24) == 0xFF)
            return String.Format("#{0:X6}", colorValue & 0x00FFFFFF);
        else
            return String.Format("#{0:X8}", colorValue);
    }

    public static Color ToColor(string value)
    {
        try
        {
            if (value[0] == '#')
            {
                return Color.FromArgb((value.Length <= 7 ? unchecked((int)0xFF000000) : 0) +
                    Int32.Parse(value.Substring(1), System.Globalization.NumberStyles.HexNumber));
            }
            else
            {
                return Color.FromName(value);
            }
        }
        catch (Exception)
        {
        }

        return Color.Black;
    }

    [XmlText]
    public string Default
    {
        get { return FromColor(color_); }
        set { color_ = ToColor(value); }
    }
}

Answer 5

我相信下面我有一个更简单的解决方案。颜色序列化被忽略，颜色作为简单的 32 位 ARGB 数据保存和加载。

[XmlIgnore]
public Color BackColor { get; set; }

[XmlElement("BackColor")]
public int BackColorAsArgb
{
    get { return BackColor.ToArgb();  }
    set { BackColor = Color.FromArgb(value); }
}

Answer 6

对于那些使用System.Windows.Media.Color 的人，@bvj 的解决方案可以简化，利用类的ToString 方法：

    using System.Windows.Media;

    public class XmlColor
    {
        private Color m_color;

        public XmlColor() { }
        public XmlColor(Color c) { m_color = c; }

        public static implicit operator Color(XmlColor x)
        {
            return x.m_color;
        }

        public static implicit operator XmlColor(Color c)
        {
            return new XmlColor(c);
        }

        [XmlText]
        public string Default
        {
            get { return m_color.ToString(); }
            set { m_color = (Color)ColorConverter.ConvertFromString(value); }
        }
    }
}

和以前一样，现在您可以在每个可序列化的 Color 属性之前添加它：

[XmlElement(Type = typeof(XmlColor))]

默认情况下，System.Media.Color 序列化为此 XML：

<DisplayColor>
  <A>255</A>
  <R>123</R>
  <G>0</G>
  <B>0</B>
  <ScA>1</ScA>
  <ScR>0.482352942</ScR>
  <ScG>0</ScG>
  <ScB>0</ScB>
</DisplayColor>

通过上述转换，它序列化为：

<DisplayColor>#FF7B0000</DisplayColor>