JSON 对象

JSON 格式

JSON 格式（JavaScript Object Notation 的缩写）是一种用于数据交换的文本格式，2001年由 Douglas Crockford 提出，目的是取代繁琐笨重的 XML 格式。

相比 XML 格式，JSON 格式有两个显著的优点：书写简单，一目了然；符合 JavaScript 原生语法，可以由解释引擎直接处理，不用另外添加解析代码。所以，JSON 迅速被接受，已经成为各大网站交换数据的标准格式，并被写入标准。

每个 JSON 对象就是一个值，可能是一个数组或对象，也可能是一个原始类型的值。总之，只能是一个值，不能是两个或更多的值。

JSON 对值的类型和格式有严格的规定。

  1. 复合类型的值只能是数组或对象，不能是函数、正则表达式对象、日期对象。

  2. 原始类型的值只有四种：字符串、数值（必须以十进制表示）、布尔值和null（不能使用NaN, Infinity, -Infinity和undefined）。

  3. 字符串必须使用双引号表示，不能使用单引号。

  4. 对象的键名必须放在双引号里面。

  5. 数组或对象最后一个成员的后面，不能加逗号。

以下都是合法的 JSON。

  1. ["one", "two", "three"]
  3. { "one": 1, "two": 2, "three": 3 }
  5. {"names": ["张三", "李四"] }
  7. [ { "name": "张三"}, {"name": "李四"} ]

以下都是不合法的 JSON。

  1. { name: "张三", 'age': 32 }  // 属性名必须使用双引号
  3. [32, 64, 128, 0xFFF] // 不能使用十六进制值
  5. { "name": "张三", "age": undefined } // 不能使用 undefined
  7. { "name": "张三",
  8.   "birthday": new Date('Fri, 26 Aug 2011 07:13:10 GMT'),
  9.   "getName": function () {
  10.       return this.name;
  11.   }
  12. } // 属性值不能使用函数和日期对象

注意，null、空数组和空对象都是合法的 JSON 值。

JSON 对象

JSON对象是 JavaScript 的原生对象，用来处理 JSON 格式数据。它有两个静态方法：JSON.stringify()和JSON.parse()。

JSON.stringify()

基本用法

JSON.stringify方法用于将一个值转为 JSON 字符串。该字符串符合 JSON 格式，并且可以被JSON.parse方法还原。

  1. JSON.stringify('abc') // ""abc""
  2. JSON.stringify(1) // "1"
  3. JSON.stringify(false) // "false"
  4. JSON.stringify([]) // "[]"
  5. JSON.stringify({}) // "{}"
  7. JSON.stringify([1, "false", false])
  8. // '[1,"false",false]'
  10. JSON.stringify({ name: "张三" })
  11. // '{"name":"张三"}'

上面代码将各种类型的值，转成 JSON 字符串。

注意，对于原始类型的字符串，转换结果会带双引号。

  1. JSON.stringify('foo') === "foo" // false
  2. JSON.stringify('foo') === "\"foo\"" // true

上面代码中，字符串foo，被转成了"\"foo\""。这是因为将来还原的时候，内层双引号可以让 JavaScript 引擎知道，这是一个字符串，而不是其他类型的值。

  1. JSON.stringify(false) // "false"
  2. JSON.stringify('false') // "\"false\""

上面代码中，如果不是内层的双引号，将来还原的时候，引擎就无法知道原始值是布尔值还是字符串。

如果对象的属性是undefined、函数或 XML 对象，该属性会被JSON.stringify过滤。

  1. var obj = {
  2.   a: undefined,
  3.   b: function () {}
  4. };
  6. JSON.stringify(obj) // "{}"

上面代码中，对象obj的a属性是undefined，而b属性是一个函数，结果都被JSON.stringify过滤。

如果数组的成员是undefined、函数或 XML 对象，则这些值被转成null。

  1. var arr = [undefined, function () {}];
  2. JSON.stringify(arr) // "[null,null]"

