服务器之家:专注于服务器技术及软件下载分享
分类导航

node.js|vue.js|jquery|angularjs|React|json|js教程|

服务器之家 - 编程语言 - JavaScript - 你会用JSON.stringify()?

你会用JSON.stringify()?

2021-05-07 01:01前端工匠浪里行舟君 JavaScript

JSON是一种轻量级数据格式,可以方便地表示复杂数据结构。本文着重介绍JSON.stringify()的使用方法和注意事项。

你会用JSON.stringify()?

前言

JSON是一种轻量级数据格式,可以方便地表示复杂数据结构。JSON对象有两个方法:stringify()和parse()。在简单的情况下,这两个方法分别可以将JavaScript序列化为JSON字符串,以及将JSON解析为原生JavaScript值。

本文着重介绍JSON.stringify()的使用方法和注意事项。

一、使用方法

 

1、基本用法

JSON.stringify()可以把一个JavaScript对象序列化为一个JSON字符串。

  1. let json1 = { 
  2.   title: "Json.stringify"
  3.   author: [ 
  4.     "浪里行舟" 
  5.   ], 
  6.   year: 2021 
  7. }; 
  8. let jsonText = JSON.stringify(json1); 

默认情况下,JSON.stringify()会输出不包含空格或缩进的JSON字符串,因此jsonText的值是这样的:

  1. "{"title":"Json.stringify","author":["浪里行舟"],"year":2021}" 

在序列化JavaScript对象时,所有函数和原型成员都会有意地在结果中省略。此外,值为undefined的任何属性也会被跳过。最终得到的就是所有实例属性均为有效JSON数据类型的表示。

在JSON.stringify()方法一共能接受3个参数,其中两个可选的参数(分别是第二、第三个参数)。这两个可选参数可以用于指定其他序列化JavaScript对象的方式。第二个参数是过滤器,可以是数组或函数;第三个参数是用于缩进结果JSON字符串的选项。单独或组合使用这些参数可以更好地控制JSON序列化。

2、第二个参数--过滤器

如果第二个参数是一个数组,那么JSON.stringify()返回的结果只会包含该数组中列出的对象属性。比如下面的例子:

  1. let json1 = { 
  2.   title: "Json.stringify"
  3.   author: [ 
  4.     "浪里行舟" 
  5.   ], 
  6.   year: 2021, 
  7.   like'frontend'
  8.   weixin: 'frontJS' 
  9. }; 
  10. let jsonText = JSON.stringify(json1, ['weixin']); 

在这个例子中,JSON.stringify()方法的第二个参数是一个包含一个字符串的数组:"weixin"。它对应着要序列化的对象中的属性,因此结果JSON字符串中只会包含这个属性:

  1. "{"weixin":"frontJS"}" 

