你所不知道的JSON.stringify

青旅半醒 2022-09-15 13:58 348阅读 0赞

9bb5f358974e3ce64e0b0512a8a9ba4c.png

原文 | https://abdulapopoola.com/2017/02/27/what-you-didnt-know-about-json-stringify/

jsON已经逐渐替代XML被全世界的开发者广泛使用。本文深入讲解JavaScript中使用jsON.stringify的一些细节问题。首先简单回顾一下JSON和JavaScript:

  • 不是所有的合法的JSON都是有效的JavaScript;
  • JSON只是一个文本格式;
  • JSON中的数字是十进制。

1. JSON.stringify

  1. et foo = { a: 2, b: function() {} };
  2. JSON.stringify(foo);
  3. // "{ "a": 2 }"

还有哪些属性也不能转换?JSON.stringify函数将一个JavaScript对象转换成文本化的JSON。不能被文本化的属性会被忽略。foo中属性b的值是函数定义,没有被转换而丢失。

1. 循环引用

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

  1. var bar = {
  2. a: {
  3. c: foo
  4. }
  5. };
  6. var foo = {
  7. b: bar
  8. };

属性c指向自己,如果层层解析,将会进入一个无限循环。我们尝试将其打印出来看看:

  1. let fooStringified = JSON.stringify(foo);
  2. console.log(fooStringified); // {"b":{"a":{}}}

c的属性指向foo对象,foo对象中的b属性又指向bar对象而无法处理,整个被忽略而返回空对象。

如下定义(原文中的例子)是无法通过编译的:

  1. let foo = {b : foo};

错误信息:

  1. ReferenceError: foo is not defined
  2. at repl:1:14

在函数式语言Haskell中,因为有Lazy Evaluation技术,可以使用类似的定义方法。

2. Symbol和undefined
  1. let foo = { b: undefined };
  2. JSON.stringify(foo);
  3. // {}
  4. // Symbols
  5. foo.b = Symbol();
  6. JSON.stringify(foo);
  7. // {}

在数组中,不可被stringify的元素用null填充。例外情况

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

为什么有些属性无法被stringify呢?这样可以保持数组本身的“形状”,也就是每一个元素原本的索引。

因为JSON是一个通用的文本格式,和语言无关。设想如果将函数定义也stringify的话,如何判断是哪种语言,并且通过合适的方式将其呈现出来将会变得特别复杂。特别是和语言相关的一些特性,比如JavaScript中的Symbol。

ECMASCript官方也特意强调了这一点:

It does not attempt to impose ECMAScript’s internal data representations on other programming languages. Instead, it shares a small subset of ECMAScript’s textual representations with all other programming languages.

2. 重写对象toJSON函数

一个绕过对象某些属性无法stringify的方法就是实现对象的toJSON方法来自定义被stringify的对象。因为几乎每一个AJAX调用都会使用JSON.stringify,掌握该技巧将会对处理服务器交互有很大帮助。

和toString允许你将对象中的元素以字符串(string)的形式返回类似,toJSON提供了一种可以将对象中不能stringify的属性转换的方法,使得接下来调用的JSON.stringify可以将其转换成JSON格式。

  1. function Person (first, last) {
  2. this.firstName = first;
  3. this.last = last;
  4. }
  5. Person.prototype.process = function () {
  6. return this.firstName + ' ' +
  7. this.lastName;
  8. };
  9. let ade = new Person('Ade', 'P');
  10. JSON.stringify(ade);
  11. // "{"firstName":"Ade","last":"P"}"

Person实例ade的process函数没有被stringify。假想如果服务器只想要ade的全称,而不是分别获取姓和名,我们可以直接定义toJSON来达到目的:

  1. Person.prototype.toJSON = function () {
  2. return { fullName: this.process(); };
  3. };
  4. let ade = new Person('Ade', 'P');
  5. JSON.stringify(ade);
  6. // "{"fullName":"Ade P"}"

定义toJSON的优点是复用性和稳定性,你可以将ade配合任何库使用,传输的数据都将是你通过toJSON定义而返回的fullName。

  1. // jQuery
  2. $.post('endpoint', ade);
  3. // Angular 2
  4. this.httpService.post('endpoint', ade)