上面代码中，数组arr的成员是undefined和函数，它们都被转成了null。

正则对象会被转成空对象。

  1. JSON.stringify(/foo/) // "{}"

JSON.stringify方法会忽略对象的不可遍历的属性。

  1. var obj = {};
  2. Object.defineProperties(obj, {
  3.   'foo': {
  4.     value: 1,
  5.     enumerable: true
  6.   },
  7.   'bar': {
  8.     value: 2,
  9.     enumerable: false
  10.   }
  11. });
  13. JSON.stringify(obj); // "{"foo":1}"

上面代码中，bar是obj对象的不可遍历属性，JSON.stringify方法会忽略这个属性。

第二个参数

JSON.stringify方法还可以接受一个数组，作为第二个参数，指定需要转成字符串的属性。

  1. var obj = {
  2.   'prop1': 'value1',
  3.   'prop2': 'value2',
  4.   'prop3': 'value3'
  5. };
  7. var selectedProperties = ['prop1', 'prop2'];
  9. JSON.stringify(obj, selectedProperties)
  10. // "{"prop1":"value1","prop2":"value2"}"

上面代码中，JSON.stringify方法的第二个参数指定，只转prop1和prop2两个属性。

这个类似白名单的数组，只对对象的属性有效，对数组无效。

  1. JSON.stringify(['a', 'b'], ['0'])
  2. // "["a","b"]"
  4. JSON.stringify({0: 'a', 1: 'b'}, ['0'])
  5. // "{"0":"a"}"

上面代码中，第二个参数指定 JSON 格式只转0号属性，实际上对数组是无效的，只对对象有效。

第二个参数还可以是一个函数，用来更改JSON.stringify的返回值。

  1. function f(key, value) {
  2.   if (typeof value === "number") {
  3.     value = 2 * value;
  4.   }
  5.   return value;
  6. }
  8. JSON.stringify({ a: 1, b: 2 }, f)
  9. // '{"a": 2,"b": 4}'

上面代码中的f函数，接受两个参数，分别是被转换的对象的键名和键值。如果键值是数值，就将它乘以2，否则就原样返回。

注意，这个处理函数是递归处理所有的键。

  1. var o = {a: {b: 1}};
  3. function f(key, value) {
  4.   console.log("["+ key +"]:" + value);
  5.   return value;
  6. }
  8. JSON.stringify(o, f)
  9. // []:[object Object]
  10. // [a]:[object Object]
  11. // [b]:1
  12. // '{"a":{"b":1}}'

上面代码中，对象o一共会被f函数处理三次，最后那行是JSON.stringify的输出。第一次键名为空，键值是整个对象o；第二次键名为a，键值是{b: 1}；第三次键名为b，键值为1。

递归处理中，每一次处理的对象，都是前一次返回的值。

  1. var o = {a: 1};
  3. function f(key, value) {
  4.   if (typeof value === 'object') {
  5.     return {b: 2};
  6.   }
  7.   return value * 2;
  8. }
  10. JSON.stringify(o, f)
  11. // "{"b": 4}"

上面代码中，f函数修改了对象o，接着JSON.stringify方法就递归处理修改后的对象o。

如果处理函数返回undefined或没有返回值，则该属性会被忽略。

  1. function f(key, value) {
  2.   if (typeof(value) === "string") {
  3.     return undefined;
  4.   }
  5.   return value;
  6. }
  8. JSON.stringify({ a: "abc", b: 123 }, f)
  9. // '{"b": 123}'

上面代码中，a属性经过处理后，返回undefined，于是该属性被忽略了。

第三个参数

JSON.stringify还可以接受第三个参数，用于增加返回的 JSON 字符串的可读性。如果是数字，表示每个属性前面添加的空格（最多不超过10个）；如果是字符串（不超过10个字符），则该字符串会添加在每行前面。

  1. JSON.stringify({ p1: 1, p2: 2 }, null, 2);
  2. /*
  3. "{
  4.   "p1": 1,
  5.   "p2": 2
  6. }"
  7. */
  9. JSON.stringify({ p1:1, p2:2 }, null, '|-');
  10. /*
  11. "{
  12. |-"p1": 1,
  13. |-"p2": 2
  14. }"
  15. */

