最近在研究 JSON 字串,手上的資料內容大多已是 JSON 格式,於是動手寫一個把物件格式化為 JSON 的小工具,做法有點像自訂的 ToString()。網上找了一下,發現現成方案還不少。
第一版實作用的是 JavaScriptSerializer:
using System;
using System.Web.Script.Serialization;
namespace Demo
{
/// <summary>
/// JSON 幫助類
/// </summary>
public static class JSONHelper
{
/// <summary>
/// 格式化成 JSON 字串
/// </summary>
/// <param name="obj">需要格式化的物件</param>
/// <returns>JSON 字串</returns>
public static string ToJSON(object obj)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
return serializer.Serialize(obj);
}
/// <summary>
/// 格式化成 JSON 字串
/// </summary>
/// <param name="obj">需要格式化的物件</param>
/// <param name="recursionDepth">指定序列化的深度</param>
/// <returns>JSON 字串</returns>
public static string ToJSON(object obj, int recursionDepth)
{
JavaScriptSerializer serializer = new JavaScriptSerializer();
serializer.RecursionLimit = recursionDepth;
return serializer.Serialize(obj);
}
}
}
一字不漏照打,編譯確實通過,但出現了兩個警告。我寫程式一向盡量把警告數壓到最低,於是去查這兩個警告到底在說什麼。
警告內容是:「System.Web.Script.Serialization.JavaScriptSerializer.JavaScriptSerializer() 已過時:建議的替代方案為 System.Runtime.Serialization.DataContractJsonSerializer」。以前學 JSON 時用 AppSettings 也遇過類似警告,最後改用 ConfigurationManager 就清掉了,心想這次應該也差不多。
於是上 MSDN 查,沒弄明白;再翻 CSDN,還是沒弄明白;最後求助搜尋引擎,折騰半天仍不得其解。改用 DataContractJsonSerializer 又缺 System.Runtime.Serialization 的引用,把引用加上,編譯依然不通過。
幸運的是最後找到一份改用 DataContractJsonSerializer 的範例,總算搞清楚了。關鍵有兩點:一是要引用的組件不只一個,二是命名空間寫法有講究。正確的 using 宣告如下:
using System; using System.IO; using System.Runtime.Serialization.Json;
也就是說,除了 System.Runtime.Serialization.dll,還需要加入 System.ServiceModel.Web.dll 的引用;而因為實作時會用到 Stream 等型別,System.IO 與 System.Runtime.Serialization.Json 這兩個命名空間都得補上。
這個小插曲的教訓是:升級框架時產生的「已過時」警告不能只憑直覺換掉 API 就了事,替代方案往往牽涉到不同的組件依賴與命名空間,得把引用一次補齊。