在.NET使用JSON作为数据交换格式【转】

http://www.cnblogs.com/zhoufoxcn/archive/2011/03/16/2515611.html

我们知道在.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类。
为了便于下面的演示，下面提供一个类的代码：

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. public User()
44. {
45. Urls = new List<string>();
46. }
47. }
48. /// <summary>
49. /// 权利级别
50. /// </summary>
51. public enum Priority:byte
52. {
53. Lowest=0x1,
54. BelowNormal=0x2,
55. Normal=0x4,
56. AboveNormal=0x8,
57. Highest=0x16
58. }

使用System.Web.Script.Serialization.JavaScriptSerializer类
System.Web.Script.Serialization.JavaScriptSerializer
类是.NET类库中自带的一种JSON序列化实现，在.NET
Framework3.5及以后版本中可以使用这个类，这个类位于System.Web.Extensions.dll中，使用这个类是必须添加对这个
dll的引用。
下面的代码是使用JavaScriptSerializer进行序列化和反序列化的例子：

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. }

说明：如果不想序列化某个字段，可以在字段前面加[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类的例子：

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. using (MemoryStream stream = new MemoryStream())
8. {
9. //JSON序列化
10. serializer.WriteObject(stream, user);
11. result = Encoding.UTF8.GetString(stream.ToArray());
12. Console.WriteLine("使用DataContractJsonSerializer序列化后的结果：{0},长度：{1}", result, result.Length);
13. }
14. //JSON反序列化
15. byte[] buffer = Encoding.UTF8.GetBytes(result);
16. using (MemoryStream stream = new MemoryStream(buffer))
17. {
18. user = serializer.ReadObject(stream) as User;
19. Console.WriteLine("使用DataContractJsonSerializer反序列化后的结果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
20. }
21. }

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

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. public static void JsonConvertLinqDemo()
13. {
14. 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" } };
15. //JsonConvert类在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下载这个dll并添加这个引用
16. //JSON序列化
17. string result = JsonConvert.SerializeObject(user);
18. Console.WriteLine("使用JsonConvert序列化后的结果：{0},长度：{1}", result, result.Length);
19. //使用Linq to JSON
20. JObject jobject = JObject.Parse(result);
21. JToken token = jobject["Urls"];
22. List<string> urlList = new List<string>();
23. foreach (JToken t in token)
24. {
25. urlList.Add(t.ToString());
26. }
27. Console.Write("使用Linq to JSON反序列化后的结果：[");
28. for (int i = 0; i < urlList.Count - 1;i++ )
29. {
30. Console.Write(urlList[i] + ",");
31. }
32. Console.WriteLine(urlList[urlList.Count - 1] + "]");
33. }

注
意：如果有不需要序列化的字段，可以给该字段添加[JsonIgnore]标记。在Newtonsoft这个类库中对于日期的序列化有多种方式，可以类的
DataTime成员添加上对应的标记，这样在进行序列化和反序列化时就会按照指定的方式进行，在本例中User类的CreateDate属性添加的属性
是[JsonConverter(typeof(IsoDateTimeConverter))]，而Birthday属性添加的属性是
[JsonConverter(typeof(JavaScriptDateTimeConverter))]，从序列化的结果可以看出来它们最终的表现
形式并不一样。
本文中所有的示例代码如下：

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. namespace JSONDemo
13. {
14. class Program
15. {
16. static void Main(string[] args)
17. {
18. JavaScriptSerializerDemo();
19. DataContractJsonSerializerDemo();
20. JsonConvertDemo();
21. JsonConvertLinqDemo();
22. Console.ReadLine();
23. }
24. public static void JavaScriptSerializerDemo()
25. {
26. User user = new User { UserId = 1, UserName = "李刚", CreateDate = DateTime.Now.AddYears(-30),Birthday=DateTime.Now.AddYears(-50), Priority = Priority.Highest, Salary = 500000 };
27. //JavaScriptSerializer类在System.Web.Extensions.dll中，注意添加这个引用
28. JavaScriptSerializer serializer = new JavaScriptSerializer();
29. //JSON序列化
30. string result=serializer.Serialize(user);
31. Console.WriteLine("使用JavaScriptSerializer序列化后的结果：{0},长度：{1}", result, result.Length);
32. //JSON反序列化
33. user = serializer.Deserialize<User>(result);
34. Console.WriteLine("使用JavaScriptSerializer反序列化后的结果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
35. }
36. public static void DataContractJsonSerializerDemo()
37. {
38. User user = new User { UserId = 1, UserName = "李刚", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.AboveNormal, Salary = 50000 };
39. string result = string.Empty;
40. //DataContractJsonSerializer类在System.ServiceModel.Web.dll中，注意添加这个引用
41. DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(User));
42. using (MemoryStream stream = new MemoryStream())
43. {
44. //JSON序列化
45. serializer.WriteObject(stream, user);
46. result = Encoding.UTF8.GetString(stream.ToArray());
47. Console.WriteLine("使用DataContractJsonSerializer序列化后的结果：{0},长度：{1}", result, result.Length);
48. }
49. //JSON反序列化
50. byte[] buffer = Encoding.UTF8.GetBytes(result);
51. using (MemoryStream stream = new MemoryStream(buffer))
52. {
53. user = serializer.ReadObject(stream) as User;
54. Console.WriteLine("使用DataContractJsonSerializer反序列化后的结果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
55. }
56. }
57. public static void JsonConvertDemo()
58. {
59. User user = new User { UserId = 1, UserName = "李刚", CreateDate = DateTime.Now.AddYears(-30), Birthday = DateTime.Now.AddYears(-50), Priority = Priority.BelowNormal, Salary = 5000 };
60. //JsonConvert类在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下载这个dll并添加这个引用
61. //JSON序列化
62. string result = JsonConvert.SerializeObject(user);
63. Console.WriteLine("使用JsonConvert序列化后的结果：{0},长度：{1}", result, result.Length);
64. //JSON反序列化
65. user = JsonConvert.DeserializeObject<User>(result);
66. Console.WriteLine("使用JsonConvert反序列化后的结果：UserId:{0},UserName:{1},CreateDate:{2},Priority:{3}", user.UserId, user.UserName, user.CreateDate, user.Priority);
67. }
68. public static void JsonConvertLinqDemo()
69. {
70. 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" } };
71. //JsonConvert类在Newtonsoft.Json.Net35.dll中，注意到http://www.codeplex.com/json/下载这个dll并添加这个引用
72. //JSON序列化
73. string result = JsonConvert.SerializeObject(user);
74. Console.WriteLine("使用JsonConvert序列化后的结果：{0},长度：{1}", result, result.Length);
75. //使用Linq to JSON
76. JObject jobject = JObject.Parse(result);
77. JToken token = jobject["Urls"];
78. List<string> urlList = new List<string>();
79. foreach (JToken t in token)
80. {
81. urlList.Add(t.ToString());
82. }
83. Console.Write("使用Linq to JSON反序列化后的结果：[");
84. for (int i = 0; i < urlList.Count - 1;i++ )
85. {
86. Console.Write(urlList[i] + ",");
87. }
88. Console.WriteLine(urlList[urlList.Count - 1] + "]");
89. }
90. }
91. [DataContract]
92. public class User
93. {
94. /// <summary>
95. /// 编号
96. /// </summary>
97. [DataMember]
98. public int UserId { get; set; }
99. /// <summary>
100. /// 用户名
101. /// </summary>
102. [DataMember]
103. public string UserName { get; set; }
104. /// <summary>
105. /// 创建时间
106. /// </summary>
107. [DataMember]
108. [JsonConverter(typeof(IsoDateTimeConverter))]
109. public DateTime CreateDate { get; set; }
110. /// <summary>
111. /// 生日
112. /// </summary>
113. [DataMember]
114. [JsonConverter(typeof(JavaScriptDateTimeConverter))]
115. public DateTime Birthday { get; set; }
116. /// <summary>
117. /// 相关URL
118. /// </summary>
119. [DataMember]
120. public List<string> Urls { get; set; }
121. /// <summary>
122. /// 薪水
123. /// </summary>
124. [ScriptIgnore]//使用JavaScriptSerializer序列化时不序列化此字段
125. [IgnoreDataMember]//使用DataContractJsonSerializer序列化时不序列化此字段
126. [JsonIgnore]//使用JsonConvert序列化时不序列化此字段
127. public int Salary { get; set; }
128. /// <summary>
129. /// 权利级别
130. /// </summary>
131. [DataMember]
132. public Priority Priority { get; set; }
133. public User()
134. {
135. Urls = new List<string>();
136. }
137. }
138. /// <summary>
139. /// 权利级别
140. /// </summary>
141. public enum Priority:byte
142. {
143. Lowest=0x1,
144. BelowNormal=0x2,
145. Normal=0x4,
146. AboveNormal=0x8,
147. Highest=0x16
148. }
149. }

程序的运行结果如下：

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序列化和反序列化的不二选择。