68

我无法理解创建具有本地包的 go 项目的工作流程。

假设我创建了一个新项目，使用 git 进行版本控制，它有一个 main.go 文件和一个 tools.go 文件，它们将在包 utils 中。所以我有一个这样的目录结构：

/myproject/
   main.go
   utils/
     tools.go

main.go 看起来像这样：

package main
import "./utils"
func main() {
    utils.DoSomthing()
}

和 tools.go 看起来像这样：

package utils;
func DoSomething() {
}

使用go build和go run在本地一切正常。但这是托管在 github 上的，我希望能够让其他人使用go get命令来安装它。所以本地包导入必须改成使用“github.com/user/project/utils”的格式，这样才有效，除了现在我有两份源代码，真正的问题是那个带有git历史的副本有一个使用下载的副本的导入。因此，如果我正在处理带有 git 历史记录的副本，对 tools.go 所做的任何更改都不会被注意到，因为它将使用下载的副本。

所以我想知道是否有人可以解释在同一个项目中使用go get、版本控制和包导入的正确方法。

4

5 回答 5

96

我刚刚就如何使用新的go 工具和github.com编写了一个简短的分步指南。您可能会发现它很有用：

1. 设置你的 GOPATH

您可以将环境变量设置为GOPATH您喜欢的任何目录。如果你有更大的项目，为每个项目创建一个不同的 GOPATH 可能是个好主意。我会特别推荐这种方法用于部署，以便为项目 A 更新库不会破坏项目 B，这可能需要相同库的早期版本。

另请注意，您可以将 GOPATH 设置为由冒号分隔的目录列表。因此，您可能有一个包含所有常用包的 GOPATH，并为每个带有附加包或现有包的不同版本的项目单独的 GOPATH。

但是除非你同时处理许多不同的 Go 项目，否则本地只有一个 GOPATH 可能就足够了。所以，让我们创建一个：

mkdir $HOME/gopath

然后你需要设置两个环境变量来告诉go 工具它可以在哪里找到现有的 Go 包以及它应该在哪里安装新的包。最好将以下两行添加到您的~/.bashrcor中~/.profile（并且不要忘记之后重新加载您的 .bashrc）。

export GOPATH="$HOME/gopath"
export PATH="$GOPATH/bin:$PATH"

2.新建项目

如果你想创建一个新的 Go 项目，以后应该在github.com上托管，你应该在$GOPATH/src/github.com/myname/myproject. 路径与 github.com 存储库的 URL 匹配很重要，因为 go 工具将遵循相同的约定。因此，让我们创建项目根目录并在那里初始化一个新的 git 存储库：

mkdir -p $GOPATH/src/github.com/myname/myproject
cd $GOPATH/src/github.com/myname/myproject
git init

因为我不喜欢输入这么长的路径，所以我通常在我的主文件夹中为我当前正在处理的项目创建符号链接：

ln -s $GOPATH/src/github.com/myname/myproject ~/myproject

3. 编写你的应用程序

开始编码，不要忘记git add和git commit你的文件。另外，不要像import "./utils"子包那样使用相对导入。它们目前没有记录，根本不应该使用，因为它们不能与 go 工具一起使用。改用进口github.com/myname/myproject/utils。

4. 发布你的项目

在 github.com创建一个新的存储库，上传您的 SSH 公钥（如果您之前没有这样做过）并将您的更改推送到远程存储库：

git remote add origin git@github.com:myname/myproject.git
git push origin master

5. 继续你的项目

如果您在 .bashrc 中设置了 GOPATH 并且在主文件夹中创建了指向项目的符号链接，则可以在cd myproject/此处键入和编辑一些文件。之后，您可以使用 提交更改git commit -a并将它们发送到github.com通过执行git push.

于 2012-04-13T14:05:19.863 回答
10

您可能不想要源的两个副本。在如何编写 Go 代码之后，您应该有一个进行 Go 开发的路径，比如说“godev”，在它下面是一个“src”目录，在它下面是您的“github.com/user/project”和“github.com/user/project/utils”。（我同意，这似乎有点死板，但向我们解释的优点是无需制作文件。）放弃 myproject，这是您将要做的工作。

您至少将 GOPATH 设置为 godev，但您可能希望您的 GOPATH 以不属于您的外部包的路径开始。例如我使用的 GOPATH 是<my place on the file system>/goext:<my place on the file system>/godev.

你是对的，你在 main.go 中的导入现在应该是“github.com/user/project/utils.

不用担心 go get 或任何 go 命令会覆盖您的文件或弄乱版本控制。通过 GOPATH，他们可以看到你在哪里工作，并且知道版本控制是如何工作的。

于 2012-04-12T20:32:14.317 回答
8

如果您想将代码保存在本地版本存储库中，只需将您的代码放在 GOPATH 中。

GOPATH 接受多个路径。例如。在 Linux 上

GOPATH=$HOME/go:$HOME/prj/foo

所以，你可以在 $HOME/go/src/...

参考：go help gopath

于 2012-05-05T05:19:20.150 回答
-2

很多人说应该使用绝对路径来构建项目结构和导入：

import "github.com/user/utils"

但这可能会将您的项目限制在单个 repo (github) 内。我想改用相对路径：

  import "./utils"

我还没有找到一种方法来做到这一点，我在这里提出一个问题： 如果 GO 项目包将托管在不同的 repos(github & sourceForge) 上，如何组织它

于 2018-07-19T02:03:40.707 回答
-2

在不同的帖子和 Go 文档中寻找这个答案后，Go 1.11 发布了一种处理包的新方法，并且正在使用 Go Modules。

在此处阅读有关 Go Modules 的整个系列文章。

Go Modules 还负责版本控制

于 2020-04-23T14:05:01.457 回答