JavaScriptSerializer 這個類別原本是用在 .NET 的 AJAX 非同步通信層內部,負責序列化與反序列化在瀏覽器與 Web 伺服器之間傳遞的資料。對我們的實際價值在於:它能直接把一個 C# 物件丟到前端變成 JavaScript 物件。使用前需加入 System.Web.Extensions.dll 的參考,類別位於 System.Web.Script.Serialization 命名空間下。
主要屬性
MaxJsonLength:接受的 JSON 字串最大長度。
RecursionLimit:限制要處理的物件階層數目。
主要方法
Serialize:把物件轉成 JSON 字串。
Deserialize<T>:把 JSON 字串轉成 T 型別的物件。
DeserializeObject:把 JSON 字串轉成物件圖。
ConvertToType<T>:把指定物件轉為目標型別。
RegisterConverters:註冊自訂轉換器。
基本用法:Serialize 與 Deserialize
public class HomeController : Controller {
public ActionResult Index() { return View(); }
public ActionResult GetJson() {
JavaScriptSerializer jss = new JavaScriptSerializer();
Person p = new Person(1, "張飛", 20);
string json = jss.Serialize(p); // 序列化成 JSON
// 反序列化回 Person;注意目標類別必須有無參數建構式
Person p1 = jss.Deserialize<Person>(json);
// 直接回傳字串的話,前端還要再解析一次
// return Json(json, "text/json");
// 這樣寫前端拿到的就是現成的 JavaScript 物件
return Json(new { Id = p1.Id, Name = p1.Name, Age = p1.Age }, "text/json");
}
}
public class Person {
public Person() { }
public Person(int id, string name, int age) {
this.Id = id; this.Name = name; this.Age = age;
}
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
}
前端:
<html>
<head>
<title>javascriptSerializer 類別測試</title>
<script src="/jQuery.1.8.3.js" type="text/javascript"></script>
<script type="text/javascript">
$(function () {
$(":button").click(function () {
$.ajax({
url: "/Home/GetJson",
dataType: "json",
type: "post",
success: function (response) {
// 若後端回的是字串,才需要先解析:
// var data = JSON.parse(response);
$("#Id").text(response.Id);
$("#Name").text(response.Name);
$("#Age").text(response.Age);
}
})
})
})
</script>
</head>
<body>
<ul>
<li id="Id"></li>
<li id="Name"></li>
<li id="Age"></li>
</ul>
<input type="button" value="確認" />
</body>
</html>
把四個方法與屬性實際跑一遍
JavaScriptSerializer jss = new JavaScriptSerializer();
Console.WriteLine(jss.MaxJsonLength); // 2097152,預設上限
// 把上限調到 1,序列化時就會丟出例外:
// 「使用 JSON JavaScriptSerializer 進行序列化或反序列化時出錯。字串的長度超過了為 maxJsonLength 屬性設置的值。」
jss.MaxJsonLength = 1;
Person p = new Person(1, "關羽", 21);
// string json = jss.Serialize(p); // ← 這行會爆
jss.MaxJsonLength = 2097152;
// 序列化
string json = jss.Serialize(p);
Console.WriteLine(json); // {"Id":1,"Name":"關羽","Age":21}
// 泛型版反序列化
Person p2 = jss.Deserialize<Person>("{\"Id\":1,\"Name\":\"關羽\",\"Age\":21}");
Console.WriteLine(p2.Id + " " + p2.Name + " " + p2.Age); // 1 關羽 21
// 非泛型版:回傳的是 object,必須手動轉型
Person p3 = jss.Deserialize("{\"Id\":1,\"Name\":\"關羽\",\"Age\":21}", typeof(Person)) as Person;
Console.WriteLine(p3.Id + " " + p3.Name + " " + p3.Age);
// DeserializeObject 轉出來的是 Dictionary,直接 as Person 會得到 null
object obj = jss.DeserializeObject("{\"Id\":1,\"Name\":\"關羽\",\"Age\":21}");
// Person p4 = obj as Person; // ← p4 是 null
Person p4 = jss.ConvertToType<Person>(obj); // 這才是正確用法
Console.WriteLine(p4.Name); // 關羽
// 非泛型版本
Person p5 = jss.ConvertToType(obj, typeof(Person)) as Person;
Console.WriteLine(p5.Name); // 關羽
自訂轉換器:解決循環引用
Serialize 是遞迴的,會逐一序列化物件的屬性。因此遇到 DataTable 這類結構複雜的型別,常會出現「循環引用」例外,這時候就需要自己寫一個轉換器。所有自訂轉換器都要繼承 JavaScriptConverter,實作 Serialize、Deserialize 與 SupportedTypes。
DataTable dt = new DataTable();
dt.Columns.Add("Id"); dt.Columns.Add("Name"); dt.Columns.Add("Age");
dt.Rows.Add(1, "關羽", 21);
dt.Rows.Add(2, "劉備", 22);
dt.Rows.Add(3, "張飛", 20);
JavaScriptSerializer jss = new JavaScriptSerializer();
// 除了實作,還必須註冊到 serializer 上
jss.RegisterConverters(new JavaScriptConverter[] { new DataTableConverter() });
string strJson = jss.Serialize(dt);
// {"Rows":[{"Id":"1","Name":"關羽","Age":"21"},{"Id":"2","Name":"劉備","Age":"22"},{"Id":"3","Name":"張飛","Age":"20"}]}
Console.WriteLine(strJson);
/// <summary>
/// DataTable 的 JSON 轉換類別
/// </summary>
public class DataTableConverter : JavaScriptConverter {
public override IDictionary<string, object> Serialize(object obj, JavaScriptSerializer serializer) {
DataTable dt = obj as DataTable;
Dictionary<string, object> result = new Dictionary<string, object>();
List<Dictionary<string, object>> rows = new List<Dictionary<string, object>>();
foreach (DataRow dr in dt.Rows) {
Dictionary<string, object> row = new Dictionary<string, object>();
foreach (DataColumn dc in dt.Columns) {
row.Add(dc.ColumnName, dr[dc.ColumnName]);
}
rows.Add(row);
}
result["Rows"] = rows;
return result;
}
public override object Deserialize(IDictionary<string, object> dictionary,
Type type, JavaScriptSerializer serializer) {
throw new NotImplementedException();
}
/// <summary>
/// 本轉換器支援的型別
/// </summary>
public override IEnumerable<Type> SupportedTypes {
get { return new Type[] { typeof(DataTable) }; }
}
}
限制序列化階層
JavaScriptSerializer jss = new JavaScriptSerializer();
Console.WriteLine(jss.RecursionLimit); // 預設 100
Person p1 = new Person(1, "劉備", 24);
p1.p = new Person(2, "關羽", 23);
p1.p.p = new Person(3, "張飛", 21);
string strJson = jss.Serialize(p1);
// {"Id":1,"Name":"劉備","Age":24,"p":{"Id":2,"Name":"關羽","Age":23,"p":{"Id":3,"Name":"張飛","Age":21,"p":null}}}
Console.WriteLine(strJson);
jss.RecursionLimit = 1;
// string strJson2 = jss.Serialize(p1); // ← 超出 RecursionLimit,會丟出例外
[ScriptIgnore]:排除特定屬性
有些屬性不希望被序列化(例如密碼、內部暫存資料),在屬性上加上這個特性即可:
JavaScriptSerializer jss = new JavaScriptSerializer();
Person p = new Person(1, "劉備", 24);
Console.WriteLine(jss.Serialize(p)); // {"Id":1,"Age":24}
File.WriteAllText(@"D:\123.txt", jss.Serialize(p));
public class Person {
public Person() { }
public Person(int id, string name, int age) {
this.Id = id; this.Name = name; this.Age = age;
}
public int Id { get; set; }
[ScriptIgnore]
public string Name { get; set; }
public int Age { get; set; }
public Person p { get; set; }
}
實務選擇建議
在 .NET Framework 的 MVC 專案裡,Json() 底層用的就是這個序列化器,所以多數時候你不需要直接 new 它。真正需要自己動手的是兩種情況:想控制序列化結果(用 [ScriptIgnore] 或自訂轉換器),以及在非 Controller 環境(例如 Console 程式、背景服務)需要手動轉換時。
如果是 .NET Core 之後的專案,預設已經換成 System.Text.Json,對應的寫法是 JsonSerializer.Serialize 與 [JsonIgnore],觀念一致但 API 不同,遷移時要留意。
以上就是 JavaScriptSerializer 的屬性、方法、自訂轉換器與階層限制的整理,需要的朋友可以搭配範例一起實作。