JSON教程
1.5.2 JSON.stringify()
阅读(

JSON 教程

JSON简介

JSON语法

JSON对象

JSON数组

JSON和JS对象互转

JSON.parse()

JSON.stringify()

JSON.stringify()方法用于把JavaScript值(对象或者数组)序列化为JSON字符串,并返回序列化后的JSON字符串。调用格式为:

JSON.stringify(value[, replacer[, space]])

参数:

value: 必需。将要序列化为JSON 字符串的值。

replacer: 可选。用于替换结果的函数、或仅包括指定的属性数组。

space: 可选。用于文本添加缩进、空格和换行符。

序列化规则

序列化的本质,就是按照 JSON 的语法规则,把 JavaScript 值(对象或者数组),转换为 JSON 字符串,以方便存储和数据交换。

1)数值、布尔值、字符串的包装对象,会转换成对应的原始值。如:

JSON.stringify(1)       // "1"
JSON.stringify(false)   // "false"
JSON.stringify('abc')   // ""abc""
JSON.stringify([1, "false", false])  // '[1,"false",false]'

2)键和值都被序列化,如果键名没有引号,会自动为它添加引号。如:

JSON.stringify({x: 5, y: 6});     // "{"x":5,"y":6}"
JSON.stringify({name: "张三"})    // '{"name":"张三"}'

3)数组,会转换成数组格式。如:

JSON.stringify([])   // "[]"
JSON.stringify([1, "false", false])  // '[1,"false",false]'

4)对象,会转换成对象格式。如:

JSON.stringify({})                // "{}"
JSON.stringify({x: 5, y: 6});     // "{"x":5,"y":6}"

5)正则表达式和数学对象,转换成空对象的字符串形式。如:

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

6)日期对象和包装对象,转换成字符串。如:

JSON.stringify(new Boolean(true))   //"true"
JSON.stringify(new String('123'))   //""123""
JSON.stringify(new Number(1))       //"1"
JSON.stringify(new Date())          //""2016-09-20T02:26:38.294Z""

7) 如果非数组对象的成员是undefined、或任意的函数、或 symbol 值,这个成员会被省略。如果数组对象的成员是undefined、或任意的函数、或 symbol 值,则这些值被转成null。如:

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

8)不可枚举的属性,会被忽略。如:

var obj = {};
Object.defineProperties(obj, {
  'foo': { value: 1,  enumerable: true },
  'bar': { alue: 2, enumerable: false }
});
JSON.stringify(obj);  // "{"foo":1}"

9)所有以 symbol 为键的属性都会被完全忽略掉,即便 replacer 参数中强制指定包含了它们。如:

JSON.stringify(
    {[Symbol.for("foo")]: "foo"},
    function (k, v) {
        if (typeof k === "symbol"){
            return "a symbol";
        }
    }
);
// undefined

replacer参数

replacer参数可以是一个函数或者一个数组。

1)函数

如果replacer参数是一个函数,则对象的每个成员都会调用这个函数。该函数接收两个参数,一个是键(key),一个是值(value),执行序列化时,键和值都会被序列化。如:

function dobule(key, value){
  if (typeof value === "number") {
    value = 2 * value;
  }
  return value;
}
console.log(JSON.stringify({a:1,b:2}, dobule()));  // "{"a":2,"b":4}"

如果replacer函数返回的是一个对象,则该对象被递归地序列化成JSON字符串,并且允许键为空。如:

var jsonObj = {a: {b: 1}};
JSON.stringify(jsonObj, function(key, value) {
  console.log("["+ key +"]:" + value);
  return value;
});

上述代码中,对象 jsonObj 一共会被 function函数处理三次。第一次键名为空,键值是整个对象 jsonObj;第二次键名为 a,键值是 {b:1};第三次键名为 b,键值为 1。运行结果为:

[]:[object Object]
[a]:[object Object]
[b]:1

如果replacer函数返回了undefined或没有返回值,那么相应的属性会被忽略,这种情况将不会被序列化成JSON字符串。如:

JSON.stringify({ a: "abc", b: 123 }, function (key, value) {
  if (typeof(value) === "string") {
    return undefined;
  }
  return value;
})

上述代码得到的结果为:

'{"b": 123}'

2)数组

如果replacer是一个数组,数组的值代表将被序列化成JSON字符串的属性名。执行序列化时,则只对数组中所列举的键执行序列化操作,就相当于实现一个过滤器的功能。如:

var jsonObj = {
  "title":"javascript",
  "group":{
    "a":1,
    "b":2
  }
};
console.log(JSON.stringify(jsonObj,["group","b"]))

上述代码的运行结果为:

{"group":{"b":2}}

需要特别说明的是,过滤器功能只适用于对象,对数组无效。如,

var jsonObj = [1,2];
console.log(JSON.stringify(jsonObj,["0"]));   // "[1,2]"

space参数

默认情况下,JSON.stringify() 输出的JSON字符串不包括任何空格字符或缩进。如:

var jsonObj = {
    "title":"javascript",
    "group":{
        "name":"jia",
        "tel":12345
    }
};
JSON.stringify(jsonObj);
//{"title":"javascript","group":{"name":"jia","tel":12345}}

通过指定space参数,可以在JSON字符串中添加空格或字符串,用于增加返回的JSON字符串的可读性。space参数的值可以是数值或字符串。

1)数值

如果space参数的值是数值,则序列化的字符串中,每一级别会比上一级别缩进指定数目的空格(不超过10个空格)。如:

console.log(JSON.stringify({ p1: 1, p2: 2 }, null, 2));

上述代码得到的结果为:

{
  "p1": 1,
  "p2": 2
}

2)字符串

如果space参数的值是字符串(字符串不超过10个字符),则序列化的字符串中,每一级别会比上一级别的缩进,使用该字符串填充。如:

console.log(JSON.stringify({ p1:1, p2:2 }, null, '|-'));

上述代码得到的结果为:

{
|-"p1": 1,
|-"p2": 2
}

注意:

在序列化一个对象时,如果该对象拥有 toJSON()方法,那么该 toJSON() 方法就会覆盖该对象默认的序列化行为: 被序列化的不是那个原始对象,而是调用 toJSON() 方法后返回的那个对象。如:

var obj = {
  foo: 'foo',
  toJSON: function () {
    return 'bar';
  }
};
JSON.stringify(obj);        // '"bar"'
JSON.stringify({x: obj});   // '{"x":"bar"}'

如果 toJSON()方法返回 undefined,此时如果包含它的对象嵌入在另一个对象中,会导致该对象的值变成 null。而如果包含它的对象是顶级对象,结果就是 undefined。

Date 对象部署了一个自己的 toJSON()方法,它会自动将 Date 对象转换成日期字符串。如:

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

关于作者

歪脖先生,十五年以上软件开发经验,酷爱Web开发,精通 HTML、CSS、JavaScript、jQuery、JSON、Python、Less、Bootstrap等,著有《HTML宝典》、《揭秘CSS》、《Less简明教程》、《JSON教程》、《Bootstrap2用户指南》、《Bootstrap3实用教程》,并全部在 GitHub 上开源。

如果本教程对您帮助很大,请随意打赏。您的支持,将鼓励我写出更好的教程!

← 键盘方向键翻页 →
返回顶部 手机访问 关注微信 返回底部

扫码访问歪脖网

随时随地,想看就看

关注歪脖网微信

分享 web 知识、交流 web 经验