git - 使用 Git(或任何 VCS)的 Go 项目的正确组织是什么？

Question

我的 GOPATH 是 /Users/joe/go。我正在开发一个名为 myproj 的项目，它是一个名为 myproj 的包。

如果我希望能够编写 import "myproj" 那么我需要的目录结构是:

$GOPATH/src/myproj/myproj.go
$GOPATH/src/myproj/myproj_test.go
...

但是，我似乎无法使其适合 Git。如果我查看 example package from Google我看到以下格式:

go.example/hello/hello.go
go.example/LICENSE

其中 go.example 是 repo 的名称。

所以实际的包目录可以在存储库中找到。如果我将此存储库的内容放在我的 $GOPATH 上的目录中，例如

$GOPATH/src/go.example/hello/hello.go
$GOPATH/src/go.example/LICENSE

然后我必须输入 import "go.example/hello" 而不是 import "hello"。

回到我的项目，我需要将它打包到 Git 存储库中，然后我需要一个容器目录。所以我目前的文件结构是:

$GOPATH/src/myproj                        # The dir for the git repo
$GOPATH/src/myproj/.git
$GOPATH/src/myproj/LICENSE                # Files in the base of the repo
$GOPATH/src/myproj/myproj/myproj.go       # Package files in package dir
$GOPATH/src/myproj/myproj/myproj_test.go  

我需要外部 myproj 目录来绑定(bind) git 存储库，我需要内部目录作为包目录。结果是我需要输入 import "myproj/myproj" 而不是 import "myproj"。

我该如何解决这个问题？我是否必须为我正在开发的每个项目添加多个 $GOPATHS？

提前致谢。

Answer 1

首先:

Do I have to add multiple $GOPATHs, one for each project I'm developing?

不，您根本不需要多个 $GOPATH。

它们是管理您(可能是多个)项目的工具。当你设置一个新的项目环境时，你已经知道它会有一些依赖项——可能是该项目独有的，或者应该与其他人的设置类似，你创建一个新的项目文件夹并将其设置为 GOPATH。这样，您还可以为该项目使用(= check out )特定版本的库，同时为其他项目文件夹(= GOPATHs)中的其他项目使用其他版本。

至于您的路径问题:Go 遵循 author/project(或 organization/project)的通用范式。当多个人、作者和组织以相同的名称启动项目时，这将防止命名冲突。 (然后作者可以使用“his”文件夹中的子文件夹和子项目。)

如果您知道这一点并且仍然只想使用 myproj 作为您的包路径，在该文件夹中创建 git 存储库没有问题 - 与您链接到的示例包相反。

Coming back to my project, I need to package this up in a Git repository then I need a container directory.

那是什么让你这么认为呢？ Go 不需要它。 Git 两者都没有。

所以以下将起作用:

/src/myproj/.git
/src/myproj/myproj.go

虽然不鼓励这样做，但您可以将存储库放入您的 myproj 文件夹。

---

我对此进行了如下测试:

FOLDER
FOLDER/src
FOLDER/src/myproj
FOLDER/src/myproj/myproj.go
FOLDER/src/mainproj
FOLDER/src/mainproj/main.go

使用文件夹/src/myproj/myproj.go

package myproj

type My struct {
    I int
}

和文件夹/src/mainproj/main.go

package main

import (
    "fmt"
    "myproj"
)

func main() {
    my := myproj.My{7}
    fmt.Printf("Works! %v", my.I)
}

运行

cd FOLDER
set GOPATH=FOLDER
go run src/mainproj/main.go

将输出:

Works! 7

现在，如果您在文件夹 FOLDER/src/myproj 中 git init，那么 Go 本身根本就没有关系。