在.NET使用JSON做爲數據交換格式

咱們知道在.NET中咱們有多種對象序列化的方式，如XML方式序列化、Binary序列化，其中XML序列化是一種比較通用的在各語言之間傳遞數據的方式。除了這兩種序列化方式以外，在.NET中還可使用JSON序列化。
JSON（JavaScript Object Notation）是一種輕量級輕量級的數據交換格式，而且它獨立於編程語言，與XML序列化相比，JSON序列化後產生的數據通常要比XML序列化後數據體積小，因此在Facebook等知名網站中都採用了JSON做爲數據交換方式。在.NET中有三種經常使用的JSON序列化的類，分別是System.Web.Script.Serialization.JavaScriptSerializer類、System.Runtime.Serialization.Json.DataContractJsonSerializer類和Newtonsoft.Json.JsonConvert類。
爲了便於下面的演示，下面提供一個類的代碼：
    [DataContract]
    public class User
    {
        /// <summary>
        /// 編號
        /// </summary>
        [DataMember]
        public int UserId { get; set; }
        /// <summary>
        /// 用戶名
        /// </summary>
        [DataMember]
        public string UserName { get; set; }
        /// <summary>
        /// 建立時間
        /// </summary>
        [DataMember]
        [JsonConverter(typeof(IsoDateTimeConverter))]
        public DateTime CreateDate { get; set; }
        /// <summary>
        /// 生日
        /// </summary>
        [DataMember]
        [JsonConverter(typeof(JavaScriptDateTimeConverter))]
        public DateTime Birthday { get; set; }
        /// <summary>
        /// 相關URL
        /// </summary>
        [DataMember]
        public List<string> Urls { get; set; }
        /// <summary>
        /// 薪水
        /// </summary>
        //[ScriptIgnore]//使用JavaScriptSerializer序列化時不序列化此字段
        //[IgnoreDataMember]//使用DataContractJsonSerializer序列化時不序列化此字段
        //[JsonIgnore]//使用JsonConvert序列化時不序列化此字段
        public int Salary { get; set; }
        /// <summary>
        /// 權利級別
        /// </summary>
        [DataMember]
        public Priority Priority { get; set; }

        public User()
        {
            Urls = new List<string>();
        }
    }
    /// <summary>
    /// 權利級別
    /// </summary>
    public enum Priority:byte
    {
        Lowest=0x1,
        BelowNormal=0x2,
        Normal=0x4,
        AboveNormal=0x8,
        Highest=0x16
    }
使用System.Web.Script.Serialization.JavaScriptSerializer類
System.Web.Script.Serialization.JavaScriptSerializer類是.NET類庫中自帶的一種JSON序列化實現，在.NET Framework3.5及之後版本中可使用這個類，這個類位於System.Web.Extensions.dll中，使用這個類是必須添加對這個dll的引用。
下面的代碼是使用JavaScriptSerializer進行序列化和反序列化的例子：
public static void JavaScriptSerializerDemo()
{
    User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30),Birthday=DateTime.Now.AddYears(-50), Priority = Priority.Highest, Salary = 500000 };
    //JavaScriptSerializer類在System.Web.Extensions.dll中，注意添加這個引用
    JavaScriptSerializer serializer = new JavaScriptSerializer();
    //JSON序列化
    string result=serializer.Serialize(user);
    Console.WriteLine("使用JavaScriptSerializer序列化後的結果：{0},長度：{1}", result, result.Length);
    //JSON反序列化
    user = serializer.Deserialize<User>(result);
    Console.WriteLine("使用JavaScriptSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);

}
說明：若是不想序列化某個字段，能夠在字段前面加[JsonIgnore]標記。
使用System.Runtime.Serialization.Json.DataContractJsonSerializer類
System.Runtime.Serialization.Json.DataContractJsonSerializer類位於System.ServiceModel.Web.dll中，使用這個類時除了須要添加對System.ServiceModel.Web.dll的引用以外，還須要添加System.Runtime.Serialization.dll的引用，注意這個類也是在.NET Framework3.5及之後版本中可使用。
下面是使用DataContractJsonSerializer類的例子：
public static void DataContractJsonSerializerDemo()
{
    User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.AboveNormal, Salary = 50000 };
    string result = string.Empty;
    //DataContractJsonSerializer類在System.ServiceModel.Web.dll中，注意添加這個引用
    DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));
   
    using (MemoryStream stream = new MemoryStream())
    {
        //JSON序列化
        serializer.WriteObject(stream, user);
        result = Encoding.UTF8.GetString(stream.ToArray());
        Console.WriteLine("使用DataContractJsonSerializer序列化後的結果：{0},長度：{1}", result, result.Length);
    }

    //JSON反序列化
    byte[] buffer = Encoding.UTF8.GetBytes(result);
    using (MemoryStream stream = new MemoryStream(buffer))
    {
        user = serializer.ReadObject(stream) as User;
        Console.WriteLine("使用DataContractJsonSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
    }
}
注意：要使用DataContractJsonSerializer類進行序列化和反序列化，必須給類加上[DataContract]屬性，對要序列化的字段加上[DataMember]屬性，若是不想序列化某個字段或者屬性，能夠加上[IgnoreDataMember]屬性。
使用Newtonsoft.Json.JsonConvert類
Newtonsoft.Json.JsonConvert類是非微軟提供的一個JSON序列化和反序列的開源免費的類庫（下載網址是：http://www.codeplex.com/json/），它提供了更靈活的序列化和反序列化控制，而且若是你的開發環境使用的是.NET Framework3.5及之後版本的話，你就可使用Linq to JSON，這樣一來面對一大段的數據沒必要一一解析，你可使用Linq to JSON解析出你關心的那部分便可，很是方便。
下面是使用Newtonsoft.Json.JsonConvert類的例子：
public static void JsonConvertDemo()
{
    User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.BelowNormal, Salary = 5000 };
    //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並添加這個引用
    //JSON序列化
    string result = JsonConvert.SerializeObject(user);
    Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);
    //JSON反序列化
    user = JsonConvert.DeserializeObject<User>(result);
    Console.WriteLine("使用JsonConvert反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
}

