【问题标题】:Go library package namesGo 库包名
【发布时间】:2015-09-21 23:32:45
【问题描述】:

我对外部 Go 库的包命名有一些疑问。

如果使用像“text”这样的通用名称被认为是一种好习惯,我很感兴趣?考虑到我不能声明“嵌套包”并且我正在构建的库处理文本处理,是否可以将包命名为“text”或者我应该坚持将库名称作为包名称?

我正在构建一组库(不同的项目),我想将它们组合在同一个包下。这也有问题吗?我是 Go 社区的新手,但仍然不确定包污染是否是一个问题(只要我在代码中导入少量包,我就看不到问题)。

【问题讨论】:

    标签: go package names


    【解决方案1】:

    关于该命名主题的参考是“blog: Package names

    它包括:

    避免不必要的包名冲突
    虽然不同目录中的包可能具有相同的名称,但经常一起使用的包应该具有不同的名称。这减少了混淆以及在客户端代码中进行本地重命名的需要。出于同样的原因,请避免使用与 io 或 http 等流行标准包相同的名称。

    还要检查您的package publishing practice,因为它有助于区分您的“text”包与其他人。

    如“An Introduction to Programming in Go / Packages”所示:

    math 是一个包的名称,它是 Go 标准发行版的一部分,但由于 Go 包可以是分层的,我们可以安全地为我们的包使用相同的名称。 (真正的数学包就是数学,我们的是golang-book/chapter11/math

    当我们导入 math 库时,我们使用它的全名 (import "golang-book/chapter11/math"),但在 math.go 文件中,我们只使用名称的最后一部分 (package math)。

    当我们引用库中的函数时,我们也只使用简称 math。如果我们想在同一个程序中使用这两个库,Go 允许我们使用别名:

    import m "golang-book/chapter11/math"
    
    func main() {
      xs := []float64{1,2,3,4}
      avg := m.Average(xs)
      fmt.Println(avg)
    }
    

    m 是别名。


    作为mentioned in the comments by elithrarDave Cheney 有一些additional tips

    在其他语言中,通过在包前面加上公司名称(例如 com.sun.misc.Unsafe)来确保包具有唯一的命名空间是很常见的。
    如果每个人都只写自己控制的域对应的包,那么发生冲突的可能性很小。

    在 Go 中,约定是在包的导入路径中包含源代码的位置,即

    $GOPATH/src/github.com/golang/glog
    

    这不是语言所要求的,它只是一个feature of go get

    【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2017-01-15
    • 1970-01-01
    • 2018-04-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多