如果第二个参数是一个函数,则行为又有不同。提供的函数接收两个参数:属性名(key)和属性值(value)。可以根据这个key决定要对相应属性执行什么操作。这个key始终是字符串,只是在值不属于某个键/值对时会是空字符串。

  1. const students = [ 
  2.   { 
  3.     name'james'
  4.     score: 100, 
  5.   }, { 
  6.     name'jordon'
  7.     score: 60, 
  8.   }, { 
  9.     name'kobe'
  10.     score: 90, 
  11.   } 
  12. ]; 
  13.  
  14. function replacer (key, value) { 
  15.   if (key === 'score') { 
  16.     if (value === 100) { 
  17.       return 'S'
  18.     } else if (value >= 90) { 
  19.       return 'A'
  20.     } else if (value >= 70) { 
  21.       return 'B'
  22.     } else if (value >= 50) { 
  23.       return 'C'
  24.     } else { 
  25.       return 'E'
  26.     } 
  27.   } 
  28.   return value; 
  29. console.log(JSON.stringify(students, replacer, 4)) 

上面的代码,我们通过replacer将成绩从百分制替换为成绩等级。

 你会用JSON.stringify()?

值得注意的是,如果stringify的第二个参数为函数那么它的返回值如果是undefined,那么对应的属性不会被序列化,如果返回其他的值,那么用返回的值替代原来的值进行序列化。

3、第三个参数--字符串缩进

JSON.stringify()方法的第三个参数控制缩进和空格。在这个参数是数值时,表示每一级缩进的空格数。例如,每级缩进4个空格,可以这样:

  1. let json1 = { 
  2.   title: "Json.stringify"
  3.   author: [ 
  4.     "浪里行舟" 
  5.   ], 
  6.   year: 2021 
  7. }; 
  8. let jsonText = JSON.stringify(json1, null, 4); 

这样得到的jsonText格式如下:

  1.     "title""Json.stringify"
  2.     "author": [ 
  3.         "浪里行舟" 
  4.     ], 
  5.     "year": 2021 

JSON.stringify()在处理数据的时候同时考虑了数据转换和方便阅读,只不过,方便阅读这一点,常常被人忽略。

4、toJSON()方法--自定义JSON序列化

有时候,对象需要在JSON.stringify()之上自定义JSON序列化。此时,可以在要序列化的对象中添加toJSON()方法,序列化时会基于这个方法返回适当的JSON表示。

下面的对象为自定义序列化而添加了一个toJSON()方法:

  1. let json1 = { 
  2.   title: "Json.stringify"
  3.   author: [ 
  4.     "浪里行舟" 
  5.   ], 
  6.   year: 2021, 
  7.   like'frontend'
  8.   weixin: 'frontJS'
  9.   toJSON: function () { 
  10.     return this.author 
  11.   } 
  12. }; 
  13. console.log(JSON.stringify(json1)); // ["浪里行舟"

注意,箭头函数不能用来定义toJSON()方法。主要原因是箭头函数的词法作用域是全局作用域,在这种情况下不合适。

二、使用场景

 

1、判断数组是否包含某对象,或者判断对象是否相等。

  1. //判断数组是否包含某对象 
  2. let data = [ 
  3.     {name:'浪里行舟'}, 
  4.     {name:'前端工匠'}, 
  5.     {name:'前端开发'}, 
  6.     ], 
  7.     val = {name:'浪里行舟'}; 
  8. console.log(JSON.stringify(data).indexOf(JSON.stringify(val)) !== -1);//true 

我们还可以使用JSON.stringify()方法,来判断两个对象是否相等。

  1. // 判断对象是否相等 
  2. let obj1 = { 
  3.     a: 1, 
  4.     b: 2 
  5.   } 
  6.   let obj2 = { 
  7.     a: 1, 
  8.     b: 2, 
  9.   } 
  10. console.log(JSON.stringify(obj1) === JSON.stringify(obj2)) // true 

不过这种方式存在着较大的局限性,对象如果调整了键的顺序,就会判断出错!

  1. // 调整对象键的位置后 
  2. let obj1 = { 
  3.     a: 1, 
  4.     b: 2 
  5.   } 
  6.   let obj2 = { 
  7.     b: 2, 
  8.     a: 1, 
  9.   } 
  10. console.log(JSON.stringify(obj1) === JSON.stringify(obj2)) // false 

2、使用localStorage/sessionStorage时

localStorage/sessionStorage默认只能存储字符串,而实际开发中,我们往往需要存储对象类型,那么此时我们需要在存储时利用json.stringify()将对象转为字符串,在取本地缓存时,使用json.parse()转回对象即可。

  1. // 存数据 
  2. function setLocalStorage(key,val) { 
  3.     window.localStorage.setItem(key, JSON.stringify(val)); 
  4. }; 
  5. // 取数据 
  6. function getLocalStorage(key) { 
  7.     let val = JSON.parse(window.localStorage.getItem(key)); 
  8.     return val; 
  9. }; 
  10. // 测试 
  11. setLocalStorage('Test',['前端工匠','浪里行舟']); 
  12. console.log(getLocalStorage('Test')); 

 你会用JSON.stringify()?

localStorage

3、实现对象深拷贝

开发中,有时候怕影响原数据,我们常深拷贝出一份数据做任意操作,使用JSON.stringify()与JSON.parse()来实现深拷贝是很不错的选择。

  1. let arr1 = [1, 3, { 
  2.     username: ' kobe' 
  3. }]; 
  4. let arr2 = JSON.parse(JSON.stringify(arr1)); 
  5. arr2[2].username = 'duncan';  
  6. console.log(arr1, arr2) 

 你会用JSON.stringify()?

image.png

这是利用JSON.stringify将对象转成JSON字符串,再用JSON.parse把字符串解析成对象,一去一来,新的对象产生了,新对象会开辟新的栈,实现深拷贝。

这种方法虽然可以实现数组或对象深拷贝,但不能处理函数和正则,因为这两者基于JSON.stringify和JSON.parse处理后,得到的正则就不再是正则(变为空对象),得到的函数就不再是函数(变为null)了。

  1. let arr1 = [1, 3, function () { }, { 
  2.   username: ' kobe' 
  3. }]; 
  4. let arr2 = JSON.parse(JSON.stringify(arr1)); 
  5. arr2[3].username = 'duncan'
  6. console.log(arr1, arr2) 

 你会用JSON.stringify()?

三、使用注意事项

 

JSON.stringify()虽然功能很强大,但是有些属性无法被stringify,所以在开发中需注意以下几种情况,以免产生一些始料未及的BUG。

1、被转换值中有 NaN 和 Infinitylet my

  1. let myObj = { 
  2.   name"浪里行舟"
  3.   age: Infinity, 
  4.   money: NaN, 
  5. }; 
  6. console.log(JSON.stringify(myObj)); 
  7. // {"name":"浪里行舟","age":null,"money":null
  8.  
  9. JSON.stringify([NaN, Infinity]) 
  10. // [null,null

2、被转换值中有 undefined、任意的函数以及 symbol 值

分为两种情况:

数组,undefined、任意的函数以及symbol值在序列化的过程中会被转换成 null

  1. JSON.stringify([undefined, function () { }, Symbol("")]); 
  2. // '[null,null,null]' 

非数组,undefined、任意的函数以及symbol值在序列化的过程中会被忽略

  1. JSON.stringify({ x: undefined, y: function () { }, z: Symbol("") }); 
  2. // '{}' 

3、循环引用

如果一个对象的属性值通过某种间接的方式指回该对象本身,那么就是一个循环引用。比如:

  1. let bar = { 
  2.   a: { 
  3.     c: foo 
  4.   } 
  5. }; 
  6. let foo = { 
  7.   b: bar 
  8. }; 
  9.  
  10. JSON.stringify(foo) 

这种情况下,序列化会报错的:

  1. // 错误信息 
  2. Uncaught ReferenceError: foo is not defined 
  3.     at <anonymous>:3:8 

4、含有不可枚举的属性值时

不可枚举的属性默认会被忽略:

  1. let personObj = Object.create(null, { 
  2.   name: { value: "浪里行舟", enumerable: false }, 
  3.   year: { value: "2021", enumerable: true }, 
  4. }) 
  5.  
  6. console.log(JSON.stringify(personObj)) // {"year":"2021"

四、总结

 

JSON.stringify()用于将JavaScript对象序列化为JSON字符串,这方法有一些选项可以用来改变默认的行为,以实现过滤或修改流程。不过也应该注意有些属性是无法被 stringify,所以开发时候应该避开这些坑!

参考资料

  • JavaScript高级程序设计(第4版)
  • 慎用JSON.stringify
  • 你会用JS格式化JSON吗?
  • json.stringify()的妙用
  • 你所不知道的JSON.stringify

原文地址:https://mp.weixin.qq.com/s/X4eMPpwNMyA23DpseETj7w

延伸 · 阅读

精彩推荐