3. 可选参数

JSON.stringify完整的定义如下:

  1. JSON.stringify(value, replacer?, space?)

replacer和space都是可选参数,接下来我们来分别讲解。

replacer是一个过滤函数或则一个数组包含要被stringify的属性名。如果没有定义,默认所有属性都被stringify。

1. 数组

只有在数组中的属性被stringify:

  1. let foo = {
  2. a : 1,
  3. b : "string",
  4. c : false
  5. };
  6. JSON.stringify(foo, ['a', 'b']);
  7. //"{"a":1,"b":"string"}"

嵌套属性也同样会被过滤:

  1. let bar = {
  2. a : 1,
  3. b : { c : 2 }
  4. };
  5. JSON.stringify(bar, ['a', 'b']);
  6. //"{"a":1,"b":{}}"
  7. JSON.stringify(bar, ['a', 'b', 'c']);
  8. //"{"a":1,"b":{"c":2}}"

定义过滤数组有时候并不能满足需求,那么可以自定义过滤函数。

2. 函数

过滤函数以对象中的每一个属性和值作为输入,返回值有以下几种情况:

  • 返回undefined表示忽略该属性;
  • 返回字符串,布尔值或则数字将会被stringify;
  • 返回对象将会触发递归调用知道遇到基本类型的属性;
  • 返回无法stringify的值将会被忽略;

    let baz = {
    a : 1,
    b : { c : 2 }
    };

    // 返回大于1的值
    let replacer = function (key, value) {

    1. if(typeof === 'number') {
    2. return value > 1 ? value: undefined;
    3. }
    4. return value;

    };

    JSON.stringify(baz, replacer);
    // “{“b”:{“c”:2}}”

通过改写上面的函数加入适当的输出,可以看到具体的执行步骤:

  1. let obj = {
  2. a : 1,
  3. b : { c : 2 }
  4. };
  5. let tracer = function (key, value){
  6. console.log('Key: ', key);
  7. console.log('Value: ', value);
  8. return value;
  9. };
  10. JSON.stringify(obj, tracer);
  11. // Key:
  12. // Value: Object {a: 1, b: Object}
  13. // Key: a
  14. // Value: 1
  15. // Key: b
  16. // Value: Object {c: 2}
  17. // Key: c
  18. // Value: 2

space

你是否意识到调用默认的JSON.stringify返回的值只要一行,而且完全没有空格?如果想要更加美观的打印出来,那么就需要使用space这个参数了。

我告诉你一个非常简单的方法:通过tab(‘\t’)来分割即可。

  1. let space = {
  2. a : 1,
  3. b : { c : 2 }
  4. };
  5. // 使用制表符
  6. JSON.stringify(space, undefined, '\t');
  7. // "{
  8. // "a": 1,
  9. // "b": {
  10. // "c": 2
  11. // }
  12. // }"
  13. JSON.stringify(space, undefined, '');
  14. // {"a":1,"b":{"c":2}}
  15. // 自定义分隔符
  16. JSON.stringify(space, undefined, 'a');
  17. // "{
  18. // a"a": 1,
  19. // a"b": {
  20. // aa"c": 2
  21. // a}
  22. // }"

一道三颗星的思考题:为什么打印结果的倒数第三行有两个a呢?

结论

本文介绍了一些使用toJSON的技巧:

  • 无法stringify的几种类型
  • 使用toJSON来自定义JSON.stringify的属性
  • 可选参数replacer的两种定义方法来过滤属性
  • 可选参数space用来格式化输出结果
  • 数组和对象中如果包含无法stringify的元素的时候的区别

#

学习更多技能

请点击下方公众号

e91aac11ea1ab8087eb4a7968429f3bc.gif

acf482a3fdd8c26711bae2172c766140.png

b3ed2cfef8af62b98eece3b1847adabe.png

发表评论

表情:
评论列表 (有 0 条评论,348人围观)

还没有评论,来说两句吧...

相关阅读