Go命名规则【1】文件命名的“潜规则”

cron下面有一个刷新缓存的文件,我原来是refresh_cache.go,标准写法是这样的么?还是refreshCache.go?还是refresh-cache.go

在 Go 语言中,文件命名有一套非常明确的"潜规则"。对于你的 refresh_cache.go,建议如下:

1. 结论:首选 refresh_cache.go (下划线命名)

在 Go 项目中,小写 + 下划线 是最标准、最常见的写法。

  • refresh_cache.go:推荐。符合 Go 社区主流习惯,清晰易读。
  • refreshCache.go:不推荐。Go 的文件名几乎不使用驼峰式(驼峰通常只用于变量、结构体和函数名)。
  • refresh-cache.go:不推荐。中划线在某些构建工具或特定场景下可能会引起误解,Go 官方标准库中极少见到。

2. 为什么选下划线?

Go 的源码(标准库)几乎统一使用下划线命名法。

  • 例如:runtime/internal/atomic/atomic_test.gonet/http/internal/chunked_test.go
  • 系统适配性:下划线在所有操作系统(Windows, Linux, macOS)的文件系统中兼容性最好,且不会因为大小写敏感问题导致编译失败。

3. 更进阶的"Go 味道"写法

如果你的 cron 目录下有很多文件,Go 开发者有时会追求更短的命名,或者根据功能命名:

  • 如果该目录下只有缓存相关的定时任务:可以直接叫 cache.go
  • 如果是一个具体的清理动作:可以叫 clear_cache.go

4. 目录组织建议

既然你在做微服务,cron 目录下的代码组织通常有两种风格:

  • 风格 A(平铺式):

    复制代码
    internal/cron/
    ├── refresh_cache.go
    ├── sync_order.go
    └── scheduler.go  // 用于注册所有定时任务的入口
  • 风格 B(模块化):如果某个任务特别复杂。

    复制代码
    internal/cron/
    └── cache_task/
        ├── handler.go
        └── loader.go

总结

直接把文件名定为 refresh_cache.go 即可。

另外提醒一点:在 refresh_cache.go 内部,定义的函数名应该是驼峰式的,例如:

复制代码
package cron

// 函数名要大写驼峰(如果要被外面调用)
func RefreshCacheHandler() {
    // 调用 logic 层的代码
}
相关推荐
ArixBit18 小时前
用 Go 手撸 Agent 框架 #11:工具从哪里来——内置工具、MCP 与 Skills
go·agent
程序员爱钓鱼20 小时前
为什么学习 Go?Go 能做什么?
后端·面试·go
用户095367515831 天前
在系统的学习 redis 前的疑惑
redis·go
名字还没想好☜2 天前
Go 用 errgroup 管理并发子任务:错误收敛、取消传播与限流
开发语言·后端·golang·go·并发
labixiong2 天前
TypeScript 7.0 编译器用 Go 重写,速度暴增10倍——背后到底做了什么?
前端·javascript·go
名字还没想好☜2 天前
Go 的 time.Ticker 陷阱:定时任务里被忽略的内存泄漏与正确关闭
java·数据库·golang·go·定时器
ArixBit3 天前
用 Go 手撸 Agent 框架 #10:用自己的 Runtime,做一个研究助手
go·agent
cocoCola916673 天前
validator库参数校验若干实用技巧
go
不会C语言的男孩3 天前
第三章:流程控制
go
名字还没想好☜4 天前
Go 的 sync.Pool 实战:复用对象把 GC 压力打下来
开发语言·后端·性能优化·golang·go