JSON 格式
JSON 格式(JavaScript Object Notation 的縮寫)是一種用于數(shù)據(jù)交換的文本格式,2001年由 Douglas Crockford 提出挽霉,目的是取代繁瑣笨重的 XML 格式。
相比 XML 格式悼院,JSON 格式有兩個顯著的優(yōu)點:書寫簡單,一目了然咒循;符合 JavaScript 原生語法据途,可以由解釋引擎直接處理,不用另外添加解析代碼叙甸。所以颖医,JSON迅速被接受,已經(jīng)成為各大網(wǎng)站交換數(shù)據(jù)的標準格式裆蒸,并被寫入ECMAScript 5熔萧,成為標準的一部分。
簡單說光戈,每個 JSON 對象,就是一個值遂赠。要么是簡單類型的值久妆,要么是復合類型的值,但是只能是一個值跷睦,不能是兩個或更多的值筷弦。這就是說,每個 JSON 文檔只能包含一個值抑诸。
JSON 對值的類型和格式有嚴格的規(guī)定烂琴。
- 復合類型的值只能是數(shù)組或?qū)ο螅荒苁呛瘮?shù)蜕乡、正則表達式對象奸绷、日期對象。
- 簡單類型的值只有四種:字符串层玲、數(shù)值(必須以十進制表示)号醉、布爾值和
null
(不能使用NaN
,Infinity
,-Infinity
和undefined
)反症。
- 字符串必須使用雙引號表示,不能使用單引號畔派。
- 對象的鍵名必須放在雙引號里面铅碍。
- 數(shù)組或?qū)ο笞詈笠粋€成員的后面,不能加逗號线椰。
以下是合格的 JSON 值胞谈。
["one", "two", "three"]
{ "one": 1, "two": 2, "three": 3 }
{"names": ["張三", "李四"] }
[ { "name": "張三"}, {"name": "李四"} ]
以下是不合格的 JSON 值。
{ name: "張三", 'age': 32 } // 屬性名必須使用雙引號
[32, 64, 128, 0xFFF] // 不能使用十六進制值
{ "name": "張三", "age": undefined } // 不能使用undefined
{ "name": "張三",
"birthday": new Date('Fri, 26 Aug 2011 07:13:10 GMT'),
"getName": function() {
return this.name;
}
} // 不能使用函數(shù)和日期對象
需要注意的是憨愉,空數(shù)組和空對象都是合格的 JSON 值烦绳,null
本身也是一個合格的 JSON 值。
ES5 新增了JSON
對象莱衩,用來處理 JSON 格式數(shù)據(jù)爵嗅。它有兩個方法:JSON.stringify()
和JSON.parse()
。
JSON.stringify()
基本用法
JSON.stringify
方法用于將一個值轉為字符串笨蚁。該字符串符合 JSON 格式睹晒,并且可以被JSON.parse
方法還原。
JSON.stringify('abc') // ""abc""
JSON.stringify(1) // "1"
JSON.stringify(false) // "false"
JSON.stringify([]) // "[]"
JSON.stringify({}) // "{}"
JSON.stringify([1, "false", false])
// '[1,"false",false]'
JSON.stringify({ name: "張三" })
// '{"name":"張三"}'
上面代碼將各種類型的值括细,轉成 JSON 字符串伪很。
需要注意的是,對于原始類型的字符串奋单,轉換結果會帶雙引號锉试。
JSON.stringify('foo') === "foo" // false
JSON.stringify('foo') === "\"foo\"" // true
上面代碼中,字符串foo
览濒,被轉成了""foo""
呆盖。這是因為將來還原的時候,雙引號可以讓 JavaScript 引擎知道贷笛,foo
是一個字符串应又,而不是一個變量名。
如果原始對象中乏苦,有一個成員的值是undefined
株扛、函數(shù)或 XML 對象,這個成員會被過濾汇荐。
var obj = {
a: undefined,
b: function () {}
};
JSON.stringify(obj) // "{}"
上面代碼中洞就,對象obj
的a
屬性是undefined
,而b
屬性是一個函數(shù)掀淘,結果都被JSON.stringify
過濾旬蟋。
如果數(shù)組的成員是undefined
、函數(shù)或 XML 對象革娄,則這些值被轉成null
咖为。
var arr = [undefined, function () {}];
JSON.stringify(arr) // "[null,null]"
上面代碼中秕狰,數(shù)組arr
的成員是undefined
和函數(shù),它們都被轉成了null
躁染。
正則對象會被轉成空對象鸣哀。
JSON.stringify(/foo/) // "{}"
JSON.stringify
方法會忽略對象的不可遍歷屬性。
var obj = {};
Object.defineProperties(obj, {
'foo': {
value: 1,
enumerable: true
},
'bar': {
value: 2,
enumerable: false
}
});
JSON.stringify(obj); // "{"foo":1}"
上面代碼中吞彤,bar
是obj
對象的不可遍歷屬性我衬,JSON.stringify
方法會忽略這個屬性。
第二個參數(shù)
JSON.stringify
方法還可以接受一個數(shù)組饰恕,作為第二個參數(shù)挠羔,指定需要轉成字符串的屬性。
var obj = {
'prop1': 'value1',
'prop2': 'value2',
'prop3': 'value3'
};
var selectedProperties = ['prop1', 'prop2'];
JSON.stringify(obj, selectedProperties)
// "{"prop1":"value1","prop2":"value2"}"
上面代碼中埋嵌,JSON.stringify
方法的第二個參數(shù)指定破加,只轉prop1
和prop2
兩個屬性。
這個類似“白名單”的數(shù)組雹嗦,只對對象的屬性有效范舀,對數(shù)組無效。
JSON.stringify(['a', 'b'], ['0'])
// "["a","b"]"
JSON.stringify({0: 'a', 1: 'b'}, ['0'])
// "{"0":"a"}"
上面代碼中了罪,第二個參數(shù)指定JSON格式只轉0
號屬性锭环,實際上對數(shù)組是無效的,只對對象有效泊藕。
第二個參數(shù)還可以是一個函數(shù)辅辩,用來更改JSON.stringify
的默認行為。
function f(key, value) {
if (typeof value === "number") {
value = 2 * value;
}
return value;
}
JSON.stringify({ a: 1, b: 2 }, f)
// '{"a": 2,"b": 4}'
上面代碼中的f
函數(shù)娃圆,接受兩個參數(shù)玫锋,分別是被轉換的對象的鍵名和鍵值。如果鍵值是數(shù)值讼呢,就將它乘以2
撩鹿,否則就原樣返回。
注意吝岭,這個處理函數(shù)是遞歸處理所有的鍵三痰。
var o = {a: {b: 1}};
function f(key, value) {
console.log("["+ key +"]:" + value);
return value;
}
JSON.stringify(o, f)
// []:[object Object]
// [a]:[object Object]
// [b]:1
// '{"a":{"b":1}}'
上面代碼中吧寺,對象o
一共會被f
函數(shù)處理三次窜管。第一次鍵名為空喧枷,鍵值是整個對象o
界斜;第二次鍵名為a
,鍵值是{b: 1}
虑粥;第三次鍵名為b
赖条,鍵值為1失乾。
遞歸處理中常熙,每一次處理的對象,都是前一次返回的值碱茁。
var o = {a: 1};
function f(key, value) {
if (typeof value === 'object') {
return {b: 2};
}
return value * 2;
}
JSON.stringify(o,f)
// "{"b": 4}"
上面代碼中裸卫,f
函數(shù)修改了對象o
,接著JSON.stringify
方法就遞歸處理修改后的對象o
纽竣。
如果處理函數(shù)返回undefined
或沒有返回值墓贿,則該屬性會被忽略。
function f(key, value) {
if (typeof(value) === "string") {
return undefined;
}
return value;
}
JSON.stringify({ a: "abc", b: 123 }, f)
// '{"b": 123}'
上面代碼中蜓氨,a
屬性經(jīng)過處理后聋袋,返回undefined
,于是該屬性被忽略了穴吹。
第三個參數(shù)
JSON.stringify
還可以接受第三個參數(shù)幽勒,用于增加返回的JSON字符串的可讀性。如果是數(shù)字港令,表示每個屬性前面添加的空格(最多不超過10個)啥容;如果是字符串(不超過10個字符),則該字符串會添加在每行前面缠借。
JSON.stringify({ p1: 1, p2: 2 }, null, 2);
/*
"{
"p1": 1,
"p2": 2
}"
*/
JSON.stringify({ p1:1, p2:2 }, null, '|-');
/*
"{
|-"p1": 1,
|-"p2": 2
}"
*/
toJSON 方法
如果對象有自定義的toJSON
方法干毅,那么JSON.stringify
會使用這個方法的返回值作為參數(shù),而忽略原對象的其他屬性泼返。
下面是一個普通的對象硝逢。
var user = {
firstName: '三',
lastName: '張',
get fullName(){
return this.lastName + this.firstName;
}
};
JSON.stringify(user)
// "{"firstName":"三","lastName":"張","fullName":"張三"}"
現(xiàn)在,為這個對象加上toJSON
方法绅喉。
var user = {
firstName: '三',
lastName: '張',
get fullName(){
return this.lastName + this.firstName;
},
toJSON: function () {
var data = {
firstName: this.firstName,
lastName: this.lastName
};
return data;
}
};
JSON.stringify(user)
// "{"firstName":"三","lastName":"張"}"
上面代碼中渠鸽,JSON.stringify
發(fā)現(xiàn)參數(shù)對象有toJSON
方法,就直接使用這個方法的返回值作為參數(shù)柴罐,而忽略原對象的其他參數(shù)徽缚。
Date
對象就有一個自己的toJSON
方法。
var date = new Date('2015-01-01');
date.toJSON() // "2015-01-01T00:00:00.000Z"
JSON.stringify(date) // ""2015-01-01T00:00:00.000Z""
上面代碼中革屠,JSON.stringify
發(fā)現(xiàn)處理的是Date
對象實例凿试,就會調(diào)用這個實例對象的toJSON
方法,將該方法的返回值作為參數(shù)似芝。
toJSON
方法的一個應用是那婉,將正則對象自動轉為字符串。因為JSON.stringify
默認不能轉換正則對象党瓮,但是設置了toJSON
方法以后详炬,就可以轉換正則對象了。
var obj = {
reg: /foo/
};
// 不設置 toJSON 方法時
JSON.stringify(obj) // "{"reg":{}}"
// 設置 toJSON 方法時
RegExp.prototype.toJSON = RegExp.prototype.toString;
JSON.stringify(/foo/) // ""/foo/""
上面代碼在正則對象的原型上面部署了toJSON
方法寞奸,將其指向toString
方法呛谜,因此遇到轉換成JSON
時在跳,正則對象就先調(diào)用toJSON
方法轉為字符串,然后再被JSON.stingify
方法處理隐岛。
JSON.parse()
JSON.parse
方法用于將JSON字符串轉化成對象猫妙。
JSON.parse('{}') // {}
JSON.parse('true') // true
JSON.parse('"foo"') // "foo"
JSON.parse('[1, 5, "false"]') // [1, 5, "false"]
JSON.parse('null') // null
var o = JSON.parse('{"name": "張三"}');
o.name // 張三
如果傳入的字符串不是有效的JSON格式,JSON.parse
方法將報錯聚凹。
JSON.parse("'String'") // illegal single quotes
// SyntaxError: Unexpected token ILLEGAL
上面代碼中吐咳,雙引號字符串中是一個單引號字符串,因為單引號字符串不符合JSON格式元践,所以報錯韭脊。
為了處理解析錯誤,可以將JSON.parse
方法放在try...catch
代碼塊中单旁。
JSON.parse
方法可以接受一個處理函數(shù)沪羔,用法與JSON.stringify
方法類似。
function f(key, value) {
if (key === ''){
return value;
}
if (key === 'a') {
return value + 10;
}
}
var o = JSON.parse('{"a":1,"b":2}', f);
o.a // 11
o.b // undefined
參考鏈接
- MDN, Using native JSON
- MDN, JSON.parse
- Dr. Axel Rauschmayer, JavaScript’s JSON API
- Jim Cowart, What You Might Not Know About JSON.stringify()
- Marco Rogers polotek, What is JSON?