Невозможно ли выполнить ошибку с помощью JSON.stringify?
Воспроизведение проблемы
У меня возникает проблема при попытке передать сообщения об ошибках с помощью веб-сокетов. Я могу воспроизвести проблему, с которой я столкнулся, используя 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"}
Функция Replacer
Затем я просмотрел 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
? Если нет, то почему это происходит?
Способы преодоления этого
- Придерживайтесь простых строковых сообщений об ошибках или создавайте личные объекты ошибок и не полагайтесь на собственный объект Error.
- Свойства Pull:
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
.
Принятый ответ обеспечивает обходной путь для этой проблемы.
Ответы
Ответ 1
Вы можете определить 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
специально, метод по-прежнему стандартизирован для объектов в общий (ref: шаг 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));
Ответ 2
JSON.stringify(err, Object.getOwnPropertyNames(err))
похоже, работает
[из комментария от /u/ub 3rgeek on/r/javascript] и комментарий felixfbecker ниже
Ответ 3
Модификация Джонатана - отличный ответ, чтобы избежать патчей обезьян:
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'));
Ответ 4
Поскольку никто не говорит о части "почему", я отвечу на нее.
Почему этот JSON.stringify
возвращает пустой объект?
> JSON.stringify(error);
'{}'
Ответ
Из документа JSON.stringify(),
Для всех других экземпляров Object (включая Map, Set, WeakMap и WeakSet) будут сериализованы только их перечисляемые свойства.
и объект Error
не имеет своих перечисляемых свойств, поэтому он печатает пустой объект.
Ответ 5
Для этого есть большой пакет Node.js: serialize-error
.
Он хорошо обрабатывает даже вложенные объекты Error, чего я на самом деле мне очень нужен в моем проекте.
https://www.npmjs.com/package/serialize-error
Ответ 6
Вы также можете просто переопределить те перечислимые свойства, которые можно перечислить.
Object.defineProperty(Error.prototype, 'message', {
configurable: true,
enumerable: true
});
и, возможно, stack
.
Ответ 7
Ни один из вышеперечисленных ответов, похоже, не правильно сериализовал свойства, которые находятся на прототипе 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}}}
Ответ 8
Нам нужно было сериализовать произвольную иерархию объектов, где корнем или любым вложенным свойством в иерархии могут быть экземпляры 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 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))