如何编写能自动记录异常日志的异步工具库?

阿丽大大_1628

阿丽大大_1628

2026-06-05

275人浏览

原创

自动记录异常日志的异步工具库需统一拦截全局未处理异常、提供带上下文捕获的wrapasync包装器、异步容错写入、结构化json日志及动态上下文注入能力。

如何编写能自动记录异常日志的异步工具库?

要编写能自动记录异常日志的异步工具库,核心是把异常捕获、上下文提取、日志格式化和异步写入这几个环节封装成可复用、不侵入业务逻辑的机制。关键不在“记录”,而在“自动”——即无需每个 await 处手动 try-catch,也能兜住未处理的 Promise 拒绝和未捕获异常。

统一拦截未处理的异步异常

Node.js 和现代浏览器都支持监听全局异步拒绝事件。这是实现“自动”的起点:

  • 在 Node.js 中监听 unhandledRejection 和 uncaughtException 事件,捕获未 await 或未 catch 的 Promise 拒绝和同步异常
  • 在浏览器中监听 window.onunhandledrejection 和 window.onerror,注意 onerror 无法捕获 Promise 拒绝,必须配合 unhandledrejection
  • 拦截后不要直接 console.error,而是调用你库内部的标准化日志函数,确保带上时间、环境、堆栈、请求 ID(如有)等字段

提供带错误捕获能力的异步包装器

光靠全局监听不够:它无法关联业务上下文(比如哪个 API 调用失败、用户 ID 是什么)。你需要提供轻量级包装工具,让开发者一键增强函数:

Makefun
Makefun

Makefun是一款AI文本写作工具,无限制一站式 AI 视频生成平台。

下载
  • 导出一个 wrapAsync 工具函数,接收 async 函数和可选配置(如日志级别、额外字段、是否重抛)
  • 内部自动 try/catch,捕获异常后合并执行上下文(如函数名、参数摘要、traceId),再交由日志管道处理
  • 示例:const getUser = wrapAsync(async (id) => { ... }, { tag: 'user-service' }),调用时出错即自动记录,无需额外写 catch

异步日志写入不阻塞主流程

日志本身不能拖慢业务。所有日志操作必须真正异步且有容错:

  • 使用 fs.promises.appendFile(Node)或 console.log + 后台上报(浏览器),避免同步 I/O
  • 为防止日志写入失败导致异常丢失,加一层内存缓冲(如队列)+ 降级策略(失败时 fallback 到 console 或内存快照)
  • 支持可选的批量提交与定时 flush,减少 I/O 频次;也支持立即写入(debug 场景)

支持结构化与可扩展的日志格式

自动记录的价值,取决于日志是否便于查询和归因:

  • 默认输出 JSON 行格式(每条日志一行 JSON),包含 timestamp、level、message、stack、context(自定义字段)、type: 'unhandled-rejection' 等标识
  • 暴露 addLogContext 方法,允许在请求入口(如 Express middleware 或 React useEffect)动态注入 traceId、userId 等,后续所有自动日志自动携带
  • 预留 transformLog 钩子,方便对接 Sentry、ELK 或云厂商日志服务
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4566

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1129

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4484

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

900

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1796

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3265

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4233

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2760

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

888

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习