错误信息怎么写，才能帮未来的自己

// 改之前：只知道失败了，不知道为什么
try {
  const data = await fs.readFile(filePath)
  return JSON.parse(data.toString())
} catch (err) {
  throw new Error('file error')
}

// 改之后：动作 + 上下文 + 原因 + 下一步
async function loadMetaConfig(filePath: string) {
  try {
    const raw = await fs.readFile(filePath, 'utf-8')
  } catch (err) {
    const code = (err as NodeJS.ErrnoException).code
    throw new Error(
      `读取文章分类配置失败 [文件: ${filePath}]` +
      (code === 'ENOENT'
        ? ' — 文件不存在，请检查 CONFIG_PATH 环境变量是否指向正确目录'
        : code === 'EACCES'
          ? ' — 权限不足，请检查当前用户是否有读取权限'
          : ` — 系统错误码: ${code}`)
    )
  }
 
  try {
    return JSON.parse(raw)
  } catch (err) {
    throw new Error(
      `解析配置文件 JSON 失败 [文件: ${filePath}] — ` +
      `请检查 JSON 语法是否正确（常见原因：多余逗号、缺少引号）`
    )
  }
}

{
  "error": "something went wrong"
}

{
  "type": "https://api.example.com/errors/quota-exceeded",
  "title": "请求配额已用尽",
  "status": 429,
  "detail": "当前 API Key 本小时已使用 1000 次请求，达到速率限制上限",
  "instance": "/api/v1/articles?page=42",
  "retryAfter": 1800
}

// 面向用户的提示：简洁、可操作、不带技术细节
function getUserMessage(error: AppError): string {
  switch (error.code) {
    case 'INVALID_EMAIL':
      return '邮箱格式不正确，请检查后重新输入'
    case 'QUOTA_EXCEEDED':
      return '今日免费额度已用完，明天再试试，或升级套餐'
    default:
      return '出了点问题，请稍后重试（错误编号：' + error.requestId + '）'
  }
}
 
// 面向开发者的日志：完整上下文、方便排查
function logError(error: AppError, context: RequestContext) {
  logger.error({
    message: error.message,
    code: error.code,
    requestId: context.requestId,
    userId: context.userId,
    path: context.path,
    queryParams: context.queryParams,
    stack: error.stack,
    timestamp: new Date().toISOString(),
  })
}

// ❌ 反模式：万能错误
throw new Error('failed')
 
// ✅ 改进：动作 + 目标 + 原因
throw new Error(`数据库查询失败 [表: articles, 条件: categoryId=${categoryId}] — 连接超时(30s)，请检查数据库服务状态`)
 
// ❌ 反模式：只说结果
throw new Error('Invalid input')
 
// ✅ 改进：具体字段 + 期望格式
throw new Error(
  `参数校验失败 [字段: publishDate] — ` +
  `期望格式: ISO 8601 (如 2026-06-25)，实际值: "tomorrow"`
)
 
// ❌ 反模式：泄露内部实现
res.status(500).json({ error: err.stack })
 
// ✅ 改进：分层响应
res.status(500).json({
  type: 'https://api.example.com/errors/internal-error',
  title: '服务器内部错误',
  detail: '文章发布服务暂时不可用，请稍后重试',
  requestId: context.requestId,
})
// 堆栈信息写入日志系统，不返回给客户端

// 错误码定义 — 字符串格式，自文档化
const ErrorCodes = {
  // 认证类
  AUTH_TOKEN_EXPIRED: 'AUTH_TOKEN_EXPIRED',
  AUTH_INVALID_CREDENTIALS: 'AUTH_INVALID_CREDENTIALS',
 
  // 资源类
  ARTICLE_NOT_FOUND: 'ARTICLE_NOT_FOUND',
  ARTICLE_ALREADY_PUBLISHED: 'ARTICLE_ALREADY_PUBLISHED',
 
  // 校验类
  VALIDATION_FIELD_REQUIRED: 'VALIDATION_FIELD_REQUIRED',
  VALIDATION_FORMAT_INVALID: 'VALIDATION_FORMAT_INVALID',
 
  // 限流类
  RATE_LIMIT_EXCEEDED: 'RATE_LIMIT_EXCEEDED',
  QUOTA_EXCEEDED: 'QUOTA_EXCEEDED',
} as const
 
// 消费方可以精确匹配
if (error.code === ErrorCodes.AUTH_TOKEN_EXPIRED) {
  await refreshToken()
  retry()
}

try {
  await publishArticle(article)
} catch (err) {
  throw new Error(
    `发布文章失败 [articleId: ${article.id}] — 推送通知服务不可用`,
    { cause: err }
  )
}
// 日志里可以看到完整的错误链：外层是「发布失败」，cause 里是「通知服务连接超时」

// 可预期的业务错误：用 warn，不需要告警
logger.warn({
  message: '用户登录失败',
  code: 'AUTH_INVALID_CREDENTIALS',
  userId: user.id,
  // 不记录密码等敏感字段
})
 
// 不可预期的系统错误：用 error，触发告警
logger.error({
  message: '数据库连接池耗尽',
  activeConnections: pool.size,
  waitingRequests: pool.waiting,
  lastQuery: sanitizeQuery(lastQuery),
})
 
// 调试信息：用 debug，开发环境才输出
logger.debug({
  message: '文章查询参数',
  filters,
  pagination,
  executionTime: Date.now() - startTime,
})

await expect(loadMetaConfig('/nonexistent/path.json'))
  .rejects.toThrow(/文件不存在/)
 
await expect(loadMetaConfig('/bad-format.json'))
  .rejects.toThrow(/JSON 格式/)

// ❌ 翻译腔，用户不知道具体要求
const validate = (value: string) => {
  if (!value) return '此字段为必填项'
  if (value.length < 6) return '输入长度不符合要求'
  return ''
}
 
// ✅ 说清哪个字段、什么要求、给个示例
const validate = (value: string) => {
  if (!value) return '密码不能为空'
  if (value.length < 6) return '密码至少 6 个字符，当前输入了 ' + value.length + ' 个'
  if (!/[A-Z]/.test(value)) return '密码需要包含至少一个大写字母'
  return ''
}

// ❌ 默认 fallback：用户懵、开发者也懵
class ErrorBoundary extends React.Component<
  { children: React.ReactNode },
  { hasError: boolean }
> {
  state = { hasError: false }
 
  static getDerivedStateFromError() {
    return { hasError: true }
  }
 
  render() {
    if (this.state.hasError) {
      return <h1>出错了</h1>
    }
    return this.props.children
  }
}
 
// ✅ 改进：记录错误上下文、给用户可操作的反馈
function ErrorFallback({ error, resetErrorBoundary }: {
  error: Error
  resetErrorBoundary: () => void
}) {
  // 错误详情发送到日志系统
  useEffect(() => {
    logger.error({
      message: error.message,
      stack: error.stack,
      url: window.location.href,
      userAgent: navigator.userAgent,
    })
  }, [error])
 
  return (
    <div role="alert">
      <h2>页面加载遇到了问题</h2>
      <p>请尝试刷新页面，如果问题持续出现，请联系支持团队并提供以下编号：</p>
      <code>{generateErrorId()}</code>
      <button onClick={resetErrorBoundary}>重试</button>
    </div>
  )
}