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.go,net/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 层的代码
}
相关推荐
小满zs9 小时前
Go语言第十八章(架构设计)
后端·go
FungLeo1 天前
成为全栈·Go 后端篇·三轮代码审阅之后:把可读性和证据做成工程规则
golang·go·ast·静态检查·成为全栈·代码审阅
我不会起名字3221 天前
Redis 从 0 到 1(二十八):Redis 抖一下,重试把它打挂了——超时/重试/熔断的 Go 封装
redis·go·超时·熔断·重试
xyzzklk1 天前
变相解决华为Mate 8锁屏后无法建立入站网络连接
linux·运维·服务器·网络·华为·go·安卓
vipxieliang2 天前
语言对比卡:PHP vs Go vs Java 的优缺点、适用场景与「为什么选 PHP」
java·go·php
我不会起名字3223 天前
Redis 从 0 到 1(二十七):JSON 体积是 Protobuf 的 3.7 倍?3 种序列化的 Go 基准测试
redis·go·序列化·protobuf·messagepack
我不会起名字3223 天前
Redis 从 0 到 1(二十三):一个热 key 打到 10 万 QPS——hotkey 与本地缓存的 Go 实现
redis·缓存·go·qps·hotkey
Patrick_Wilson4 天前
Go 为什么需要 defer?从函数怎么收尾说起
后端·go·编程语言
Patrick_Wilson4 天前
从文本输出理解 Go 方法与接口
后端·go·编程语言
Patrick_Wilson4 天前
读懂一个 Go JSON 处理函数:从输入数据追踪结构体、校验与错误返回
go·json·编程语言