如何提升JSON.stringify()的效能？

alienzhou發表於2019-06-12
JSON

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，

const obj = {
    name: 'alienzhou',
    status: 6,
    working: true
};

我們對它應用JSON.stringify()，得到結果為

JSON.stringify(obj);
// {"name":"alienzhou","status":6,"working":true}

現在如果我們知道這個obj的結構是固定的：

  • 鍵名不變
  • 鍵值的型別一定

那麼其實，我可以建立一個“定製化”的 stringify 方法

function myStringify(o) {
    return (
        '{"name":"'
        + o.name
        + '","status":'
        + o.status
        + ',"isWorking":'
        + o.working
        + '}'
    );
}

看看我們的myStringify方法的輸出：

myStringify({
    name: 'alienzhou',
    status: 6,
    working: true
});
// {"name":"alienzhou","status":6,"isWorking":true}

myStringify({
    name: 'mengshou',
    status: 3,
    working: false
});
// {"name":"mengshou","status":3,"isWorking":false}

可以得到正確的結果，但只用到了型別轉換和字串拼接，所以“定製化”方法可以讓“stringify”更快。

總結來看，如何得到比 stringify 更快的 stringify 方法呢？

  1. 需要先確定物件的結構資訊；
  2. 根據其結構資訊，為該種結構的物件建立“定製化”的stringify方法，其內部實際是通過字串拼接生成結果的；
  3. 最後，使用該“定製化”的方法來 stringify 物件即可。

這也是大多數 stringify 加速庫的套路，轉化為程式碼就是類似：

import faster from 'some_library_faster_stringify';

// 1. 通過相應規則，定義你的物件結構
const theObjectScheme = {
    // ……
};

// 2. 根據結構，得到一個定製化的方法
const stringify = faster(theObjectScheme);

// 3. 呼叫方法，快速 stringify
const target = {
    // ……
};
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 格式的，例如物件

{
    name: 'alienzhou',
    status: 6,
    working: true
}

對應的 scheme 就是：

{
    title: 'Example Schema',
    type: 'object',
    properties: {
        name: {
            type: 'string'
        },
        status: {
            type: 'integer'
        },
        working: {
            type: 'boolean'
        }
    }
}

其 scheme 定義規則豐富，具體使用可以參考 Ajv 這個 JSON 校驗庫。

3.1.2. stringify 方法的生成

fast-json-stringify 會根據剛才定義的 scheme，拼接生成出實際的函式程式碼字串，然後使用 Function 建構函式在執行時動態生成對應的 stringify 函式。

在程式碼生成上，首先它會注入預先定義好的各類工具方法，這一部分不同的 scheme 都是一樣的：

var code = `
    'use strict'
  `

  code += `
    ${$asString.toString()}
    ${$asStringNullable.toString()}
    ${$asStringSmall.toString()}
    ${$asNumber.toString()}
    ${$asNumberNullable.toString()}
    ${$asIntegerNullable.toString()}
    ${$asNull.toString()}
    ${$asBoolean.toString()}
    ${$asBooleanNullable.toString()}
  `

其次，就會根據 scheme 定義的具體內容生成 stringify 函式的具體程式碼。而生成的方式也比較簡單：通過遍歷 scheme。

遍歷 scheme 時，根據定義的型別，在對應程式碼處插入相應的工具函式用於鍵值轉換。例如上面例子中name這個屬性：

