为什么Go error不建议使用大写开头_Go Error命名规范说明

Go 中 error 字符串不建议以大写字母开头,因其面向日志与错误链拼接,小写更符合英文习惯、便于工具处理且符合标准库与 linter(如 ST1012)规范;而 error 常量名需大写以导出。

Go 中 error 字符串不建议以大写字母开头,核心原因是为了保持错误链(error chain)的语义连贯性和可组合性,而非语法限制或导出规则问题。

错误字符串是描述性文本,不是标识符

error 类型的值本质是字符串描述(如 errors.New("invalid input")),它面向的是日志、调试和用户提示场景,不是 Go 的导出标识符。大小写规则对变量、函数、类型生效,但对 error 值的内容本身没有可见性控制作用。

  • 首字母大写会让错误消息像“句子开头”,破坏嵌套错误时的自然拼接。例如:
    fmt.Errorf("failed to read config: %w", ErrPermissionDenied) → 若 ErrPermissionDenied.Error() 返回 "Permission denied"(大写 P),拼出来就是 "failed to read config: Permission denied",中间缺连词且大小写突兀;而小写 "permission denied" 拼接后更符合英文习惯:"failed to read config: permission denied"
  • 标准库全部采用小写开头:如 io.EOF 返回 "EOF"(全大写是特例,因是缩写),os.ErrNotExist 返回 "no such file or directory"http.ErrUseLastResponse 返回 "use last response"

避免与导出标识符混淆

error 常量名(如 ErrTimeout)必须大写开头——这是为了导出,让其他包能引用它;但它的 Error() 方法返回的字符串内容应小写开头,二者职责分离:

  • 常量名ErrTimeout):是 Go 标识符,需导出 → 首字母大写
  • 错误消息"timeout occurred"):是人类可读文本,用于日志和链式包装 → 首字母小写

工具链和社区共识已形成约束

golangci-lint 等主流 linter 明确检查 ST1012 规则:error strings should not be capitalized。这不是风格偏好,而是工程实践沉淀:

  • 统一格式便于 grep、日志聚合系统提取关键词(如匹配 "invalid.*" 不受大小写干扰)
  • fmt.Errorf 的占位逻辑天然契合:它默认把被包装的 error 当作补全部分,小写开头才能自然融入主句
  • 第三方错误库(如 pkg/errorsgithub.com/pkg/errors 及现代 errors.Join/fmt.Errorf(...%w))都默认按小写上下文设计堆栈和消息展开

基本上就这些。关键记两点:常量名大写,错误消息小写——分工明确,不复杂但容易忽略。