小心DataContractJsonSerializer和JavaScriptSerializer的内部实现差异

问题的引子

先来看问题的引子。

定义一个下面这样的类，此类有Serializable属性，并且有一个属性的定义没有使用自动属性来实现。

[Serializable]
public class Users
{
    public int UserID { get; set; }

    public string UserName { get; set; }

    public string UserEmail { get; set; }

    private string _testProperty;
    public string TestProperty
    {
        get { return _testProperty; }
        set { _testProperty = value; }
    }
}

然后分别使用DataContractJsonSerializer和JavaScriptSerializer对此对象的示例进行序列化。

使用DataContractJsonSerializer序列化后的结果。

{"_testProperty":"TestPropertyValue","<UserEmail>k__BackingField":"parry@cnblogs.com",
"<UserID>k__BackingField":1,"<UserName>k__BackingField":"Parry"}

使用JavaScriptSerializer序列化后的结果。

{"UserID":1,"UserName":"Parry","UserEmail":"parry@cnblogs.com","TestProperty":"TestPropertyValue"}

DataContractJsonSerializer和JavaScriptSerializer的实现差异

DataContractJsonSerializer在.NET Framework 3.5中引入，主要因为WCF的引入而添加了这个对象序列化的基本方法，并且微软同时将JavaScriptSerializer打上了过时（obsolete）的标签，编译时就会有警告出现。

而在.NET Framework 3.5 SP1中，微软又将JavaScriptSerializer的“过时”标签给去掉了。

使用Reflector去比较这两个类的内部实现发现，DataContractJsonSerializer在对象序列化时进行了更为严格的检查，感兴趣的可以去System.Runtime.Serialization.Json下面的核心方法InternalWriteObjectContent去看其实现。

而在.NET Framework 3.5引入的自动属性，实际上就是个语法糖，编译器还是会生成一个int类型的<Name>k_BackingField的私有字段作为这个属性的后端字段，内部还是和以前的get/set方法一样。

所以直接使用DataContractJsonSerializer进行序列化时，又将编译器生成的k_BackingField带了出来。

而JavaScriptSerializer的实现则非常简单，将属性名和属性值分别存储在Dictionary里，然后进行字符串拼接返回而已，所以对类定义几乎没有检查并且对复杂类的支持不太好。

下面是JavaScriptSerializer里面的核心方法SerializeValue的实现。

private void SerializeValue(object o, StringBuilder sb, int depth, Hashtable objectsInUse,
SerializationFormat serializationFormat, MemberInfo currentMember = null) {
    if (++depth > _recursionLimit) { 
        throw new ArgumentException(AtlasWeb.JSON_DepthLimitExceeded); 
    }

    // Check whether a custom converter is available for this type.
    JavaScriptConverter converter = null;
    if (o != null && ConverterExistsForType(o.GetType(), out converter)) {
        IDictionary<string, object> dict = converter.Serialize(o, this); 

        if (TypeResolver != null) { 
            string typeString = TypeResolver.ResolveTypeId(o.GetType()); 
            if (typeString != null) {
                dict[ServerTypeFieldName] = typeString; 
            }
        }

        sb.Append(Serialize(dict, serializationFormat)); 
        return;
    } 

    SerializeValueInternal(o, sb, depth, objectsInUse, serializationFormat, currentMember);
} 

解决方法

如果一定要使用DataContractJsonSerializer，只有当为类加上[DataContract]属性，并且为需要序列化的属性加上[DataMember]后，使用DataContractJsonSerializer才可以生成干净、整洁的JSON数据。

而当我们使用一些不能修改的类定义，如上面的Users类定义，我们没有权限去修改其定义，那么就可以使用JavaScriptSerializer去进行JSON序列化。

当然第三方的Json.NET(Newtonsoft.Json)也是可以实现的，并且在支持的功能和效率方面往往是一个更好的选择，在这里看它和DataContractJsonSerializer以及JavaScriptSerializer的使用对比。

所以在使用时需要稍微注意下这三个JSON序列化方法的差异，根据自己的需求灵活选择合适的组件。