上一節講了 JSON.stringify() 的基本用法,這一節來挖深一點。它除了要序列化的對象,還能接兩個參數:第一個是過濾器(可以是陣列,也可以是函數),第二個是選項,用來控制輸出的縮進。單獨或組合使用,能相當精細地掌控序列化結果。
過濾器是陣列時,結果中只會包含陣列裡列出的屬性:
複製代碼 代碼如下:
<html>
<head>
<title></title>
<script type="text/javascript">
function init()
{
var student={
name:"Bill",
age:12,
grade:3,
id:"0802020114"
};
var jsonText=JSON.stringify(student,["name","id"]);
}
</script>
</head>
<body>
<input type="button" onclick="init()" value="測試" />
</body>
</html>
jsonText 的值為:
{"name":"Bill","id":"0802020114"}
若第二個參數是函數,行為就活潑多了。傳入的函數接收兩個參數:屬性(鍵)名與屬性值,根據鍵名決定如何處理。函數返回什麼,該鍵的值就是什麼;若返回 undefined,這個屬性會被直接忽略。
複製代碼 代碼如下:
<html>
<head>
<title></title>
<script type="text/javascript">
function init()
{
var student={
name:"Bill",
age:12,
grade:3,
id:"0802020114",
subject:["math","Chinese","English"]
};
var jsonText=JSON.stringify(student,jsonConvert);
}
function jsonConvert(key,value)
{
switch (key)
{
case "name":
return "Lily";
case "grade":
return undefined;
case "subject":
return value.join(",");
default :
return value;
}
}
</script>
</head>
<body>
<input type="button" onclick="init()" value="測試" />
</body>
</html>
這個過濾器按鍵決定結果:鍵為 name 就把值改成 Lily;鍵為 grade 就返回 undefined 刪掉該屬性;鍵為 subject(一個陣列)就用 join() 併成逗號字串。最後一定要留 default 分支,否則其他屬性會全部消失、結果出錯。
實際上,這個函數第一次被呼叫時,傳入的鍵是空字串,值就是 student 對象本身。上面的 jsonText 結果是:
{"name":"Lily","age":12,"id":"0802020114","subject":"math,Chinese,English"}
內部是按順序遍歷每個對象的每個屬性,所以過濾器函數必須且只能有 key、value 兩個參數才會生效。理解它的目的很重要:它給你一個在遍歷過程中修改部分結果的機會,而且是每個對象都要經過。
第三個參數控制縮進與空白。傳入數字時表示每層縮進的空格數:
複製代碼 代碼如下:
<html>
<head>
<title></title>
<script type="text/javascript">
function init()
{
var student={
name:"Bill",
age:12,
grade:3,
id:"0802020114",
subject:["math","Chinese","English"]
};
var jsonText=JSON.stringify(student,null,8);
}
</script>
</head>
<body>
<input type="button" onclick="init()" value="測試" />
</body>
</html>
jsonText 中的字串為:
複製代碼 代碼如下:
{
"name": "Bill",
"age": 12,
"grade": 3,
"id": "0802020114",
"subject": [
"math",
"Chinese",
"English"
]
}
stringify() 會在結果中插入換行符以提高可讀性——只縮進不換行意義不大。最大縮進空格數為 10,超過 10 的值都會自動按 10 處理。
如果第三個參數是字串而非數字,這個字串會被當作縮進字元(不再使用空格)。例如傳入 "*" 可實現:
複製代碼 代碼如下:
{
*"name": "Bill",
*"age": 12,
*"grade": 3,
*"id": "0802020114",
*"subject": [
**"math",
**"Chinese",
**"English"
*]
}
字串最長同樣不能超過 10 個字元,超出部分會被截掉。
有些時候上述手段仍不足以滿足自訂序列化的需求。這時可以在對象上定義 toJSON() 方法,讓它返回自己想要的 JSON 資料形式:
複製代碼 代碼如下:
<html>
<head>
<title></title>
<script type="text/javascript">
function init()
{
var student={
name:"Bill",
age:12,
grade:3,
id:"0802020114",
subject:["math","Chinese","English"],
toJSON:function(){
return this.name+"_"+this.id;
}
};
var jsonText=JSON.stringify(student);
}
</script>
</head>
<body>
<input type="button" onclick="init()" value="測試" />
</body>
</html>
jsonText 的值是:
"Bill_0802020114"
toJSON() 可以作為函數過濾器的補充,因此理解序列化的內部順序至關重要。把一個對象傳入 JSON.stringify() 後,順序是:
toJSON() 方法且能取得有效值,呼叫它;否則按預設順序執行序列化。值得一提的是,原生 Date 就自帶 toJSON(),這正是日期一序列化就變成 ISO 字串的原因。想改寫法,覆蓋它的 toJSON 即可。