在.NET使用JSON作為資料交換格式

qmdweb發表於2018-06-03
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類。
為了便於下面的演示，下面提供一個類的程式碼：

[c-sharp] view plain copy
  1. [DataContract]  
  2. public class User  
  3. {  
  4.     /// <summary>  
  5.     /// 編號  
  6.     /// </summary>  
  7.     [DataMember]  
  8.     public int UserId { get; set; }  
  9.     /// <summary>  
  10.     /// 使用者名稱  
  11.     /// </summary>  
  12.     [DataMember]  
  13.     public string UserName { get; set; }  
  14.     /// <summary>  
  15.     /// 建立時間  
  16.     /// </summary>  
  17.     [DataMember]  
  18.     [JsonConverter(typeof(IsoDateTimeConverter))]  
  19.     public DateTime CreateDate { get; set; }  
  20.     /// <summary>  
  21.     /// 生日  
  22.     /// </summary>  
  23.     [DataMember]  
  24.     [JsonConverter(typeof(JavaScriptDateTimeConverter))]  
  25.     public DateTime Birthday { get; set; }  
  26.     /// <summary>  
  27.     /// 相關URL  
  28.     /// </summary>  
  29.     [DataMember]  
  30.     public List<string> Urls { get; set; }  
  31.     /// <summary>  
  32.     /// 薪水  
  33.     /// </summary>  
  34.     //[ScriptIgnore]//使用JavaScriptSerializer序列化時不序列化此欄位  
  35.     //[IgnoreDataMember]//使用DataContractJsonSerializer序列化時不序列化此欄位  
  36.     //[JsonIgnore]//使用JsonConvert序列化時不序列化此欄位  
  37.     public int Salary { get; set; }  
  38.     /// <summary>  
  39.     /// 權利級別  
  40.     /// </summary>  
  41.     [DataMember]  
  42.     public Priority Priority { get; set; }  
  43.   
  44.     public User()  
  45.     {  
  46.         Urls = new List<string>();  
  47.     }  
  48. }  
  49. /// <summary>  
  50. /// 權利級別  
  51. /// </summary>  
  52. public enum Priority:byte  
  53. {  
  54.     Lowest=0x1,  
  55.     BelowNormal=0x2,  
  56.     Normal=0x4,  
  57.     AboveNormal=0x8,  
  58.     Highest=0x16  
  59. }  


使用System.Web.Script.Serialization.JavaScriptSerializer類
System.Web.Script.Serialization.JavaScriptSerializer類是.NET類庫中自帶的一種JSON序列化實現，在.NET Framework3.5及以後版本中可以使用這個類，這個類位於System.Web.Extensions.dll中，使用這個類是必須新增對這個dll的引用。
下面的程式碼是使用JavaScriptSerializer進行序列化和反序列化的例子：

[c-sharp] view plain copy
  1. public static void JavaScriptSerializerDemo()  
  2. {  
  3.     User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30),Birthday=DateTime.Now.AddYears(-50), Priority = Priority.Highest, Salary = 500000 };  
  4.     //JavaScriptSerializer類在System.Web.Extensions.dll中，注意新增這個引用  
  5.     JavaScriptSerializer serializer = new JavaScriptSerializer();  
  6.     //JSON序列化  
  7.     string result=serializer.Serialize(user);  
  8.     Console.WriteLine("使用JavaScriptSerializer序列化後的結果：{0},長度：{1}", result, result.Length);  
  9.     //JSON反序列化  
  10.     user = serializer.Deserialize<User>(result);  
  11.     Console.WriteLine("使用JavaScriptSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  12.   
  13. }  

說明：如果不想序列化某個欄位，可以在欄位前面加[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類的例子：

[c-sharp] view plain copy
  1. public static void DataContractJsonSerializerDemo()  
  2. {  
  3.     User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.AboveNormal, Salary = 50000 };  
  4.     string result = string.Empty;  
  5.     //DataContractJsonSerializer類在System.ServiceModel.Web.dll中，注意新增這個引用  
  6.     DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));  
  7.       
  8.     using (MemoryStream stream = new MemoryStream())  
  9.     {  
  10.         //JSON序列化  
  11.         serializer.WriteObject(stream, user);  
  12.         result = Encoding.UTF8.GetString(stream.ToArray());  
  13.         Console.WriteLine("使用DataContractJsonSerializer序列化後的結果：{0},長度：{1}", result, result.Length);  
  14.     }  
  15.   
  16.     //JSON反序列化  
  17.     byte[] buffer = Encoding.UTF8.GetBytes(result);  
  18.     using (MemoryStream stream = new MemoryStream(buffer))  
  19.     {  
  20.         user = serializer.ReadObject(stream) as User;  
  21.         Console.WriteLine("使用DataContractJsonSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  22.     }  
  23. }  

注意：要使用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類的例子：

[c-sharp] view plain copy
  1. public static void JsonConvertDemo()  
  2. {  
  3.     User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.BelowNormal, Salary = 5000 };  
  4.     //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並新增這個引用  
  5.     //JSON序列化  
  6.     string result = JsonConvert.SerializeObject(user);  
  7.     Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);  
  8.     //JSON反序列化  
  9.     user = JsonConvert.DeserializeObject<User>(result);  
  10.     Console.WriteLine("使用JsonConvert反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  11. }  
  12.   
  13. public static void JsonConvertLinqDemo()  
  14. {  
  15.     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" } };  
  16.     //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並新增這個引用  
  17.     //JSON序列化  
  18.     string result = JsonConvert.SerializeObject(user);  
  19.     Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);  
  20.     //使用Linq to JSON  
  21.     JObject jobject = JObject.Parse(result);  
  22.     JToken token = jobject["Urls"];  
  23.     List<string> urlList = new List<string>();  
  24.     foreach (JToken t in token)  
  25.     {  
  26.         urlList.Add(t.ToString());  
  27.     }  
  28.     Console.Write("使用Linq to JSON反序列化後的結果：[");  
  29.     for (int i = 0; i < urlList.Count - 1;i++ )  
  30.     {  
  31.         Console.Write(urlList[i] + ",");  
  32.     }  
  33.     Console.WriteLine(urlList[urlList.Count - 1] + "]");  
  34. }  

