如何创建可运行且支持内部包导入的 Go 模块？

Go 模块允许在不使用 GOPATH 的情况下组织和管理 Go 代码。本指南详细介绍了创建可运行的 Go 模块的步骤，其中包含主文件和内部包，并允许导入其他包。指南还解释了模块化方法与旧方法之间的差异，并提供了将代码从旧方法迁移到模块化方法的说明。

我刚刚发现 Go。当我上周开始研究它时，我发现 GOPATH 以及 Go 显然对存储代码的目录非常有意见。所以我咒骂 Google 的名字并认为 Go 不适合我，然后最近听说了 Go 模块和他们显然解决了这个问题。

问题在于，关于如何构建基于模块的 Go 项目的在线信息似乎非常稀缺。我无法弄清楚如何布置我的代码以及如何调用包以使导入正常工作。我尝试了各种方法并查看了示例，但无论我做什么，我都会收到“未知的导入路径”错误。

基本上，我想要一个包含 main.go 和 library.go 的目录，也许子目录中包含 library.go 。我希望能够在 main.go 中编写 import library 或类似的内容，并能够访问 library.go 的成员。我还希望能够通过输入 go run main.go 来运行代码。这可以实现吗？

解决方案

这很令人困惑，并且文档假定您对 golang 有一定程度的熟悉。我最近一直在尝试理解模块。

以前|当前没有模块的方式：

workdir=[[path-to-your-working-directory]]

mkdir -p ${workdir}/go
export gopath=${workdir}/go
export path=${gopath}/bin:${path}

mkdir -p {${workdir}/go/src/foo, ${workdir}/go/src/foo/bar}

然后创建${workdir}/go/src/foo/bar/library.go：

package bar

func something() (string) {
    return "hello freddie"
}

然后创建${workdir}/go/src/foo/main.go：

package main

import (
    "fmt"
    "foo/bar"
)

func main() {
    fmt.printf("%s", bar.something())
}

你将拥有这样的结构：

.
└── go
    └── src
        └── foo
            ├── bar
            │   └── library.go
            └── main.go

然后您可以通过以下任一方式运行：

go111module=off go run ${workdir}/go/src/main.go
hello freddie!

cd ${workdir}/go/src/
go111module=off go run main.go
hello freddie!

go111module=off go run foo
hello freddie!

模块的新（！）方式：

假设您已完成上述操作！

您不需要执行此步骤，但这是新的最佳实践。我们正在将源移至 ${gopath} 之外。 ${gopath} 仍然用于存储我们的版本化包。 注意 在这个简单的示例中，我们没有使用外部包，因此 ${gopath} 保持为空。

mv ${workdir}/go/src/foo ${workdir}
rm ${workdir}/go/src

你应该有这样的结构：

.
├── foo
│   ├── bar
│   │   └── library.go
│   └── main.go
└── go

注意我们的来源现在位于 ${gopath}

cd ${workdir}/foo

go111module=on go mod init foo
more go.mod
module foo

go 1.12

go111module=on go run foo
hello freddie!

go111module=on go run main.go
hello freddie!

为了完整性

显示与外部包的差异：

no modules 将最新版本的软件包拉入 ${gopath}/src：

go111module=off go get github.com/golang/glog

.
├── foo
│   ├── bar
│   │   └── library.go
│   ├── go.mod
│   ├── go.sum
│   └── main.go
└── go
    └── src
        └── github.com
            └── golang
                └── glog
                    ├── glog_file.go
                    ├── glog.go
                    ├── glog_test.go
                    ├── license
                    └── readme

与使用模块相比，将包的特定版本（或多个版本）拉入 ${gopath}/pkg：

GO111MODULE=on go get github.com/golang/glog

.
├── foo
│   ├── bar
│   │   └── library.go
│   ├── go.mod
│   ├── go.sum
│   └── main.go
└── go
    └── pkg
        ├── linux_amd64
        │   └── github.com
        │       └── golang
        │           └── glog.a
        └── mod
            ├── cache
            │   ├── download
            │   │   └── github.com
            │   │       └── golang
            │   │           └── glog
            └── github.com
                └── golang
                    └── [email protected]
                        ├── glog_file.go
                        ├── glog.go
                        ├── glog_test.go
                        ├── LICENSE
                        └── README

注释

• 我们的文件名有些随意。你说的是 library.go，所以我已经使用了它，并且按照惯例，文件以其内容命名。
• 我们的目录名称很重要。 go 使用目录名称来帮助查找包。因此，即使 library.go 可能被称为 freddie.go 或 something.go，重要的是它是 package bar 并位于名为 bar 的目录中。
• 这些规则的一个例外是 main.go 通常是定义 func main() {...} 的位置，并且 func main() {...} 必须位于名为 main 的包中。因此，即使该目录名为 foo，但由于我们需要 main 函数，因此我们将文件命名为 main.go 并且它必须是 package main。
• 在包 bar 中，重要的是 something 最初要大写 (s)。这将从 bar 包中导出该函数，以便其他包可以使用它。如果函数名称为小写 (something)，则该函数仅可用于 bar 包中的其他函数。

今天关于《如何创建可运行且支持内部包导入的 Go 模块？》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！