Go命名规则【2】全场景命名避坑指南

好乱呀,文件名是下划线分隔,函数名是大小写,那么URL呢?是中划线吗?

Go 语言初学者最容易在这些"起名规范"里绕晕,因为 Go 在不同场景下的审美标准完全不一样。

我帮你整理了一张"全场景命名避坑指南",你按这个表来就不会乱了:

1. 开发中的四大命名规则

场景 推荐格式 示例 理由
文件名 下划线 refresh_cache.go Go 官方标准库风格,兼容性最强。
Go 函数/变量 驼峰式 GetUserInfo / isReady Go 语言强制规范,导出变量首字母必须大写。
URL 路径 中划线 /api/v1/user-profile SEO 友好,且在浏览器地址栏最易读,也是 RESTful 标准。
JSON 字段 下划线 {"user_id": 1} 跨语言标准,前端 JavaScript/Python 处理最顺手。

2. 深度解析:为什么 URL 推荐中划线?

在 HTTP API 设计中,URL 路径(Path)推荐使用 kebab-case(中划线),原因如下:

  • RFC 规范:域名是不区分大小写的,虽然路径区分,但为了统一,大家习惯全部小写。
  • 可读性:/api/user_profile(下划线)在带有下划线的超链接里,下划线会被链接本身的横线遮住,看不清是空格还是符号。而 /api/user-profile 永远清晰。
  • 大厂惯例:Google、GitHub 等主流 API 几乎全部采用中划线。

3. 一个典型的代码片段(串联所有规范)

看这段代码,你就知道它们是怎么共存的了:

复制代码
// 文件名: internal/handler/user_handler.go (下划线)

package handler

// 结构体字段用 JSON 标签定义下划线 (JSON规范)
type UserResponse struct {
    UserName string `json:"user_name"` 
}

// 函数名用驼峰 (Go规范)
func GetUserHandler(c *gin.Context) {
    // 逻辑...
}

// 路由注册 (URL规范)
// 浏览器访问: http://api.com
r.GET("/get-user-info", GetUserHandler) 

4. 总结你的疑惑

  1. 文件:refresh_cache.go
  2. 函数:func RefreshCache()
  3. URL:/api/refresh-cache ✅(如果是内部 API,/api/refresh_cache 也能用,但不标准)

心态建设:

Go 是一门"强迫症"语言。你只需要记住:"给电脑看的文件名用下划线,给人看的网址用中划线,给 Go 编译器看的函数用驼峰"。

相关推荐
名字还没想好☜18 小时前
Go context.AfterFunc 实战(Go 1.21):context 一取消就自动跑清理,告别手写 goroutine 监听 Done
后端·golang·go
liyinchi19882 天前
微信小程序支付遇到“由于小程序违规,支付功能暂时无法使用” 解决办法
java·微信小程序·go
天天喝旺仔2 天前
Go 泛型实战:从类型参数、约束到可复用泛型容器与函数
数据结构·算法·容器·go
gospace3 天前
【无标题】
go·gb28181·gowvp
我不会起名字3223 天前
一天一道算法题(35):电话号码的字母组合
java·数据结构·后端·python·leetcode·go·回溯
江湖十年3 天前
Go GOPROXY 兜底链的坑:从一次诡异的 CI lint 失败说起
后端·面试·go
秋风点枝4 天前
gogogo!go语言感悟大观--打卡day01
go·devops
探索云原生4 天前
KubeClipper 1.7.0 发布:Operation 优化与 Kubernetes 1.37 支持
linux·docker·云原生·kubernetes·go
右耳朵猫AI4 天前
Go周刊2026W37 | Ebitengine 纯 Go 化、simd 重写 TurboPFor、json/v2 落地
后端·微服务·go
福兮说4 天前
Gin 项目里的错误处理:让 Controller 不必知道错误是怎么来的
后端·go·gin·架构设计