错误码指南

语言: English | 简体中文

版本: 1.0.0 最后更新: 2025-12-30 适用范围: Claude Code Skills

核心标准：本技能实现错误码标准。完整的方法论文档请参阅核心标准。

目的

此技能帮助设计一致的错误码，遵循标准格式，实现更好的除错、监控和使用者体验。

快速参考

错误码格式

<前缀>_<类别>_<编号>

| 元素 | 说明 | 范例 | |------|------|------| | 前缀 (PREFIX) | 应用/服务识别码 | AUTH, PAY, USR | | 类别 (CATEGORY) | 错误类别 | VAL, SYS, BIZ | | 编号 (NUMBER) | 唯一数字识别码 | 001, 100, 404 |

范例

AUTH_VAL_001    → 认证验证错误
PAY_SYS_503     → 付款系统无法使用
USR_BIZ_100     → 使用者商业规则违规
API_NET_408     → API 网络逾时

错误类别

| 类别 | 全名 | 说明 | HTTP 状态码 | |------|------|------|-------------| | VAL | Validation | 客户端输入验证失败 | 400 | | BIZ | Business | 商业规则违规 | 422 | | SYS | System | 内部系统错误 | 500 | | NET | Network | 通讯错误 | 502/503/504 | | AUTH | Auth | 安全相关错误 | 401/403 |

类别编号范围

| 范围 | 说明 | 范例 | |------|------|------| | *_VAL_001-099 | 栏位验证 | 缺少必填栏位 | | *_VAL_100-199 | 格式验证 | 电子邮件格式无效 | | *_VAL_200-299 | 约束验证 | 密码太短 | | *_BIZ_001-099 | 状态违规 | 订单已取消 | | *_BIZ_100-199 | 规则违规 | 超过 30 天无法退货 | | *_BIZ_200-299 | 限制违规 | 超过每日限制 | | *_AUTH_001-099 | 认证 | 帐号密码错误 | | *_AUTH_100-199 | 授权 | 权限不足 | | *_AUTH_200-299 | Token/Session | Token 已过期 |

HTTP 状态码对应

| 类别 | HTTP 状态码 | 说明 | |------|-------------|------| | VAL | 400 | Bad Request | | BIZ | 422 | Unprocessable Entity | | AUTH (001-099) | 401 | Unauthorized | | AUTH (100-199) | 403 | Forbidden | | SYS | 500 | Internal Server Error | | NET | 502/503/504 | Gateway errors |

详细指南

完整标准请参考：

错误码标准

AI 优化格式（节省 Token）

AI 助手可使用 YAML 格式文件以减少 Token 使用量：

基础标准：ai/standards/error-codes.ai.yaml

错误响应格式

单一错误

{
  "success": false,
  "error": {
    "code": "AUTH_VAL_001",
    "message": "电子邮件为必填栏位",
    "field": "email",
    "requestId": "req_abc123"
  }
}

多个错误

{
  "success": false,
  "errors": [
    {
      "code": "AUTH_VAL_001",
      "message": "电子邮件为必填栏位",
      "field": "email"
    },
    {
      "code": "AUTH_VAL_201",
      "message": "密码至少需要 8 个字元",
      "field": "password"
    }
  ],
  "requestId": "req_abc123"
}

内部错误物件

interface ApplicationError {
  // 核心栏位
  code: string;          // "AUTH_VAL_001"
  message: string;       // 技术消息（用于日志）

  // 使用者界面
  userMessage: string;   // 本地化使用者消息
  userMessageKey: string; // i18n 键值: "error.auth.val.001"

  // 上下文
  field?: string;        // 相关栏位: "email"
  details?: object;      // 附加信息

  // 除错
  timestamp: string;     // ISO 8601
  requestId: string;     // 关联 ID
}

国际化 (i18n)

消息键值格式

error.<前缀>.<类别>.<编号>

翻译文件范例

# en.yaml
error:
  auth:
    val:
      001: "Email is required"
      101: "Invalid email format"
    auth:
      001: "Invalid credentials"

# zh-TW.yaml
error:
  auth:
    val:
      001: "電子郵件為必填欄位"
      101: "電子郵件格式無效"
    auth:
      001: "帳號或密碼錯誤"

范例

✅ 良好的错误码

AUTH_VAL_001  // 缺少必填栏位: email
AUTH_VAL_101  // 电子邮件格式无效
ORDER_BIZ_001 // 订单已取消
ORDER_BIZ_201 // 超过每日购买限制
DB_SYS_001    // 数据库查询失败
SEC_AUTH_001  // 帐号密码错误
SEC_AUTH_201  // Token 已过期

❌ 不良的错误码

ERR_001       // 太模糊，没有前缀或类别
INVALID       // 不具描述性
error         // 不是错误码
AUTH_ERROR    // 缺少编号

检查清单

[ ] 每个错误有唯一代码
[ ] 类别符合错误类型
[ ] 使用者消息已本地化
[ ] HTTP 状态码正确
[ ] 错误已记录文件
[ ] 代码已加入注册表

设置侦测

此技能支援项目特定设置。

侦测顺序

检查程序码库中现有的错误码模式
检查 CONTRIBUTING.md 中的错误码指南
若无找到，预设使用 PREFIX_CATEGORY_NUMBER 格式

首次设置

若未找到错误码标准：

建议：「此项目尚未设置错误码标准。您要建立错误码注册表吗？」
建议建立 errors/registry.ts：

export const ErrorCodes = {
  AUTH_VAL_001: {
    code: 'AUTH_VAL_001',
    httpStatus: 400,
    messageKey: 'error.auth.val.001',
    description: '电子邮件栏位为必填',
  },
  // ... 更多错误码
} as const;

下一步引导

/errors 完成后，AI 助手应建议：

错误码设计已完成。建议下一步：

执行 /sdd 将错误码设计纳入正式规格 ⭐ 推荐 — 确保错误码在规格中有完整定义

执行 /logging 设置结构化日志以配合错误码 — 让错误码与日志系统整合

执行 /tdd 为错误处理逻辑编写测试 — 确保每个错误码都有对应的测试

版本历史

| 版本 | 日期 | 变更 | |------|------|------| | 1.0.0 | 2025-12-30 | 初始发布 |

授权

此技能采用 CC BY 4.0 授权。

来源: universal-dev-standards