public static void JsonConvertLinqDemo()
{
    User user = new User { UserId = 1, UserName = "周公", CreateDate = DateTime.Now.AddYears(-8), Birthday = DateTime.Now.AddYears(-32), Priority = Priority.Lowest, Salary = 500, Urls = new List<string> { "http://zhoufoxcn.blog.51cto.com", "http://blog.csdn.net/zhoufoxcn" } };
    //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並添加這個引用
    //JSON序列化
    string result = JsonConvert.SerializeObject(user);
    Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);
    //使用Linq to JSON
    JObject jobject = JObject.Parse(result);
    JToken token = jobject["Urls"];
    List<string> urlList = new List<string>();
    foreach (JToken t in token)
    {
        urlList.Add(t.ToString());
    }
    Console.Write("使用Linq to JSON反序列化後的結果：[");
    for (int i = 0; i < urlList.Count - 1;i++ )
    {
        Console.Write(urlList[i] + ",");
    }
    Console.WriteLine(urlList[urlList.Count - 1] + "]");
}
注意：若是有不須要序列化的字段，能夠給該字段添加[JsonIgnore]標記。在Newtonsoft這個類庫中對於日期的序列化有多種方式，能夠類的DataTime成員添加上對應的標記，這樣在進行序列化和反序列化時就會按照指定的方式進行，在本例中User類的CreateDate屬性添加的屬性是[JsonConverter(typeof(IsoDateTimeConverter))]，而Birthday屬性添加的屬性是[JsonConverter(typeof(JavaScriptDateTimeConverter))]，從序列化的結果能夠看出來它們最終的表現形式並不同。
本文中全部的示例代碼以下：

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Web.Script.Serialization;
using System.Runtime.Serialization.Json;
using System.IO;
using System.Runtime.Serialization;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Converters;

namespace JSONDemo
{
class Program
{
    static void Main(string[] args)
    {
        JavaScriptSerializerDemo();
        DataContractJsonSerializerDemo();
        JsonConvertDemo();
        JsonConvertLinqDemo();
        Console.ReadLine();
    }

    public static void JavaScriptSerializerDemo()
    {
        User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30),Birthday=DateTime.Now.AddYears(-50), Priority = Priority.Highest, Salary = 500000 };
        //JavaScriptSerializer類在System.Web.Extensions.dll中，注意添加這個引用
        JavaScriptSerializer serializer = new JavaScriptSerializer();
        //JSON序列化
        string result=serializer.Serialize(user);
        Console.WriteLine("使用JavaScriptSerializer序列化後的結果：{0},長度：{1}", result, result.Length);
        //JSON反序列化
        user = serializer.Deserialize<User>(result);
        Console.WriteLine("使用JavaScriptSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);

    }