注意：如果有不需要序列化的欄位，可以給該欄位新增[JsonIgnore]標記。在Newtonsoft這個類庫中對於日期的序列化有多種方式，可以類的DataTime成員新增上對應的標記，這樣在進行序列化和反序列化時就會按照指定的方式進行，在本例中User類的CreateDate屬性新增的屬性是[JsonConverter(typeof(IsoDateTimeConverter))]，而Birthday屬性新增的屬性是[JsonConverter(typeof(JavaScriptDateTimeConverter))]，從序列化的結果可以看出來它們最終的表現形式並不一樣。
本文中所有的示例程式碼如下：
[c-sharp] view plain copy
  1. using System;  
  2. using System.Collections.Generic;  
  3. using System.Linq;  
  4. using System.Text;  
  5. using System.Web.Script.Serialization;  
  6. using System.Runtime.Serialization.Json;  
  7. using System.IO;  
  8. using System.Runtime.Serialization;  
  9. using Newtonsoft.Json;  
  10. using Newtonsoft.Json.Linq;  
  11. using Newtonsoft.Json.Converters;  
  12.   
  13. namespace JSONDemo  
  14. {  
  15. class Program  
  16. {  
  17.     static void Main(string[] args)  
  18.     {  
  19.         JavaScriptSerializerDemo();  
  20.         DataContractJsonSerializerDemo();  
  21.         JsonConvertDemo();  
  22.         JsonConvertLinqDemo();  
  23.         Console.ReadLine();  
  24.     }  
  25.   
  26.     public static void JavaScriptSerializerDemo()  
  27.     {  
  28.         User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30),Birthday=DateTime.Now.AddYears(-50), Priority = Priority.Highest, Salary = 500000 };  
  29.         //JavaScriptSerializer類在System.Web.Extensions.dll中，注意新增這個引用  
  30.         JavaScriptSerializer serializer = new JavaScriptSerializer();  
  31.         //JSON序列化  
  32.         string result=serializer.Serialize(user);  
  33.         Console.WriteLine("使用JavaScriptSerializer序列化後的結果：{0},長度：{1}", result, result.Length);  
  34.         //JSON反序列化  
  35.         user = serializer.Deserialize<User>(result);  
  36.         Console.WriteLine("使用JavaScriptSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  37.   
  38.     }  
  39.   
  40.     public static void DataContractJsonSerializerDemo()  
  41.     {  
  42.         User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.AboveNormal, Salary = 50000 };  
  43.         string result = string.Empty;  
  44.         //DataContractJsonSerializer類在System.ServiceModel.Web.dll中，注意新增這個引用  
  45.         DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));  
  46.           
  47.         using (MemoryStream stream = new MemoryStream())  
  48.         {  
  49.             //JSON序列化  
  50.             serializer.WriteObject(stream, user);  
  51.             result = Encoding.UTF8.GetString(stream.ToArray());  
  52.             Console.WriteLine("使用DataContractJsonSerializer序列化後的結果：{0},長度：{1}", result, result.Length);  
  53.         }  
  54.   
  55.         //JSON反序列化  
  56.         byte[] buffer = Encoding.UTF8.GetBytes(result);  
  57.         using (MemoryStream stream = new MemoryStream(buffer))  
  58.         {  
  59.             user = serializer.ReadObject(stream) as User;  
  60.             Console.WriteLine("使用DataContractJsonSerializer反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  61.         }  
  62.     }  
  63.   
  64.     public static void JsonConvertDemo()  
  65.     {  
  66.         User user = new User { UserId = 1, UserName = "李剛", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.BelowNormal, Salary = 5000 };  
  67.         //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並新增這個引用  
  68.         //JSON序列化  
  69.         string result = JsonConvert.SerializeObject(user);  
  70.         Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);  
  71.         //JSON反序列化  
  72.         user = JsonConvert.DeserializeObject<User>(result);  
  73.         Console.WriteLine("使用JsonConvert反序列化後的結果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);  
  74.     }  
  75.   
  76.     public static void JsonConvertLinqDemo()  
  77.     {  
  78.         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" } };  
  79.         //JsonConvert類在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下載這個dll並新增這個引用  
  80.         //JSON序列化  
  81.         string result = JsonConvert.SerializeObject(user);  
  82.         Console.WriteLine("使用JsonConvert序列化後的結果：{0},長度：{1}", result, result.Length);  
  83.         //使用Linq to JSON  
  84.         JObject jobject = JObject.Parse(result);  
  85.         JToken token = jobject["Urls"];  
  86.         List<string> urlList = new List<string>();  
  87.         foreach (JToken t in token)  
  88.         {  
  89.             urlList.Add(t.ToString());  
  90.         }  
  91.         Console.Write("使用Linq to JSON反序列化後的結果：[");  
  92.         for (int i = 0; i < urlList.Count - 1;i++ )  
  93.         {  
  94.             Console.Write(urlList[i] + ",");  
  95.         }  
  96.         Console.WriteLine(urlList[urlList.Count - 1] + "]");  
  97.     }  
  98. }  
  99.   
  100. [DataContract]  
  101. public class User  
  102. {  
  103.     /// <summary>  
  104.     /// 編號  
  105.     /// </summary>  
  106.     [DataMember]  
  107.     public int UserId { get; set; }  
  108.     /// <summary>  
  109.     /// 使用者名稱  
  110.     /// </summary>  
  111.     [DataMember]  
  112.     public string UserName { get; set; }  
  113.     /// <summary>  
  114.     /// 建立時間  
  115.     /// </summary>  
  116.     [DataMember]  
  117.     [JsonConverter(typeof(IsoDateTimeConverter))]  
  118.     public DateTime CreateDate { get; set; }  
  119.     /// <summary>  
  120.     /// 生日  
  121.     /// </summary>  
  122.     [DataMember]  
  123.     [JsonConverter(typeof(JavaScriptDateTimeConverter))]  
  124.     public DateTime Birthday { get; set; }  
  125.     /// <summary>  
  126.     /// 相關URL  
  127.     /// </summary>  
  128.     [DataMember]  
  129.     public List<string> Urls { get; set; }  
  130.     /// <summary>  
  131.     /// 薪水  
  132.     /// </summary>  
  133.     [ScriptIgnore]//使用JavaScriptSerializer序列化時不序列化此欄位  
  134.     [IgnoreDataMember]//使用DataContractJsonSerializer序列化時不序列化此欄位  
  135.     [JsonIgnore]//使用JsonConvert序列化時不序列化此欄位  
  136.     public int Salary { get; set; }  
  137.     /// <summary>  
  138.     /// 權利級別  
  139.     /// </summary>  
  140.     [DataMember]  
  141.     public Priority Priority { get; set; }  
  142.   
  143.     public User()  
  144.     {  
  145.         Urls = new List<string>();  
  146.     }  
  147. }  
  148. /// <summary>  
  149. /// 權利級別  
  150. /// </summary>  
  151. public enum Priority:byte  
  152. {  
  153.     Lowest=0x1,  
  154.     BelowNormal=0x2,  
  155.     Normal=0x4,  
  156.     AboveNormal=0x8,  
  157.     Highest=0x16  
  158. }  
  159. }  

