前言
在进行前端开发的过程中,难免会遇到一些意想不到的错误,这时候排查错误就显得尤为重要。ohcrash 是一个能够帮助开发者更好地排查和定位错误的 npm 包,下面是这个包的使用教程。
安装
首先,需要在项目目录下使用以下命令安装 ohcrash:
npm install ohcrash
常规用法
在项目初始化的时候,需要在 js 的入口文件中引入 ohcrash,如下面的例子:
-- -------------------- ---- ------- ------ ------- ---- --------- ----- -- - -------------- ---- ------------------------------------ -------- -------------------- ----- - --- --------- - -- --------- - --
这里需要传入参数 url,代表错误日志上报的地址。接下来的 project 参数表示项目名称,可以用来区分不同项目的错误,而 user 参数表示当前用户的id,方便追踪错误来源。
在初始化完成之后,ohcrash 会自动监听 unhandledrejection、error 两个事件,在事件触发时会自动上报错误信息。
ohcrash 还可以在开发的时候手动记录一条错误信息,如下所示:
oh.log({ message: 'Hello World', level: 'error', })
这里的 message 参数表示错误信息的描述,而 level 参数则代表错误的等级,包括 error、warning、log 等。
高级使用
ohcrash 还支持在错误上报之前对错误进行筛选、处理以及上报前的拦截等操作,使得我们能够更好地处理和追踪错误信息。
下面是 ohcrash 支持的高级操作:
过滤错误
在你在某些场景下不需要上传错误信息时,你可以使用 filter
方法,来动态判断是否上报信息。filter
接收一个参数,代表了需要上传的错误信息。
oh.filter(function (report) { return true; //根据业务规则动态判断是否上报错误 })
错误信息转换
为了更好的理解和判断错误信息,ohcrash 支持将错误信息转换为需要的格式,如下列示:
oh.transform(function (report) { report.url = window.location.href return report })
这里,我们对 url
参数进行了转换,将当前链接地址添加到了错误信息中。
拦截器
如果你需要对错误信息进行二次处理,你可以使用拦截器,如下所示:
-- -------------------- ---- ------- ------------------- -------- -------- -------- - ----- - ----- ---- - - ------ -------------- - ------------------- --------------- - -------------------- ------------------- - -------------------- ------ ----------- ------ ----------- ------ ------ -- --------- -------- ----- - ------------------------ ----------- ---- ------ -------------------- -- ------ -------- ----- - ------------------------ -------- ---- ------ ------------------- -- --
这里拦截器接收一个参数,包含了三个函数,分别是请求拦截器、响应拦截器和错误拦截器。
总结
本文介绍了 ohcrash npm 包的用法,包含了常规用法以及高级操作的实现方法。ohcrash 提供了非常方便的路径,帮助我们轻松地排查和定位错误信息,提升了我们开发的效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/69285