golang项目目录结构
<golang_proj>
├─README
├─AUTHORS
├─<bin>
├─<pkg>
├─<src>
golang工程不需要任何的工程文件,一个完整的工程通常会在项目根目录下放置上面所示的文件或目录。它们的作用如下:
√ README : 简单介绍本项目的目标和主要注意事项,通常第一次使用时应该先阅读此文档。
√ LICENSE : 本工程采用的分发协议,所有开源项目通常都拥有该文档。
√ src : src目录用于存放所有的源代码。
√ pkg : pkg目录用于存放编译后的包文件,无需手动创建。
√ bin : bin目录用于存放编译后的可执行文件,无需手动创建。
• src目录
√ 目录src用于包含所有的源代码,是go tool一个强制的规则。
√ 构建过程中,go tool对包结构的理解完全依赖于src下面的目录结构。
√ go get命令下载的第三方源码将放置于GOPATH环境变量中第一个路径之中。
以《golang之package》中提及的calc实例来说明的话,其目录结构一开始如下:
<calcproj>
├─<src>
├─<calc>
├─calc.go
├─<simplemath>
├─add.go
├─add_test.go
├─sqrt.go
├─sqrt_test.go
├─<bin>
├─<pkg>
那么在命令行中,我们在工程路径下,使用go install simplemath命令对simplemath进行打包,可以在pkg目录下找到simplemath.a文件。
如果我们希望simplemath.a的路径带有一个命名空间,即在在使用时希望以import "myns/simplemath"这样的方式导入,那么需要将目录结构调整为如下形式:
<calcproj>
├─<src>
├─<calc>
├─calc.go
├─<simplemath>
├─<myns>
├─add.go
├─add_test.go
├─sqrt.go
├─sqrt_test.go
├─<bin>
├─<pkg>
那么在命令行中,我们在工程路径下,使用go install myns/simplemath命令对simplemath进行打包,可以在pkg目录下找到simplemath.a文件。
如果在命令行中,我们在工程路径下,执行go install calc命令,那么不仅可以在bin目录下找到calc.exe可执行文件,还可以在pkg目录下找到simplemath.a打包文件。
• bin目录
√ 目录bin用于存放编译后的可执行文件。
• pkg目录
√ 目录pkg用于存放编译后的包文件。
golang多个项目管理
• 方案一
该方案就是设置多个GOPATH路径,即将多个项目工程的路径都加入到GOPATH中,例如设置GOPATH为形如下面路径:
D:\workspace\golang\calcproj;D:\workspace\golang\golearning;D:\workspace\golang\rpcclient;D:\workspace\golang\rpcserver
优点:项目目录结构清晰,干净,每个工程下面只拥有自己相关的文件。
缺点:使用类似go get的命令时,受影响的仅仅是GOPATH路径下的第一个路径,譬如使用go get取得第三方源码时,取得的源码只能下载到GOPATH路径下的第一个路径。
• 方案二
该方案就是始终设置一个GOPATH路径,多个项目都放置在该路径下的src目录,并按照工程划分目录,例如设置GOPATH为形如下面路径:
D:\workspace\golang
优点:GOPATH只需要设置一个目录就可以管理多个工程,也不用烦恼第三方源码存放位置。
缺点:这种目录结构下工程文件夹也是一个包名路径,即内部工程文件在import时候需要加上工程文件夹名。以上述为例,protoc-gen-go在import其他包时候,需要加上基于src的相对路径: