云函数 - 错误日志打印

背景:云函数开发中,日志的打印直接通过console.log,这些日志会被自动采集。而打印对象前,先使用JSON.stringify(obj)将对象转换为相应的字符串。问题由此产生。

先看下面的代码

const err = new Error('I am error');
const errStr = JSON.stringify(err);
console.log(errStr);
// {}

这里并没有如我们预期的一样输出含有错误信息的字符串,而是打印了空对象对应的花括号。
MDN上关于JSON.stringify的序列化规则如下:

  • 转换值如果有 toJSON() 方法,该方法定义什么值将被序列化。
  • 非数组对象的属性不能保证以特定的顺序出现在序列化后的字符串中。
  • 布尔值、数字、字符串的包装对象在序列化过程中会自动转换成对应的原始值。
  • undefined、任意的函数以及 symbol 值,在序列化过程中会被忽略(出现在非数组对象的属性值中时)或者被转换成 null(出现在数组中时)。函数、undefined 被单独转换时,会返回 undefined,如JSON.stringify(function(){}) or JSON.stringify(undefined).
  • 对包含循环引用的对象(对象之间相互引用,形成无限循环)执行此方法,会抛出错误。
  • 所有以 symbol 为属性键的属性都会被完全忽略掉,即便 replacer 参数中强制指定包含了它们。
  • Date 日期调用了 toJSON() 将其转换为了 string 字符串(同Date.toISOString()),因此会被当做字符串处理。
  • NaN 和 Infinity 格式的数值及 null 都会被当做 null。
  • 其他类型的对象,包括 Map/Set/WeakMap/WeakSet,仅会序列化可枚举的属性。

从最后一条规则可以看出,JSON.stringify只会对可枚举的属性进行序列化。
回到最初的问题,对Error的实例进行json序列化,为何会输出代表空对象的花括号呢?
写一个简单的测试输出

const err = new Error('demo')
console.log(err.prototype.propertyIsEnumerable('name'))
console.log(err.prototype.propertyIsEnumerable('message'))
console.log(err.prototype.propertyIsEnumerable('stack'))
// false
// false
// false

Error的实例中,用于log的几个属性都是不可枚举的。因此输出花括号也就在情理之中。但是如何把Error中的信息序列化成字符串呢?

方案也可以从上面序列化的原则中推导出来

    1. 让属性变成可枚举
    1. 实现toJSON方法
修改属性的可枚举特性
const err = new Error('demo');
Object.defineProperty(err, 'message', {
    enumerable: true,
});
Object.defineProperty(err, 'stack', {
    enumerable: true,
});

很容易联想到使用Object.defineProperty修改属性的相关特性,通过上面的修改后就可以序列化指定的属性及相应的值。
可是Error在不同的运行环境(node/浏览器 .etc)中,其属性值列表的支持性有些许差别,如何能在不需要知道有哪些属性需要枚举的前提下,实现序列化呢?可以使用toJSON结合getOwnPropertyNames,构造序列化的字符串数据。

实现toJSON方法

先看看Object.getOwnPropertyName在MDN上的解释

Object.getOwnPropertyNames() returns an array whose elements are strings corresponding to the enumerable and non-enumerable properties found directly in a given object obj

这个方法会返回给定对象的字符串类型属性(包含可枚举和不可枚举)列表,而在ES6+,数值类型的属性也会返回。基于此,在toJSON方法中将其返回为一个属性均为可枚举的对象就可以了。

Error.prototype.toJSON = function() {
    const keys = Object.getOwnPropertyNames(this);
    const obj = Object.create(null);
    keys.forEach((k) => {
        obj[k] = err[k];
    });
    return obj;
};
const err = new Error('demo')
console.log(JSON.stringify(err))
// error stack message

不仅Error如此,对于其他存在不可枚举属性的对象道理也是相通,属性是否可枚举不仅影响到对象的序列化,对于其他一些运算(如解构运算)同样会有影响,在日常开发中需要小心谨慎,对API的特性了解得更为清晰才能少踩坑。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,290评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,399评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,021评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,034评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,412评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,651评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,902评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,605评论 0 199
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,339评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,586评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,076评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,400评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,060评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,083评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,851评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,685评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,595评论 2 270

推荐阅读更多精彩内容