不能使用 JSON.stringify 对错误进行字符串化吗？

Question

重现问题

我在尝试使用 Web 套接字传递错误消息时遇到了问题。我可以使用JSON.stringify 复制我面临的问题以迎合更广泛的受众：

// node v0.10.15
> var error = new Error('simple error message');
    undefined

> error
    [Error: simple error message]

> Object.getOwnPropertyNames(error);
    [ 'stack', 'arguments', 'type', 'message' ]

> JSON.stringify(error);
    '{}'

问题是我最终得到了一个空对象。

我尝试过的

浏览器

我首先尝试离开 node.js 并在各种浏览器中运行它。 Chrome 28 版给了我同样的结果，有趣的是，Firefox 至少做了一次尝试，但遗漏了这条消息：

>>> JSON.stringify(error); // Firebug, Firefox 23
{"fileName":"debug eval code","lineNumber":1,"stack":"@debug eval code:1\n"}

替换函数

然后我查看了Error.prototype。说明原型中包含toString、toSource等方法。知道函数不能被字符串化，我在调用 JSON.stringify 以删除所有函数时包含了replacer function，但后来意识到它也有一些奇怪的行为：

var error = new Error('simple error message');
JSON.stringify(error, function(key, value) {
    console.log(key === ''); // true (?)
    console.log(value === error); // true (?)
});

它似乎没有像往常那样循环遍历对象，因此我无法检查键是否是函数并忽略它。

问题

有没有办法用JSON.stringify 对原生错误消息进行字符串化？如果不是，为什么会出现这种情况？

解决方法

• 坚持使用简单的基于字符串的错误消息，或创建个人错误对象，不要依赖本机 Error 对象。
• 拉属性：JSON.stringify({ message: error.message, stack: error.stack })

更新

@Ray Toal 在评论中建议我看看property descriptors。现在很清楚为什么它不起作用：

var error = new Error('simple error message');
var propertyNames = Object.getOwnPropertyNames(error);
var descriptor;
for (var property, i = 0, len = propertyNames.length; i < len; ++i) {
    property = propertyNames[i];
    descriptor = Object.getOwnPropertyDescriptor(error, property);
    console.log(property, descriptor);
}

输出：

stack { get: [Function],
  set: [Function],
  enumerable: false,
  configurable: true }
arguments { value: undefined,
  writable: true,
  enumerable: false,
  configurable: true }
type { value: undefined,
  writable: true,
  enumerable: false,
  configurable: true }
message { value: 'simple error message',
  writable: true,
  enumerable: false,
  configurable: true }

密钥：enumerable: false。

已接受的答案提供了解决此问题的方法。

Answer 1

JSON.stringify(err, Object.getOwnPropertyNames(err))

似乎有效

[from a comment by /u/ub3rgeek on /r/javascript] 和下面 felixfbecker 的评论

Answer 2

您可以定义一个Error.prototype.toJSON 来检索代表Error 的普通Object：

if (!('toJSON' in Error.prototype))
Object.defineProperty(Error.prototype, 'toJSON', {
    value: function () {
        var alt = {};

        Object.getOwnPropertyNames(this).forEach(function (key) {
            alt[key] = this[key];
        }, this);

        return alt;
    },
    configurable: true,
    writable: true
});

var error = new Error('testing');
error.detail = 'foo bar';

console.log(JSON.stringify(error));
// {"message":"testing","detail":"foo bar"}

使用Object.defineProperty() 会添加toJSON 而它本身不是enumerable 属性。

---

关于修改Error.prototype，而toJSON() 可能不会专门为Errors 定义，the method is still standardized 用于一般对象（参考：步骤 3）。因此，碰撞或冲突的风险很小。

不过，为了完全避免这种情况，可以使用 JSON.stringify()'s replacer parameter 代替：

function replaceErrors(key, value) {
    if (value instanceof Error) {
        var error = {};

        Object.getOwnPropertyNames(value).forEach(function (propName) {
            error[propName] = value[propName];
        });

        return error;
    }

    return value;
}

var error = new Error('testing');
error.detail = 'foo bar';

console.log(JSON.stringify(error, replaceErrors));

Answer 3

由于没有人谈论为什么部分，我会回答它。

为什么这个JSON.stringify 返回一个空对象？

> JSON.stringify(error);
'{}'

回答

来自JSON.stringify()的文档，

对于所有其他 Object 实例（包括 Map、Set、WeakMap 和 WeakSet），只有它们的可枚举属性会被序列化。

而Error 对象没有可枚举的属性，这就是它打印空对象的原因。

Answer 4

修改乔纳森的最佳答案以避免猴子修补：

var stringifyError = function(err, filter, space) {
  var plainObject = {};
  Object.getOwnPropertyNames(err).forEach(function(key) {
    plainObject[key] = err[key];
  });
  return JSON.stringify(plainObject, filter, space);
};

