JSON对象

http://javascript.ruanyifeng.com/stdlib/json.html?

JSON对象

来自《JavaScript 标准参考教程（alpha）》，by 阮一峰

目录

• JSON格式
• JSON对象
• JSON.stringify()
• JSON.parse()
• 参考链接

JSON格式

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

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

简单说，JSON格式就是一种表示一系列的“值”的方法，这些值包含在数组或对象之中，是它们的成员。对于这一系列的“值”，有如下几点格式规定：

1. 数组或对象的每个成员的值，可以是简单值，也可以是复合值。

2. 简单值分为四种：字符串、数值（必须以十进制表示）、布尔值和null。

3. 复合值分为两种：符合JSON格式的对象和符合JSON格式的数组。

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

5. 数组或对象之中的字符串必须使用双引号，不能使用单引号。

6. 对象的成员名称必须使用双引号。

以下是合格的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;
  }
} // 不能使用函数和日期对象

需要注意的是，空数组和空对象都是合格的JSON值，null本身也是一个合格的JSON值。

JSON对象

ECMAScript 5新增了JSON对象，用来处理JSON格式数据。它有两个方法：JSON.stringify和JSON.parse。

JSON.stringify()

该方法用于将对象转为JSON字符串。

JSON.stringify("abc");
// ""abc""

JSON.stringify({ name: "张三" });
// {"name":"张三"}

如果一个值是undefined、函数或XML对象，这个值会被省略，除非该值是数组的成员，则返回null。

JSON.stringify({
    f: function() { },
    a: [ function() {}, undefined ]
});
// "{"a":[null,null]}"

该方法还可以接受一个数组参数，表示需要转化的属性。

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

该方法还可以接受一个函数作为参数，用来更改默认的串行化的行为。

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函数，接受两个参数，分别是被转化对象的键和值。这里需要特别注意的是，被处理的除了原有的键，还会新增一个空白的键，对应整个被转化的对象，所以处理之前，必需对键或值做一个判断。

function f(key, value) {
        console.log("["+ key +"]:" + value);
        return value;
    }

JSON.stringify({ a:1, b:2 }, f)
// []:[object Object]
// [a]:1
// [b]:2
// "{"a":1,"b":2}"

如果经过处理，某个属性返回undefined或没有返回值，则该属性会被忽略。

function f(key, value) {
  if (typeof(value) == "string") {
    return undefined;
  }
  return value;
}

JSON.stringify({ a:"abc", b:123 }, f)
// "{"b":123}"

这里需要注意的是，如果某个属性的值是一个对象，则会展开这个对象，先处理它的内部属性。另外，前面说过，有一个键是空键，对应整个被转化的对象。最后真正进行串行化的，实际上就是空键对应的那个值，其他的键都是用来帮助空键完成那个值。

function f(key, value) {

  if ( key === ""){
      return value;
  }
    
  if ( key === "a" ) {
    return value + 10;
  }
}

JSON.stringify({ a:1, b:2 }, f)
// "{"a":11}"

JSON.stringify还可以接受第三个参数，用于增加返回的JSON字符串的可读性。如果是数字，表示每个属性前面添加的空格（最多不超过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
}"

如果JSON.stringify处理的对象，包含一个toJSON方法，则它会使用这个方法得到一个值，然后再转成字符串。

JSON.stringify({ toJSON: function() { return "Cool" } })
// ""Cool""

Date对象本身就部署了toJSON方法。

JSON.stringify(new Date("2011-07-29"))
// ""2011-07-29T00:00:00.000Z""

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.parse('"String"')
// "String"

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

该方法可以接受一个过滤函数，用法与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?

功能链接

• 论坛
• Markdown源码
• 修订历史

留言

comments powered by Disqus