一个关于解决序列化问题的编程技巧

在前一篇文章中我曾经说过，现在正在做一个小小的框架以实现采用统一的API实现对上下文（Context）信息的统一管理。这个框架同时支持Web和GUI应用，并支持跨线程传递和跨域传递（这里指在WCF服务调用中实现客户端到服务端隐式传递），以及对上下文项目（ContextItem）的读写控制。关键就在于后面两个特性的支持上面，出现一个小小的关于序列化的问题。解决方案只需要改动短短的一行代码，结果却让我折腾了老半天。

一、问题重现

为了重现我实际遇到的问题，我特意将问题简化，为此我写了一个简单的例子（你可以从这里下载）。在下面的代码片断中，我创建了一个名称为ContextItem的类型，代表一个需要维护的上下文项。由于需要在WCF服务调用实现自动传递，我将起定义成DataContract。ContextItem包含Key，Value和ReadOnly三个属性，不用说ReadOnly表示该ContextItem可以被修改。注意Value属性Set方法的定义——如果ReadOnly则抛出异常。

[DataContract(Namespace = "http://www.artech.com")]
public class ContextItem
{
    private object value = null;
    [DataMember]
    public string Key { get; private set; }
    [DataMember]
    public object Value
    {
        get
        {
            return this.value;
        }
        set
        {
            if (this.ReadOnly)
            {
                throw new InvalidOperationException("Cannot change the value of readonly context item.");
            }
            this.value = value;
        }
    }
    [DataMember]
    public bool ReadOnly { get; set; }
    public ContextItem(string key, object value)
    {
        if (string.IsNullOrEmpty(key))
        {
            throw new ArgumentNullException("key");
        }
        this.Key = key;
        this.Value = value;
    }
}

为了演示序列化和反序列化，我写了如下两个静态的帮助方法。Serialize和Deserialize分别用于序列化和反序列化，前者将对象序列成成XML并保存到指定的文件中，后者则从文件读取XML并反序列化成相应的对象。

public static T Deserialize<T>(string fileName)
{
    DataContractSerializer serializer = new DataContractSerializer(typeof(T));
    using (XmlReader reader = new XmlTextReader(fileName))
    {
        return (T)serializer.ReadObject(reader);
    }
}

public static void Serialize<T>(T instance, string fileName)
{
    DataContractSerializer serializer = new DataContractSerializer(typeof(T));
    using (XmlWriter writer = new XmlTextWriter(fileName, Encoding.UTF8))
    {
        serializer.WriteObject(writer, instance);
    }
    Process.Start(fileName);
}

我们的程序很简单。从如下的代码片断中，我们先创建一个ContextItem对象，然后将ReadOnly属性设置成true。然后调用Serialize方法将对象序列化成XML并保存在一个名称为context.xml的文件中。然后调用Deserialize方法，读取该文件进行反序列化。

static void Main(string[] args)
{
    var contextItem1 = new ContextItem("__userId", "Foo");
    contextItem1.ReadOnly = true;
    Serialize<ContextItem>(contextItem1, "context.xml");
    var contextItem2 = Deserialize<ContextItem>("context.xml");
}

序列化操作能够正常执行，但当程序执行到Deserialize的时候抛出如下一个InvalidOperationException异常。

二、问题分析

从上面给出的截图，我们不难看出，异常是在给ContextItem对象的Value属性赋值的时候抛出的。如果对DataContractSerializer序列化器的序列化/反序列化规则的有所了解的话，应该知道：对于数据契约（DataContract）基于属性（Property）的数据成员（DataMember），序列器在反序列化的时候是通过调用Set方法对其进行初始化的。在本例中，由于ReadOnly是True，在对Value进行反序列化的时候必然会调用Set方法。但是，只读的ContextItem却不能对其赋值，所以异常抛出。

那么，如何来解决这个问题呢？我最初的想法是这样：在序列化的时候将ReadOnly属性设置成False，然后添加另一个属性专门用于保存真实的值。在进行反序列的时候，由于ReadOnly为false，所以不会出现异常。当反序列化完成之后，在将ReadOnly的初始值赋上。虽然上述的方案能够解决问题，但是为此对ContextItem添加一个只在序列化和反序列化的过程中在有用的属性，总觉得很丑陋。

我们不妨换一种思路：异常产生于对Value属性凡序列化时发现ReadOnly非True的情况。那么怎样采用避免这种情况的发生呢？如果Value属性先于ReadOnly属性被序列化，那么ReadOnly的初始值就是False，这个问题不就解决了吗？这就是我们的第一个解决方案。

