使用JSON.stringify无法将错误字符串化吗？

重现问题

尝试使用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时卸下的所有功能，但后来意识到它也有一些怪异的行为：

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

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

问题

有什么办法可以将本机错误消息字符串化JSON.stringify吗？如果没有，为什么会出现这种现象？

解决这个问题的方法

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

更新

@Ray Toal在评论中建议我看一下属性描述符。现在很清楚为什么它不起作用：

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。

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

您可以定义Error.prototype.toJSON来检索Object表示的纯文本Error：

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()可能没有Error专门针对它进行定义，但通常该方法仍针对对象进行了标准化（参考：步骤3）。因此，冲突或冲突的风险很小。

不过，为了完全避免它，可以使用JSON.stringify()的replacer参数代替：

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

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

        return error;
    }

    return value;
}

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

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

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

似乎有效

[ 摘自/ u / ub3rgeek在/ r / javascript上的评论]和felixfbecker的评论（下方）

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

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

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

回答

从JSON.stringify（）的文档中，

对于所有其他Object实例（包括Map，Set，WeakMap和WeakSet），仅将其可枚举的属性序列化。

并且Errorobject没有其可枚举的属性，这就是为什么它打印一个空对象的原因。

修改乔纳森（Jonathan）的绝妙答案以避免猴子打补丁：

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'));

有一个伟大的Node.js包为：serialize-error。

它甚至可以很好地处理嵌套的Error对象，这实际上是我在项目中急需的。

https://www.npmjs.com/package/serialize-error

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

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

也许还有stack财产。

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

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

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))

上面的答案似乎都没有正确序列化Error原型上的属性（因为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}}}  

我正在为日志追加程序处理JSON格式，最终在这里试图解决类似的问题。过了一会儿，我意识到我可以让Node来工作：

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