    public static void DataContractJsonSerializerDemo()
    {
        User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.AboveNormal, Salary = 50000 };
        string result = string.Empty;
        //DataContractJsonSerializer類在System.ServiceModel.Web.dll中，注意添加這個引用
        DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));

        using (MemoryStream stream = new MemoryStream())
        {
            //JSON序列化
            serializer.WriteObject(stream, user);
            result = Encoding.UTF8.GetString(stream.ToArray());
            Console.WriteLine("使用DataContractJsonSerializer序列化後的結果：{0},長度：{1}", result, result.Length);
        }

        //JSON反序列化
        byte[] buffer = Encoding.UTF8.GetBytes(result);
        using (MemoryStream stream = new MemoryStream(buffer))
        {
            user = serializer.ReadObject(stream) as User;
            Console.WriteLine("使用DataContractJsonSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
        }
    }

    public static void JsonConvertDemo()
    {
        User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.BelowNormal, Salary = 5000 };
        //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並添加這個引用
        //JSON序列化
        string result = JsonConvert.SerializeObject(user);
        Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);
        //JSON反序列化
        user = JsonConvert.DeserializeObject<User>(result);
        Console.WriteLine("使用JsonConvert反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
    }

    public static void JsonConvertLinqDemo()
    {
        User user = new User { UserId = 1, UserName = "周公", CreateDate = DateTime.Now.AddYears(-8), Birthday = DateTime.Now.AddYears(-32), Priority = Priority.Lowest, Salary = 500, Urls = new List<string> { "http://zhoufoxcn.blog.51cto.com", "http://blog.csdn.net/zhoufoxcn" } };
        //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並添加這個引用
        //JSON序列化
        string result = JsonConvert.SerializeObject(user);
        Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);
        //使用Linq to JSON
        JObject jobject = JObject.Parse(result);
        JToken token = jobject["Urls"];
        List<string> urlList = new List<string>();
        foreach (JToken t in token)
        {
            urlList.Add(t.ToString());
        }
        Console.Write("使用Linq to JSON反序列化後的結果：[");
        for (int i = 0; i < urlList.Count - 1;i++ )
        {
            Console.Write(urlList[i] + ",");
        }
        Console.WriteLine(urlList[urlList.Count - 1] + "]");
    }
}

[DataContract]
public class User
{
    /// <summary>
    /// 編號
    /// </summary>
    [DataMember]
    public int UserId { get; set; }
    /// <summary>
    /// 用戶名
    /// </summary>
    [DataMember]
    public string UserName { get; set; }
    /// <summary>
    /// 建立時間
    /// </summary>
    [DataMember]
    [JsonConverter(typeof(IsoDateTimeConverter))]
    public DateTime CreateDate { get; set; }
    /// <summary>
    /// 生日
    /// </summary>
    [DataMember]
    [JsonConverter(typeof(JavaScriptDateTimeConverter))]
    public DateTime Birthday { get; set; }
    /// <summary>
    /// 相關URL
    /// </summary>
    [DataMember]
    public List<string> Urls { get; set; }
    /// <summary>
    /// 薪水
    /// </summary>
    [ScriptIgnore]//使用JavaScriptSerializer序列化時不序列化此字段
    [IgnoreDataMember]//使用DataContractJsonSerializer序列化時不序列化此字段
    [JsonIgnore]//使用JsonConvert序列化時不序列化此字段
    public int Salary { get; set; }
    /// <summary>
    /// 權利級別
    /// </summary>
    [DataMember]
    public Priority Priority { get; set; }

    public User()
    {
        Urls = new List<string>();
    }
}
/// <summary>
/// 權利級別
/// </summary>
public enum Priority:byte
{
    Lowest=0x1,
    BelowNormal=0x2,
    Normal=0x4,
    AboveNormal=0x8,
    Highest=0x16
}
}

程序的運行結果以下：
 

使用JavaScriptSerializer序列化後的結果：{"UserId":1,"UserName":"李剛","CreateDate":"\/Date(353521211984)\/","Birthday":"\/Date(-277630788015)\/","Urls":[],"Priority":22},長度：127
使用JavaScriptSerializer反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-15 16:20:11,Priority:Highest
使用DataContractJsonSerializer序列化後的結果：{"Birthday":"\/Date(-277630787953+0800)\/","CreateDate":"\/Date(353521212046+0800)\/","Priority":8,"Urls":[],"UserId":1,"UserName":"李剛"},長度：136
使用DataContractJsonSerializer反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-16 0:20:12,Priority:AboveNormal
使用JsonConvert序列化後的結果：{"UserId":1,"UserName":"李剛","CreateDate":"1981-03-16T00:20:12.1875+08:00","Birthday":new Date(-277630787812),"Urls":[],"Priority":2},長度：132
使用JsonConvert反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-16 0:20:12,Priority:BelowNormal
使用JsonConvert序列化後的結果：{"UserId":1,"UserName":"周公","CreateDate":"2003-03-16T00:20:12.40625+08:00","Birthday":new Date(290362812406),"Urls":["http://zhoufoxcn.blog.51cto.com","http://blog.csdn.net/zhoufoxcn"],"Priority":1},長度：198
使用Linq to JSON反序列化後的結果：["http://zhoufoxcn.blog.51cto.com","http://blog.csdn.net/zhoufoxcn"]

總結：經過上面的例子你們能夠看出Newtonsoft類庫提供的JSON序列化和反序列的方式更加靈活，在實際開發中周公也一直使用Newtonsoft做爲JSON序列化和反序列化的不二選擇。

周公
2011-03-16