三、解决方案一：通过控制属性反序列化顺序

那么，如果控制那么属性先被反序列化，那么后被序列化呢？这就是要了解DataContractSerializer序列化器的序列化和发序列化规则了。在默认的情况下，DataContractSerializer是按照数据成员的名称的顺序进行序列化的。这可以从生成出来的XML的结构看出来。而XML元素的先后顺序决定了反序列化的顺序。

<ContextItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.artech.com">
    <Key>__userId</Key>
    <ReadOnly>true</ReadOnly>
    <Value xmlns:d2p1="http://www.w3.org/2001/XMLSchema" i:type="d2p1:string">Foo</Value>
</ContextItem>

在上面的例子中，ContextItem的ReadOnly排在Value的前面，会先被序列化。那么，是不是我们要更新Value或者ReadOnly的数据成员（DataMember，不是属性名称）呢？这肯定不是我们想要的解决方案。在SOA的世界中，DataMember是契约的一部分，往往是不容许更改的。

如果在不更改数据成员名称的前提下让属性Value先于ReadOnly被序列化，需要用到DataContractSerializer另一条反序列化规则：我们可以通过DataMemberAttribute特性的Order属性控制序列化后的属性在XML元素列表中的位置。

为此，我们有了答案，我们只需要将ContextItem稍加改动就可以了。在如下的代码中，在为Value和ReadOnly两个属性应用DataMemberAttribute的时候，将Order属性分别设置成1和2，这样就能使ContextItem对象在被序列化的时候，Value和ReadOnly属性对应的XML元素将永远会有前后之分。这里还需要注意的是，在Value属性的Set方法中，判断是否只读，采用的不是ReadOnly属性，而是对应的readonly字段。这一点非常重要，如果调用ReadOnly属性将会迫使该属性被反序列化。

[DataContract(Namespace = "http://www.artech.com")]
public class ContextItem
{
    private object value = null;
    private bool readOnly;
    [DataMember]
    public string Key { get; private set; }

    [DataMember(Order = 1)]
    public object Value
    {
        get
        {
            return this.value;
        }
        set
        {
            if (this.readOnly)
            {
                throw new InvalidOperationException("Cannot change the value of readonly context item.");
            }
            this.value = value;
        }
    }
    [DataMember(Order =2)]
    public bool ReadOnly
    {
        get
        {
            return readOnly;
        }
        set
        {
            readOnly = value;
        }
    }
    //Others
}

有兴趣的读者可以亲自试试看，如果我们进行了如上的更改，前面的程序就能正常运行了。到这里，有的读者可以要问了，你不是说仅仅有一行代码的变化吗，我看上面改动的不止一行嘛。没有错，我们完全可以作更少的更改来解决问题。

四、解决方案二：将数据成员定义在字段上而不是属性上

我们再换一种思维，之所以出现异常是在反序列化的时候调用Value属性的Set方法所致。如果在反序列化的时候不调用这个方法不就得了吗？那么，如何才能避免对Value属性的Set方法的调用呢?方法很简单，那就是将数据成员定义在字段上，而不是属性上。基于属性的数据成员在反序列化的时候不得不通过调用Set方法对数据项进行初始化，而基于字段的数据成员在反序列化的时候只需要直接对其复制就可以了。

基于这样的思路，我们对原来的ContextItem进行简单的改动——将DataMemberAttribute特性从Value属性移到value字段上。需要注意的，为了符合于原来的Schema，需要将DataMemberAttribute特性的Name属性设置成“Value”。

[DataContract(Namespace = "http://www.artech.com")]
public class ContextItem
{
    [DataMember]
    public string Key { get; private set; }

    [DataMember(Name = "Value")]
    private object value = null;
    public object Value
    {
        get
        {
            return this.value;
        }
        set
        {
            if (this.ReadOnly)
            {
                throw new InvalidOperationException("Cannot change the value of readonly context item.");
            }
            this.value = value;
        }
    }
    [DataMember]
    public bool ReadOnly { get; set; }
     //Others
    }
}

总结

虽然这仅仅是一个很小的问题，解决的方案看起来也是如此的简单。但是，这并不意味着这是一个可以被忽视的问题，背后隐藏对DataMemberAttribute序列化的序列化规则的理解。

作者：Artech
出处：http://artech.cnblogs.com
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。