本文旨在探讨在编写仅作为命令使用的 Go 单包程序时，命名标识符的最佳实践。核心观点是，与其考虑“公共”或“私有”，不如着眼于“导出”或“不导出”。对于应用程序代码，通常不需要导出任何内容。如果出于组织原因将程序分解为多个包，则可以使用子包。
在 Go 语言中，标识符的可见性由其首字母的大小写决定：大写字母开头的标识符是导出的（exported），可以被其他包访问；小写字母开头的标识符是非导出的（unexported），只能在当前包内使用。 当编写一个独立的、仅作为命令使用的 Go 程序时，应该如何选择标识符的可见性呢？
导出与不导出：思维模式的转变
首先，我们需要转变思维模式。与其考虑“公共”或“私有”，更应该关注“导出”或“不导出”。“导出”意味着该标识符可以被其他包访问，而“不导出”则意味着它只能在当前包内使用。这种思维方式更贴近 C 语言的风格。
单包应用程序：通常无需导出
对于应用程序代码，通常不需要导出任何内容。这意味着你可以将所有标识符都命名为非导出的，即以小写字母开头。这样做的好处是：
- 减少 API 表面积： 避免意外地暴露内部实现细节。
- 提高代码的内聚性： 强制将相关代码组织在同一个包内。
- 简化重构： 由于没有外部依赖，可以更自由地修改内部实现。
示例：一个简单的命令行工具
假设我们正在编写一个简单的命令行工具，用于计算字符串的 MD5 值：
package main
import (
"crypto/md5"
"fmt"
"io"
"os"
)
func main() {
if len(os.Args) != 2 {
fmt.Println("Usage: md5sum ")
os.Exit(1)
}
input := os.Args[1]
hash := calculateMD5(input)
fmt.Println(hash)
}
func calculateMD5(text string) string {
hasher := md5.New()
io.WriteString(hasher, text)
return fmt.Sprintf("%x", hasher.Sum(nil))
} 在这个例子中，calculateMD5 函数被声明为非导出的。因为它只是 main 函数的辅助函数，不需要被其他包访问。
使用子包进行组织
如果出于组织原因，你决定将程序分解为多个包，可以使用子包（sub-packages）。子包位于主包的 src 目录下，例如：
projectgopath/src/projectname
projectname/subcomponent1
projectname/subcomponent2这种结构有助于分离关注点，但不会将包的范围扩展到主项目之外。子包的目的是专门为当前程序服务。
示例：使用子包处理配置
假设我们需要将配置处理逻辑从主包中分离出来，可以创建一个名为 config 的子包：
projectgopath/src/myapp
myapp/config
myapp/main.gomyapp/config/config.go:
package config
import "os"
// LoadConfig loads the configuration from environment variables.
func LoadConfig() map[string]string {
config := make(map[string]string)
config["API_KEY"] = os.Getenv("API_KEY")
return config
}myapp/main.go:
package main
import (
"fmt"
"myapp/config"
)
func main() {
cfg := config.LoadConfig()
fmt.Println("API Key:", cfg["API_KEY"])
}在这个例子中，LoadConfig 函数被声明为导出的，因为 main 包需要访问它。
注意事项
- 提前规划： 在编写代码之前，仔细考虑哪些标识符需要导出，哪些不需要。
- 避免过度导出： 只导出必要的标识符，尽量保持内部实现的私有性。
- 重构的灵活性： 如果将来需要将代码提取到单独的库中，可以再考虑导出哪些标识符。
总结
在编写仅作为命令使用的 Go 单包程序时，通常应该将所有标识符都命名为非导出的。如果出于组织原因需要将程序分解为多个包，可以使用子包。 关键在于理解“导出”的含义，并根据实际需要做出选择。 这种方式能够提高代码的内聚性、降低 API 表面积，并简化重构。