参数对象的 toJSON 方法

如果参数对象有自定义的toJSON方法，那么JSON.stringify会使用这个方法的返回值作为参数，而忽略原对象的其他属性。

下面是一个普通的对象。

  1. var user = {
  2.   firstName: '三',
  3.   lastName: '张',
  5.   get fullName(){
  6.     return this.lastName + this.firstName;
  7.   }
  8. };
  10. JSON.stringify(user)
  11. // "{"firstName":"三","lastName":"张","fullName":"张三"}"

现在，为这个对象加上toJSON方法。

  1. var user = {
  2.   firstName: '三',
  3.   lastName: '张',
  5.   get fullName(){
  6.     return this.lastName + this.firstName;
  7.   },
  9.   toJSON: function () {
  10.     return {
  11.       name: this.lastName + this.firstName
  12.     };
  13.   }
  14. };
  16. JSON.stringify(user)
  17. // "{"name":"张三"}"

上面代码中，JSON.stringify发现参数对象有toJSON方法，就直接使用这个方法的返回值作为参数，而忽略原对象的其他参数。

Date对象就有一个自己的toJSON方法。

  1. var date = new Date('2015-01-01');
  2. date.toJSON() // "2015-01-01T00:00:00.000Z"
  3. JSON.stringify(date) // ""2015-01-01T00:00:00.000Z""

上面代码中，JSON.stringify发现处理的是Date对象实例，就会调用这个实例对象的toJSON方法，将该方法的返回值作为参数。

toJSON方法的一个应用是，将正则对象自动转为字符串。因为JSON.stringify默认不能转换正则对象，但是设置了toJSON方法以后，就可以转换正则对象了。

  1. var obj = {
  2.   reg: /foo/
  3. };
  5. // 不设置 toJSON 方法时
  6. JSON.stringify(obj) // "{"reg":{}}"
  8. // 设置 toJSON 方法时
  9. RegExp.prototype.toJSON = RegExp.prototype.toString;
  10. JSON.stringify(/foo/) // ""/foo/""

上面代码在正则对象的原型上面部署了toJSON()方法，将其指向toString()方法，因此转换成 JSON 格式时，正则对象就先调用toJSON()方法转为字符串，然后再被JSON.stringify()方法处理。

JSON.parse()

JSON.parse方法用于将 JSON 字符串转换成对应的值。

  1. JSON.parse('{}') // {}
  2. JSON.parse('true') // true
  3. JSON.parse('"foo"') // "foo"
  4. JSON.parse('[1, 5, "false"]') // [1, 5, "false"]
  5. JSON.parse('null') // null
  7. var o = JSON.parse('{"name": "张三"}');
  8. o.name // 张三

如果传入的字符串不是有效的 JSON 格式，JSON.parse方法将报错。

  1. JSON.parse("'String'") // illegal single quotes
  2. // SyntaxError: Unexpected token ILLEGAL

上面代码中，双引号字符串中是一个单引号字符串，因为单引号字符串不符合 JSON 格式，所以报错。

为了处理解析错误，可以将JSON.parse方法放在try...catch代码块中。

  1. try {
  2.   JSON.parse("'String'");
  3. } catch(e) {
  4.   console.log('parsing error');
  5. }

JSON.parse方法可以接受一个处理函数，作为第二个参数，用法与JSON.stringify方法类似。

  1. function f(key, value) {
  2.   if (key === 'a') {
  3.     return value + 10;
  4.   }
  5.   return value;
  6. }
  8. JSON.parse('{"a": 1, "b": 2}', f)
  9. // {a: 11, b: 2}

上面代码中，JSON.parse的第二个参数是一个函数，如果键名是a，该函数会将键值加上10。

参考链接