查看原文
其他

如何快速提升 JSON.stringify() 的性能?

前端大全 2022-06-29

(给前端大全加星标,提升前端技能

作者:AlienZHOU(百度)

https://juejin.im/post/5cf61ed3e51d4555fd20a2f3

1. 熟悉的 JSON.stringify()

在浏览器端或服务端, JSON.stringify()都是我们很常用的方法:

  • 将 JSON object 存储到 localStorage 中;

  • POST 请求中的 JSON body;

  • 处理响应体中的 JSON 形式的数据;

  • 甚至某些条件下,我们还会用它来实现一个简单的深拷贝;

  • ……

在一些性能敏感的场合下(例如服务端处理大量并发),或面对大量 stringify 的操作时,我们会希望它的性能更好,速度更快。这也催生了一些优化的 stringify 方案/库,下图是它们与原生方法的性能对比:

绿色部分时原生 JSON.stringify(),可见性能相较这些库都要低很多。那么,在大幅的性能提升背后的技术原理是什么呢?

2. 比 stringify 更快的 stringify

由于 JavaScript 是动态性很强的语言,所以对于一个 Object 类型的变量,其包含的键名、键值、键值类型最终只能在运行时确定。因此,执行 JSON.stringify()时会有很多工作要做。在一无所知的情况下,我们想要大幅优化显然无能为力。

那么如果我们知道这个 Object 中的键名、键值信息呢 —— 也就是知道它的结构信息,这会有帮助么?

看个例子:

下面这个 Object,

  1. const obj = {

  2. name: 'alienzhou',

  3. status: 6,

  4. working: true

  5. };

我们对它应用 JSON.stringify(),得到结果为

  1. JSON.stringify(obj);

  2. // {"name":"alienzhou","status":6,"working":true}

现在如果我们知道这个 obj的结构是固定的:

  • 键名不变

  • 键值的类型一定

那么其实,我可以创建一个“定制化”的 stringify 方法

  1. function myStringify(o) {

  2. return (

  3. '{"name":"'

  4. + o.name

  5. + '","status":'

  6. + o.status

  7. + ',"isWorking":'

  8. + o.working

  9. + '}'

  10. );

  11. }

看看我们的 myStringify方法的输出:

  1. myStringify({

  2. name: 'alienzhou',

  3. status: 6,

  4. working: true

  5. });

  6. // {"name":"alienzhou","status":6,"isWorking":true}


  7. myStringify({

  8. name: 'mengshou',

  9. status: 3,

  10. working: false

  11. });

  12. // {"name":"mengshou","status":3,"isWorking":false}

可以得到正确的结果,但只用到了类型转换和字符串拼接,所以“定制化”方法可以让“stringify”更快。

总结来看,如何得到比 stringify 更快的 stringify 方法呢?

  1. 需要先确定对象的结构信息;

  2. 根据其结构信息,为该种结构的对象创建“定制化”的 stringify方法,其内部实际是通过字符串拼接生成结果的;

  3. 最后,使用该“定制化”的方法来 stringify 对象即可。

这也是大多数 stringify 加速库的套路,转化为代码就是类似:

  1. import faster from 'some_library_faster_stringify';


  2. // 1. 通过相应规则,定义你的对象结构

  3. const theObjectScheme = {

  4. // ……

  5. };


  6. // 2. 根据结构,得到一个定制化的方法

  7. const stringify = faster(theObjectScheme);


  8. // 3. 调用方法,快速 stringify

  9. const target = {

  10. // ……

  11. };

  12. stringify(target);

3. 如何生成“定制化”的方法

根据上面的分析,核心功能在于,根据其结构信息,为该类对象创建“定制化”的stringify方法,其内部实际是简单的属性访问与字符串拼接。

为了了解具体的实现方式,下面我以两个实现上略有差异的开源库为例来简单介绍一下。

3.1. fast-json-stringify

下图是根据 fast-json-stringify 提供的 benchmark 结果,整理出来的性能对比。

可以看到,在大多数场景下具备2-5倍的性能提升。

3.1.1. scheme 的定义方式

fast-json-stringify 使用了 JSON Schema Validation 来定义(JSON)对象的数据格式。其 scheme 定义的结构本身也是 JSON 格式的,例如对象

  1. {

  2. name: 'alienzhou',

  3. status: 6,

  4. working: true

  5. }

对应的 scheme 就是:

  1. {

  2. title: 'Example Schema',

  3. type: 'object',

  4. properties: {

  5. name: {

  6. type: 'string'

  7. },

  8. status: {

  9. type: 'integer'

  10. },

  11. working: {

  12. type: 'boolean'

  13. }

  14. }

  15. }

其 scheme 定义规则丰富,具体使用可以参考 Ajv 这个 JSON 校验库。

3.1.2. stringify 方法的生成

fast-json-stringify 会根据刚才定义的 scheme,拼接生成出实际的函数代码字符串,然后使用 Function 构造函数在运行时动态生成对应的 stringify 函数。

在代码生成上,首先它会注入预先定义好的各类工具方法,这一部分不同的 scheme 都是一样的:

  1. var code = `

  2. 'use strict'

  3. `


  4. code += `

  5. ${$asString.toString()}

  6. ${$asStringNullable.toString()}

  7. ${$asStringSmall.toString()}

  8. ${$asNumber.toString()}

  9. ${$asNumberNullable.toString()}

  10. ${$asIntegerNullable.toString()}

  11. ${$asNull.toString()}

  12. ${$asBoolean.toString()}

  13. ${$asBooleanNullable.toString()}

  14. `

其次,就会根据 scheme 定义的具体内容生成 stringify 函数的具体代码。而生成的方式也比较简单:通过遍历 scheme。

遍历 scheme 时,根据定义的类型,在对应代码处插入相应的工具函数用于键值转换。例如上面例子中 name这个属性:

  1. var accessor = key.indexOf('[') === 0 ? sanitizeKey(key) : `['${sanitizeKey(key)}']`

  2. switch (type) {

  3. case 'null':

  4. code += `

  5. json += $asNull()

  6. `

  7. break

  8. case 'string':

  9. code += nullable ? `json += obj${accessor} === null ? null : $asString(obj${accessor})` : `json += $asString(obj${accessor})`

  10. break

  11. case 'integer':

  12. code += nullable ? `json += obj${accessor} === null ? null : $asInteger(obj${accessor})` : `json += $asInteger(obj${accessor})`

  13. break

  14. ……

上面代码中的 code变量保存的就是最后生成的函数体的代码串。由于在 scheme 定义中, namestring类型,且不为空,所以会在 code中添加如下一段代码字符串:

  1. "json += $asString(obj['name'])"

由于还需要处理数组、及联对象等复杂情况,实际的代码省略了很多。

然后,生成的完整的 code字符串大致如下:

  1. function $asString(str) {

  2. // ……

  3. }

  4. function $asStringNullable(str) {

  5. // ……

  6. }

  7. function $asStringSmall(str) {

  8. // ……

  9. }

  10. function $asNumber(i) {

  11. // ……

  12. }

  13. function $asNumberNullable(i) {

  14. // ……

  15. }

  16. /* 以上是一系列通用的键值转换方法 */


  17. /* $main 就是 stringify 的主体函数 */

  18. function $main(input) {

  19. var obj = typeof input.toJSON === 'function'

  20. ? input.toJSON()

  21. : input


  22. var json = '{'

  23. var addComma = false

  24. if (obj['name'] !== undefined) {

  25. if (addComma) {

  26. json += ','

  27. }

  28. addComma = true

  29. json += '"name":'

  30. json += $asString(obj['name'])

  31. }


  32. // …… 其他属性(status、working)的拼接


  33. json += '}'

  34. return json

  35. }


  36. return $main

最后,将 code字符串传入 Function 构造函数来创建相应的 stringify 函数。

  1. // dependencies 主要用于处理包含 anyOf 与 if 语法的情况

  2. dependenciesName.push(code)

  3. return (Function.apply(null, dependenciesName).apply(null, dependencies))

3.2. slow-json-stringify

slow-json-stringify 虽然名字叫 "slow",但其实是一个 "fast" 的 stringify 库(命名很调皮)。

The slowest stringifier in the known universe. Just kidding, it's the fastest (:

它的实现比前面提到的 fast-json-stringify 更轻量级,思路也很巧妙。同时它在很多场景下效率会比 fast-json-stringify 更快

3.2.1. scheme 的定义方式

slow-json-stringify 的 scheme 定义更自然与简单,主要就是将键值替换为类型描述。还是上面这个对象的例子,scheme 会变为

  1. {

  2. name: 'string',

  3. status: 'number',

  4. working: 'boolean'

  5. }

确实非常直观。

3.2.2. stringify 方法的生成

不知道你注意到没有

  1. // scheme

  2. {

  3. name: 'string',

  4. status: 'number',

  5. working: 'boolean'

  6. }


  7. // 目标对象

  8. {

  9. name: 'alienzhou',

  10. status: 6,

  11. working: true

  12. }

scheme 和原对象的结构是不是很像?

这种 scheme 的巧妙之处在于,这样定义之后,我们可以先把 scheme JSON.stringify一下,然后“扣去”所有类型值,最后等着我们的就是把实际的值直接填充到 scheme 对应的类型声明处。

具体如何操作呢?

首先,可以直接对 scheme 调用 JSON.stringify()来生成基础模版,同时借用 JSON.stringify()的第二个参数来作为遍历方法收集属性的访问路径:

  1. let map = {};

  2. const str = JSON.stringify(schema, (prop, value) => {

  3. const isArray = Array.isArray(value);

  4. if (typeof value !== 'object' || isArray) {

  5. if (isArray) {

  6. const current = value[0];

  7. arrais.set(prop, current);

  8. }


  9. _validator(value);


  10. map[prop] = _deepPath(schema, prop);

  11. props += `"${prop}"|`;

  12. }

  13. return value;

  14. });

此时, map 里收集所有属性的访问路径。同时生成的 props可以拼接为匹配相应类型字符还的正则表达式,例如我们这个例子里的正则表达式为 /name|status|working"(string|number|boolean|undef)"|\[(.*?)\]/

然后,根据正则表达式来顺序匹配这些属性,替换掉属性类型的字符串,换成统一的占位字符串 "__par__",并基于 "__par__"拆分字符串:

  1. const queue = [];

  2. const chunks = str

  3. .replace(regex, (type) => {

  4. switch (type) {

  5. case '"string"':

  6. case '"undefined"':

  7. return '"__par__"';

  8. case '"number"':

  9. case '"boolean"':

  10. case '["array-simple"]':

  11. case '[null]':

  12. return '__par__';

  13. default:

  14. const prop = type.match(/(?<=").+?(?=")/)[0];

  15. queue.push(prop);

  16. return type;

  17. }

  18. })

  19. .split('__par__');

这样你就会得到 chunksprops两个数组。chunks里包含了被分割的 JSON 字符串。以例子来说,两个数组分别如下

  1. // chunks

  2. [

  3. '{"name":"',

  4. '","status":"',

  5. '","working":"',

  6. '"}'

  7. ]


  8. // props

  9. [

  10. 'name',

  11. 'status',

  12. 'working'

  13. ]

最后,由于 map 中保存了属性名与访问路径的映射,因此可以根据 prop 访问到对象中某个属性的值,循环遍历数组,将其与对应的 chunks 拼接即可。

从代码量和实现方式来看,这个方案会更轻便与巧妙,同时也不需要通过 Function、eval 等方式动态生成或执行函数。

4. 总结

虽然不同库的实现有差异,但从整体思路上来说,实现高性能 stringify 的方式都是一样的:

  1. 开发者定义 Object 的 JSON scheme;

  2. stringify 库根据 scheme 生成对应的模版方法,模版方法里会对属性与值进行字符串拼接(显然,属性访问与字符串拼接的效率要高多了);

  3. 最后开发者调用返回的方法来 stringify Object 即可。

归根到底,它本质上是通过静态的结构信息将优化与分析前置了。

Tips

最后,还是想提一下

  • 所有的 benchmark 只能作为一个参考,具体是否有性能提升、提升多少还是建议你在实际的业务中测试;

  • fast-json-stringify 中使用到了 Function 构造函数,因此建议不要将用户输入直接用作 scheme,以防一些安全问题




推荐阅读  点击标题可跳转

2020 大前端冲刺大厂面试题必备(上)

手把手教你写几个实用的 AST 插件

面试常考手写代码学习技巧总结

觉得本文对你有帮助?请分享给更多人

关注「前端大全」加星标,提升前端技能

好文章,我在看❤️

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存