最近在做 Node 服務端需求的時候，遇到了幾次服務端報錯的問題。打 log 發(fā)現(xiàn)均是一些 Error，但是它們都沒法很好地透傳給前端瀏覽器，出現(xiàn)問題只能查看服務端機器的日志，調(diào)試起來非常不方便。思考了一下，服務端的內(nèi)容都是通過 JSON.stringify() 處理，然后設置 Content-type: text/json 的響應頭以后再傳給前端的，如果 Error 也能夠被這樣處理，那么調(diào)試起來就方便多了。

舉個例子

說到 JSON.stringify() 這個方法，相信所有玩過 JS 的同學都不會陌生。它能夠方便地把一個對象轉化成字符串，在不同的場景中都有著極大的用處。但是它也有一個較大的缺點，無法直接處理諸如 Error 一類的對象。

首先來看個例子：

const err = new Error('This is an error') JSON.stringify(err) // => "{}" 

在控制臺運行上述代碼后會發(fā)現(xiàn)，JSON.stringify() 的結果是一個字符串的 "{}"，里面沒有任何有效內(nèi)容。這是否意味著 JSON.stringify() 確實無法處理 Error 呢？下面我們來看看在 MDN 里這個函數(shù)是如何定義的。

MDN 定義

首先來看看描述

JSON.stringify()將值轉換為相應的JSON格式：

• 轉換值如果有toJSON()方法，該方法定義什么值將被序列化。
• 非數(shù)組對象的屬性不能保證以特定的順序出現(xiàn)在序列化后的字符串中。
• 布爾值、數(shù)字、字符串的包裝對象在序列化過程中會自動轉換成對應的原始值。
• undefined、任意的函數(shù)以及 symbol 值，在序列化過程中會被忽略（出現(xiàn)在非數(shù)組對象的屬性值中時）或者被轉換成 null（出現(xiàn)在數(shù)組中時）。函數(shù)、undefined被單獨轉換時，會返回undefined，如JSON.stringify(function(){}) or JSON.stringify(undefined).
• 對包含循環(huán)引用的對象（對象之間相互引用，形成無限循環(huán)）執(zhí)行此方法，會拋出錯誤。
• 所有以 symbol 為屬性鍵的屬性都會被完全忽略掉，即便 replacer 參數(shù)中強制指定包含了它們。
• Date日期調(diào)用了toJSON()將其轉換為了string字符串（同Date.toISOString()），因此會被當做字符串處理。
• NaN和Infinity格式的數(shù)值及null都會被當做null。
• 其他類型的對象，包括Map/Set/weakMap/weakSet，僅會序列化可枚舉的屬性。

列了那么多其實是為了湊字數(shù)我們只看最后一條描述：

其他類型的對象，包括Map/Set/weakMap/weakSet，僅會序列化可枚舉的屬性。

“僅會序列化可枚舉的屬性”，是什么意思呢？眾所周知，在 JS 的世界中一切皆對象，對象有著不同的屬性，這些屬性是否可枚舉，我們用 enumerable 來定義。

對象屬性的 enumerable

舉個例子，我們用 obj = { a: 1, b: 2, c: 3 } 來定義一個對象，然后設置它的 c 屬性為“不可枚舉”，看看效果會如何：

首先看處理前的效果：

const obj = { a: 1, b: 2, c: 3 } JSON.stringify(obj) // => "{"a":1,"b":2,"c":3}" 

再看處理后的效果：

const obj = { a: 1, b: 2, c: 3 } Object.defineProperty(obj, 'c', { value: 3, enumerable: false }) JSON.stringify(obj) // => "{"a":1,"b":2}" 

可以看到，在對 c 屬性設置為不可枚舉以后，JSON.stringify() 便不再對其進行序列化。

我們把問題再深入一些，有沒有辦法能夠獲取一個對象中包含不可枚舉在內(nèi)的所有屬性呢？答案是使用 Object.getOwnPropertyNames() 方法。

依然是剛剛被改裝過的 obj 對象，我們來看看它所包含的所有屬性：

Object.getOwnPropertyNames(obj) // => ["a", "b", "c"] 

不可枚舉的 c 屬性也被獲取到了！

用同樣的方法，我們來看看一個 Error 都包含哪些屬性：

const err = new Error('This is an error') Object.getOwnPropertyNames(err) // => ["stack", "message"] 

可以看到，Error 包含了 stack 和 message 兩個屬性，它們均可以使用點運算符 . 從 err 實例里面拿到。

既然我們已經(jīng)能夠獲取 Error 實例的不可枚舉屬性及其內(nèi)容，那么距離使用 JSON.stringify() 序列化 Error 也已經(jīng)不遠了！

JSON.stringify() 的第二個參數(shù)

JSON.stringify() 可以接收三個參數(shù)：

語法

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

value

將要序列化成 一個JSON 字符串的值。

replacer 可選

如果該參數(shù)是一個函數(shù)，則在序列化過程中，被序列化的值的每個屬性都會經(jīng)過該函數(shù)的轉換和處理；如果該參數(shù)是一個數(shù)組，則只有包含在這個數(shù)組中的屬性名才會被序列化到最終的 JSON 字符串中；如果該參數(shù)為null或者未提供，則對象所有的屬性都會被序列化。

space 可選

指定縮進用的空白字符串，用于美化輸出（pretty-print）；如果參數(shù)是個數(shù)字，它代表有多少的空格；上限為10。該值若小于1，則意味著沒有空格；如果該參數(shù)為字符串(字符串的前十個字母)，該字符串將被作為空格；如果該參數(shù)沒有提供（或者為null）將沒有空格。 返回值 節(jié) 一個表示給定值的JSON字符串。

我們來看 replacer 的用法：

……如果該參數(shù)是一個數(shù)組，則只有包含在這個數(shù)組中的屬性名才會被序列化到最終的 JSON 字符串中……

依然使用上文的 obj 為例子：

const obj = { a: 1, b: 2, c: 3 } Object.defineProperty(obj, 'c', { value: 3, enumerable: false }) JSON.stringify(obj, ['a', 'c']) // => "{"a":1,"c":3}" 

可以看到，我們在 replacer 中指定了要序列化 a 和 c 屬性，輸出結果也是只有這兩個屬性的值，且不可枚舉的 c 屬性也被序列化了！守得云開見月明，Error 對象被序列化的方法也就出來了：

const err = new Error('This is an error') JSON.stringify(err, Object.getOwnPropertyNames(err), 2) // => // "{ // "stack": "Error: This is an error\n at <anonymous>:1:13", // "message": "This is an error" // }" 

后記

文章本來的標題是“你不知道的 JSON.stringify()”，但是總感覺詞不達意，有標題黨的嫌疑，遂改成更為實在的現(xiàn)標題。

對于一些常用的函數(shù)，其背后也有著許多值得探索的內(nèi)容，比如這次為了讓 JSON.stringify() 去序列化一個 Error，我又復習了一遍 JS 對象屬性中 enumerable 的相關知識，才知道這些原本以為很底層的基礎知識其實對真實業(yè)務也有著巨大的作用。夯實基礎，永遠都是很重要的。

到此這篇關于使用 JSON.stringify() 列化一個Error的文章就介紹到這了,更多相關使用 JSON.stringify() 列化一個Error內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論