使用Object.definedproperty实现一个前端日志sdk

一、功能点

  • 日志回调
  • 环境区分
  • 错误捕获及上报
  • 日志信息获取及手动上报功能

二、功能点详解

1、日志回调

在用户对console.log进行修改时,以执行队列的形式对用户所修改的函数进行存储,并在用户对console.log进行调用时,执行原输出函数的同时,执行该执行队列。

2、环境区分
  • 当判断当前执行环境为开发环境时,仅进行错误显示、信息输出,而不进行错误上报。
  • 当判断当前执行环境为测试环境时,进行错误显示、信息输出、错误上报。
  • 当判断执行环境为生产环境时,仅进行错误上报。

三、技术要点分析

1、使用Object.definedProperty对window.console.log进行重写

首先,为了将用户调用console.log的输出内容进行存储,以便再发生错误时进行上报,就需要对该函数进行重写,或代理,劫持。而实现这一目的的方法有三个,第一,直接使用函数对其进行改写。第二,使用proxy进行代理,第三,使用Object.definedProperty

1)直接改写方法
console.log = function(){
// ...实现功能
}

这样做的优点是简单,直接上来就用一个函数覆盖原本的,如果需要在改写的方法中使用原来的功能,则需要在改写前对原函数进行存储,再在改写的函数中使用存下来的那个方法,这样就可以实现对原来功能的使用。
而缺点也很明显,如果用户在使用的过程中,再一次对console.log进行改写,去实现他们自己定义的功能,那么这个工具的功能将在用户改写后无法再使用,除非用户像刚刚那样,事先对你的这个工具也进行一个存储。另外,这也无法满足我们“在实现本sdk功能的基础上对用户改写的函数进行存储并执行”的需求。所以放弃这个方法。

2)使用proxy

proxy是ES6的一个功能,顾名思义,它用于实现对对象的代理。vue.js框架也放弃了原本使用Object.definedProperty实现双向数据绑定的方式,改用proxy。相对于第一种方法,它是在用户对对象属性进行调用或改写的时候触发所定义的getter setter以进行代理,这样可以在用户使用console.log时调用我们自定义的方法,并在用户对console.log进行改写时进行拦截,并进行处理。可以实现我们的所有需求。
而缺点则是兼容性较差,在低版本的IE浏览器可能无法使用。

3)Object.definedProperty

其实对于本项目来说,proxyObject.definedProperty都是可以满足需求的,甚至proxy相对来说性能、功能各个部分表现均优于Object.definedProperty。而选用Object.definedProperty则是为了满足对低版本浏览器的兼容需求。

2、环境区分

首先,因为我们的项目部分使用了前后端分离的开发模式,所有的前端资源均存储在特定的服务器,后端仅需指定html文件,在这个获取到的文件中包含了请求所需打包前端资源的请求,这样就拿到本项目需要的前端资源。这是对于开发环境的限定是通过对url进行search拼接实现的,那么自然可以通过判断当前url确定当前的开发环境。但是,对于部分没有进行前后端分离的项目来说,这样的方法自然时行不通的。所以需要使用其他方法进行环境的区分。
在本项目中,使用了用户自定义环境的方法,在暴露的接口中包括了一个写入环境的接口,通过这个接口进行变量修改,并根据修改后的变量进行环境的确定,默认为开发环境。

3、错误捕获

对于前端的错误捕获,主要包括执行时错误、 资源获取错误、promise错误等等等等。
分享一篇文章如何优雅处理前端异常?

我就不多写了 -。-

4、错误上报

进行数据发送的方法有很多,原生的xhr、封装的axiosfetch等等,都是前端发送数据的常用方法,而作为一个sdk,轻量是第一要求,为了让sdk不那么重,我们放弃所有外部方法,而选用了form表单进行postimage进行get。另外,form发送的数据不是json,而是application/x-www-form-urlencoded,在后端进行数据获取时需要注意。
我们仅考虑数据上报而无需接受回应,且使用image进行get请求也无需考虑跨域问题。现网上相关信息很多,不再赘述,直接上代码

(new Image).src = '地址?数据1&数据2'

对于大量的数据,get方法自然是无法满足的,get方法仅在用户手动上报时可能会使用,而日志信息的上报由于数据量的限制,所以我们使用form表单实现post发送。

const iframe = document.createElement('iframe');
iframe.style.display = 'none';
iframe.name = 'postLog_iframe';
document.body.appendChild(iframe);

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

推荐阅读更多精彩内容