JavaScript 中怎么规范企业级架构中统一的错误抛出与捕获日志契约

陌雪吖_4388

陌雪吖_4388

2026-09-28

422人浏览

原创

企业级应用应统一错误构造、分层捕获、结构化日志与前端协同:定义继承error的语义化错误类,含code/status/meta/message字段;controller层统一兜底并返回标准响应;日志需注入traceid等上下文;前端按code驱动文案、重试与上报。

javascript 中怎么规范企业级架构中统一的错误抛出与捕获日志契约

统一错误构造:用自定义错误类封装业务语义

企业级应用中,不建议直接抛出字符串或原生 Error 实例。应定义继承自 Error 的层级化错误类,如 BusinessError、ValidationError、NetworkError,并强制携带标准字段:

  • code:机器可读的错误码(如 "USER_NOT_FOUND"),用于前端分流、监控告警和多语言映射
  • status:HTTP 状态码(如 404、422),便于网关/中间件统一处理
  • meta:结构化上下文(如 { userId: "u_123", traceId: "t-abc" }),支持问题定位与链路追踪
  • message:面向开发者的简明英文描述(非用户提示),保持一致性,避免拼写/时态混乱

示例:

class ValidationError extends Error {
  constructor(message, code, meta = {}) {
    super(message);
    this.name = 'ValidationError';
    this.code = code;
    this.status = 422;
    this.meta = { ...meta };
  }
}

分层捕获策略:按职责边界明确 try/catch 位置

不是所有地方都该写 try/catch。企业架构中应遵循“谁创建上下文,谁负责兜底”原则:

  • Controller 层:唯一允许向客户端返回错误响应的位置。统一用 try/catch 捕获所有下游异常,转换为标准 JSON 响应(含 code、message、traceId)
  • Service 层:不主动 catch,但可抛出语义化错误(如 throw new InsufficientBalanceError(...)),让上层决定如何响应
  • DAO / SDK 层:将原始异常(如数据库超时、Axios reject)包装为领域错误,隐藏技术细节,例如把 axios timeout 转为 NetworkTimeoutError

避免在工具函数、纯计算逻辑中捕获并静默吞掉错误——这会切断调用链,增加排查成本。

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

日志契约:结构化输出 + 上下文注入

日志不是 console.error(e) 就完事。需建立日志规范,确保每条错误日志包含:

  • 固定字段:level="error"、timestamp、service="user-service"、traceId(来自请求头或生成)、spanId(如使用 OpenTelemetry)
  • 错误主体:序列化 e.code、e.status、e.message、e.stack(生产环境可裁剪敏感行)
  • 运行时上下文:当前用户 ID、请求路径、方法、关键入参(脱敏后)、Node 版本、部署环境(prod/staging)

推荐使用 pino 或 winston 配合 cls-hooked(或 async_hooks)实现请求生命周期内的上下文自动注入,避免手动传递 traceId。

前端协同:错误码驱动的用户反馈与重试机制

后端错误码需与前端约定映射表,形成双向契约:

  • 前端根据 error.code 决定展示文案(通过 i18n key 查表),而非依赖 message 字符串匹配
  • 对幂等性明确的错误码(如 "ORDER_ALREADY_PAID"),前端可自动跳转,不弹通用报错
  • 对临时性错误(如 "NETWORK_TIMEOUT"、"RATE_LIMIT_EXCEEDED"),前端 SDK 自动触发退避重试,无需业务代码重复判断
  • 所有未识别的 code 必须上报监控系统,并触发告警,防止契约漂移

可在构建时校验前后端 error code 枚举是否一致,作为 CI 检查项之一。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

javascript java

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

相关专题

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

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

2023.06.20

4266

5

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

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

2023.07.04

1089

3

js四舍五入
js四舍五入

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

2023.07.04

4184

6

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

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

2023.09.01

860

4

JavaScript转义字符
JavaScript转义字符

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

2023.09.04

1736

5

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

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

2023.09.04

3105

4

如何启用JavaScript
如何启用JavaScript

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

2023.09.12

4033

6

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

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

2023.09.20

2600

5

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

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

2023.09.20

848

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.5万人学习