程式的執行結果如下：

[xhtml] view plain copy
  1. 使用JavaScriptSerializer序列化後的結果：{"UserId":1,"UserName":"李剛","CreateDate":"//Date(353521211984)//","Birthday":"//Date(-277630788015)//","Urls":[],"Priority":22},長度：127  
  2. 使用JavaScriptSerializer反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-15 16:20:11,Priority:Highest  
  3. 使用DataContractJsonSerializer序列化後的結果：{"Birthday":"//Date(-277630787953+0800)//","CreateDate":"//Date(353521212046+0800)//","Priority":8,"Urls":[],"UserId":1,"UserName":"李剛"},長度：136  
  4. 使用DataContractJsonSerializer反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-16 0:20:12,Priority:AboveNormal  
  5. 使用JsonConvert序列化後的結果：{"UserId":1,"UserName":"李剛","CreateDate":"1981-03-16T00:20:12.1875+08:00","Birthday":new Date(-277630787812),"Urls":[],"Priority":2},長度：132  
  6. 使用JsonConvert反序列化後的結果：UserId:1,UserName:李剛,CreateDate:1981-3-16 0:20:12,Priority:BelowNormal  
  7. 使用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  
  8. 使用Linq to JSON反序列化後的結果：["http://zhoufoxcn.blog.51cto.com","http://blog.csdn.net/zhoufoxcn"]  

總結：通過上面的例子大家可以看出Newtonsoft類庫提供的JSON序列化和反序列的方式更加靈活，在實際開發中周公也一直使用Newtonsoft作為JSON序列化和反序列化的不二選擇。

相關文章