var error = new Error('testing');
error.detail = 'foo bar';

console.log(stringifyError(error, null, '\t'));

Answer 5

有一个很棒的 Node.js 包：serialize-error。

npm install serialize-error

它甚至可以很好地处理嵌套的错误对象。

import {serializeError} from 'serialize-error';

JSON.stringify(serializeError(error));

文档：https://www.npmjs.com/package/serialize-error

Answer 6

我们需要序列化任意对象层次结构，其中根或层次结构中的任何嵌套属性都可能是 Error 的实例。

我们的解决方案是使用JSON.stringify() 的replacer 参数，例如：

function jsonFriendlyErrorReplacer(key, value) {
  if (value instanceof Error) {
    return {
      // Pull all enumerable properties, supporting properties on custom Errors
      ...value,
      // Explicitly pull Error's non-enumerable properties
      name: value.name,
      message: value.message,
      stack: value.stack,
    }
  }

  return value
}

let obj = {
    error: new Error('nested error message')
}

console.log('Result WITHOUT custom replacer:', JSON.stringify(obj))
console.log('Result WITH custom replacer:', JSON.stringify(obj, jsonFriendlyErrorReplacer))

Answer 7

我正在为日志附加程序开发 JSON 格式，并最终在这里尝试解决类似的问题。过了一会儿，我意识到我可以让 Node 完成这项工作：

const util = require("util");
...
return JSON.stringify(obj, (name, value) => {
    if (value instanceof Error) {
        return util.format(value);
    } else {
        return value;
    }
}

Answer 8

您也可以将那些不可枚举的属性重新定义为可枚举的。

Object.defineProperty(Error.prototype, 'message', {
    configurable: true,
    enumerable: true
});

也许还有stack 属性。

Answer 9

上面的答案似乎都没有正确序列化错误原型上的属性（因为getOwnPropertyNames() 不包括继承的属性）。我也无法像建议的答案之一那样重新定义属性。

这是我想出的解决方案 - 它使用 lodash，但您可以将 lodash 替换为这些函数的通用版本。

 function recursivePropertyFinder(obj){
    if( obj === Object.prototype){
        return {};
    }else{
        return _.reduce(Object.getOwnPropertyNames(obj), 
            function copy(result, value, key) {
                if( !_.isFunction(obj[value])){
                    if( _.isObject(obj[value])){
                        result[value] = recursivePropertyFinder(obj[value]);
                    }else{
                        result[value] = obj[value];
                    }
                }
                return result;
            }, recursivePropertyFinder(Object.getPrototypeOf(obj)));
    }
}


Error.prototype.toJSON = function(){
    return recursivePropertyFinder(this);
}

这是我在 Chrome 中所做的测试：

var myError = Error('hello');
myError.causedBy = Error('error2');
myError.causedBy.causedBy = Error('error3');
myError.causedBy.causedBy.displayed = true;
JSON.stringify(myError);

{"name":"Error","message":"hello","stack":"Error: hello\n    at <anonymous>:66:15","causedBy":{"name":"Error","message":"error2","stack":"Error: error2\n    at <anonymous>:67:20","causedBy":{"name":"Error","message":"error3","stack":"Error: error3\n    at <anonymous>:68:29","displayed":true}}}  

Answer 10

如果使用 nodejs，则使用本机 nodejs inspect 有更好的可靠方法。您还可以指定将对象打印到无限深度。

打字稿示例：

import { inspect }  from "util";

const myObject = new Error("This is error");
console.log(JSON.stringify(myObject)); // Will print {}
console.log(myObject); // Will print full error object
console.log(inspect(myObject, {depth: null})); // Same output as console.log plus it works as well for objects with many nested properties.

Link 用于文档，link 用于示例用法。

以及在主题How can I get the full object in Node.js's console.log(), rather than '[Object]'?here中讨论堆栈溢出。

Answer 11

只需转换为常规对象

// example error
let err = new Error('I errored')

// one liner converting Error into regular object that can be stringified
err = Object.getOwnPropertyNames(err).reduce((acc, key) => { acc[key] = err[key]; return acc; }, {})

如果您想从子进程、worker 或通过网络发送此对象，则无需进行字符串化。它将像任何其他普通对象一样自动字符串化和解析

Answer 12

您可以使用纯 javascript 中的单行 (errStringified) 解决此问题：

var error = new Error('simple error message');
var errStringified = (err => JSON.stringify(Object.getOwnPropertyNames(Object.getPrototypeOf(err)).reduce(function(accumulator, currentValue) { return accumulator[currentValue] = err[currentValue], accumulator}, {})))(error);
console.log(errStringified);

它也适用于DOMExceptions。

Answer 13

字符串构造函数应该能够字符串化错误

try { 
  throw new Error("MY ERROR MSG")
} catch (e) {
  String(e) // returns 'Error: MY ERROR MSG'
}