JSON.stringify()

课后整理 2020-12-20

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、函数或 XML 对象,这个成员会被过滤。例如:

var obj = {
  a: undefined,
  b: function () {}
};
JSON.stringify(obj) // "{}"

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

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

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

在上面代码中,数组arr的成员是undefined和函数,它们都被转成了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方法会忽略这个属性。

第二个参数

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

var obj = {
  'prop1': 'value1',
  'prop2': 'value2',
  'prop3': 'value3'
};
var selectedProperties = ['prop1', 'prop2'];
JSON.stringify(obj, selectedProperties)
//  "{"prop1":"value1","prop2":"value2"}"

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

这个类似“白名单”的数组,只对对象的属性有效,对数组无效。例如:

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

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

第二个参数还可以是一个函数,用来更改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函数,接受两个参数,分别是被转换的对象的键名和键值。如果键值是数值,就将它乘以2,否则就原样返回。

注意,这个处理函数是递归处理所有的键。例如:

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函数处理三次。第一次键名为空,键值是整个对象o;第二次键名为a,键值是{b: 1};第三次键名为b,键值为1。

【示例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函数修改了对象o,接着JSON.stringify方法就递归处理修改后的对象o。

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

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

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

第三个参数

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

}" */

toJSON 方法

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

【示例2】下面是一个普通的对象。

var user = {
  firstName: '三',
  lastName: '张',
  get fullName(){
    return this.lastName +  this.firstName;
  }
};
JSON.stringify(user)
// "{"firstName":"三","lastName":"张","fullName":"张三"}"

现在,为这个对象加上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发现参数对象有toJSON方法,就直接使用这个方法的返回值作为参数,而忽略原对象的其他参数。

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

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

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

【示例3】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时,正则对象就先调用toJSON方法转为字符串,然后再被JSON.stingify方法处理。

【补充】

JSON.stringify()函数具体用法如下。

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

参数说明如下。

如果replacer为函数,则 JSON.stringify将调用该函数,并传入每个成员的键和值。 使用返回值而不是原始值。如果该参数函数返回undefined,则排除该成员。根对象的键是一个空字符串:""。

如果replacer是一个数组,则仅转换该数组中具有键值的成员。成员的转换顺序与键在数组中的顺序一样。当value参数也为数组时,将忽略replacer数组。

如果省略space,则将生成返回值文本,而没有任何额外空格。

如果space是一个数字,则返回值文本在每个级别缩进指定数目的空格。如果space大于10,则文本缩进10个空格。

如果space是一个非空字符串(如“\t”),则返回值文本在每个级别中缩进字符串中的字符。

如果space是长度大于10个字符的字符串,则使用前10个字符。

JSON.stringify()函数的返回值是一个JSON格式的字符串。

【示例4】下面示例演示了如何使用JSON.stringify将数组转换成JSON字符串,然后使用JSON.parse将该字符串重新转换成数组。

var arr = ["a", "b", "c"]; 
var str = JSON.stringify(arr); 
document.write(str);                                               //  ["a","b","c"]
document.write ("<br/>"); 
var newArr = JSON.parse(str); 
while (newArr.length > 0) { 
    document.write(newArr.pop() +  "<br/>"); 
}

【示例5】下面示例把对象nums转换为JSON字符串,然后传入replacer()函数过滤出即将被字符串化的对象中值为13的属性。

var nums = {
    "first": 7,
    "second": 14,
    "third": 13
}
var luckyNums = JSON.stringify(nums,replacer);
document.write(luckyNums);                                   //{"first":7,"second":14}
function replacer(key, value){
    if (value == 13) {
        return undefined;
    } else {
        return value;
    }
} 

【示例6】下面示例是在上面示例基础上,设置space参数值为4,格式化JSON字符串,设置水平缩进为4个空格数,显示效果如图1左图所示。如果不传递space参数值,则显示效果如图1右图所示。

var nums = {
    "first": 7,
    "second": 14,
    "third": 13
}
var luckyNums = JSON.stringify(nums,replacer,4);
document.write("<pre>" + luckyNums +  "</pre>");
function replacer(key, value){
    if (value == 13) {
        return undefined;
    } else {
        return value;
    }
}

  

格式化效果                  非格式化效果

图1   输出序列号JSON字符串

【示例7】下面示例使用JSON.stringify将contact对象转换为JSON 文本,定义memberfilter数组以便只转换name、sex和tel成员,同时排序显示为name、sex和tel,显示效果如图2所示。

var contact = {
    qq : "111111111",
        name  : "张三",
         tel  : "13555556666",
        sex  : "men",
         url  : "http://www.mysite.cn/"
}
var memberfilter = ["name","sex","tel"];
var jsonText = JSON.stringify(contact, memberfilter, "	");
document.write("<pre>" + jsonText +  "</pre>");

图2  根据数组元素顺序和值输出对象成员的JSON文本

【示例8】下面示例使用JSON.stringify将一个数组进行转换,调用replaceToUpper 函数将数组中的每个字符串转换为大写形式。

var  continents =  ["Europe","Asia","Australia","Antarctica","North  America","South America","Africa"];
var jsonText = JSON.stringify(continents, replaceToUpper);
function replaceToUpper(key, value) {
    return  value.toString().toUpperCase();
}
document.write(jsonText);                                 //输出"EUROPE,ASIA,AUSTRALIA,ANTARCTICA,NORTH  AMERICA,SOUTH AMERICA,AFRICA"