var accessor = key.indexOf('[') === 0 ? sanitizeKey(key) : `['${sanitizeKey(key)}']`
switch (type) {
    case 'null':
        code += `
            json += $asNull()
        `
        break
    case 'string':
        code += nullable ? `json += obj${accessor} === null ? null : $asString(obj${accessor})` : `json += $asString(obj${accessor})`
        break
    case 'integer':
        code += nullable ? `json += obj${accessor} === null ? null : $asInteger(obj${accessor})` : `json += $asInteger(obj${accessor})`
        break
    ……

上面程式碼中的code變數儲存的就是最後生成的函式體的程式碼串。由於在 scheme 定義中，name為string型別，且不為空，所以會在code中新增如下一段程式碼字串：

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

由於還需要處理陣列、及聯物件等複雜情況，實際的程式碼省略了很多。

然後，生成的完整的code字串大致如下：

function $asString(str) {
    // ……
}
function $asStringNullable(str) {
    // ……
}
function $asStringSmall(str) {
    // ……
}
function $asNumber(i) {
    // ……
}
function $asNumberNullable(i) {
    // ……
}
/* 以上是一系列通用的鍵值轉換方法 */

/* $main 就是 stringify 的主體函式 */
function $main(input) {
    var obj = typeof input.toJSON === 'function'
        ? input.toJSON()
        : input

    var json = '{'
    var addComma = false
    if (obj['name'] !== undefined) {
        if (addComma) {
            json += ','
        }
        addComma = true
        json += '"name":'
        json += $asString(obj['name'])
    }

    // …… 其他屬性(status、working)的拼接

    json += '}'
    return json
}

return $main

最後，將code字串傳入 Function 建構函式來建立相應的 stringify 函式。

// dependencies 主要用於處理包含 anyOf 與 if 語法的情況
dependenciesName.push(code)
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 會變為

{
    name: 'string',
    status: 'number',
    working: 'boolean'
}

確實非常直觀。

3.2.2. stringify 方法的生成

不知道你注意到沒有

// scheme
{
    name: 'string',
    status: 'number',
    working: 'boolean'
}

// 目標物件
{
    name: 'alienzhou',
    status: 6,
    working: true
}

scheme 和原物件的結構是不是很像？

這種 scheme 的巧妙之處在於，這樣定義之後，我們可以先把 scheme JSON.stringify一下，然後“扣去”所有型別值，最後等著我們的就是把實際的值直接填充到 scheme 對應的型別宣告處。

具體如何操作呢？

首先，可以直接對 scheme 呼叫JSON.stringify()來生成基礎模版，同時借用JSON.stringify()的第二個引數來作為遍歷方法收集屬性的訪問路徑：

let map = {};
const str = JSON.stringify(schema, (prop, value) => {
    const isArray = Array.isArray(value);
    if (typeof value !== 'object' || isArray) {
        if (isArray) {
            const current = value[0];
            arrais.set(prop, current);
        }

        _validator(value);

        map[prop] = _deepPath(schema, prop);
        props += `"${prop}"|`;
    }
    return value;
});

此時，map 裡收集所有屬性的訪問路徑。同時生成的props可以拼接為匹配相應型別字元還的正規表示式，例如我們這個例子裡的正規表示式為/name|status|working"(string|number|boolean|undef)"|\\[(.*?)\\]/。

然後，根據正規表示式來順序匹配這些屬性，替換掉屬性型別的字串，換成統一的佔位字串"__par__"，並基於"__par__"拆分字串：

const queue = [];
const chunks = str
    .replace(regex, (type) => {
      switch (type) {
        case '"string"':
        case '"undefined"':
          return '"__par__"';
        case '"number"':
        case '"boolean"':
        case '["array-simple"]':
        case '[null]':
          return '__par__';
        default:
          const prop = type.match(/(?<=\").+?(?=\")/)[0];
          queue.push(prop);
          return type;
      }
    })
    .split('__par__');

這樣你就會得到chunks和props兩個陣列。chunks裡包含了被分割的 JSON 字串。以例子來說，兩個陣列分別如下

// chunks
[
    '{"name":"',
    '","status":"',
    '","working":"',
    '"}'
]

// props
[
    'name',
    'status',
    'working'
]

最後，由於 map 中儲存了屬性名與訪問路徑的對映，因此可以根據 prop 訪問到物件中某個屬性的值，迴圈遍歷陣列，將其與對應的 chunks 拼接即可。

從程式碼量和實現方式來看，這個方案會更輕便與巧妙，同時也不需要通過 Function、eval 等方式動態生成或執行函式。

4. 總結

雖然不同庫的實現有差異，但從整體思路上來說，實現高效能 stringify 的方式都是一樣的：

  1. 開發者定義 Object 的 JSON scheme；
  2. stringify 庫根據 scheme 生成對應的模版方法，模版方法裡會對屬性與值進行字串拼接（顯然，屬性訪問與字串拼接的效率要高多了）；
  3. 最後開發者呼叫返回的方法來 stringify Object 即可。

歸根到底，它本質上是通過靜態的結構資訊將優化與分析前置了。

Tips

最後，還是想提一下

  • 所有的 benchmark 只能作為一個參考，具體是否有效能提升、提升多少還是建議你在實際的業務中測試；
  • fast-json-stringify 中使用到了 Function 建構函式，因此建議不要將使用者輸入直接用作 scheme，以防一些安全問題。

相關文章