Go项目的目录结构

Go项目的目录结构

项目目录结构如何组织,一般语言都是没有规定。但Go语言这方面做了规定,这样可以保持一致性

1、一般的,一个Go项目在GOPATH下,会有如下三个目录:

|--bin
|--pkg
|--src

其中,bin存放编译后的可执行文件;pkg存放编译后的包文件;src存放项目源文件。一般,bin和pkg目录可以不创建,go命令会自动创建(如 go install),只需要创建src目录即可。
对于pkg目录,曾经有人问:我把Go中的包放入pkg下面,怎么不行啊?他直接把Go包的源文件放入了pkg中。这显然是不对的。pkg中的文件是Go编译生成的,而不是手动放进去的。(一般文件后缀.a)
对于src目录,存放源文件,Go中源文件以包(package)的形式组织。通常,新建一个包就在src目录中新建一个文件夹。

2、举例说明

比如:我新建一个项目,test,开始的目录结构如下:

test--|--src

为了编译方便,我在其中增加了一个install文件,目录结构:

test/
|-- install
`-- src

其中install的内容如下:(linux下)

#!/usr/bin/env bash

if [ ! -f install ]; then
echo 'install must be run within its container folder' 1>&2
exit 1
fi

CURDIR=`pwd`
OLDGOPATH="$GOPATH"
export GOPATH="$CURDIR"

gofmt -w src

go install test

export GOPATH="$OLDGOPATH"

echo 'finished'

之所以加上这个install,是不用配置GOPATH(避免新增一个GO项目就要往GOPATH中增加一个路径)

接下来,增加一个包:config和一个main程序。目录结构如下:

test
|-- install
`-- src
    |-- config
    |   `-- config.go
    `-- test
        `-- main.go

注意,config.go中的package名称必须最好和目录config一致,而文件名可以随便。main.go表示main包,文件名建议为main.go。(注:不一致时,生成的.a文件名和目录名一致,这样,在import 时,应该是目录名,而引用包时,需要包名。例如:目录为myconfig,包名为config,则生产的静态包文件是:myconfig.a,引用该包:import “myconfig”,使用包中成员:config.LoadConfig()

config.go和main.go的代码如下:
config.go代码

package config

func LoadConfig() {

}

main.go代码

package main

import (
	"config"
	"fmt"
)

func main() {
	config.LoadConfig()
	fmt.Println("Hello, GO!")
}

接下来,在项目根目录执行./install

这时候的目录结构为:

test
|-- bin
|   `-- test
|-- install
|-- pkg
|   `-- linux_amd64
|       `-- config.a
`-- src
    |-- config
    |   `-- config.go
    `-- test
        `-- main.go
(linux_amd64表示我使用的操作系统和架构,你的可能不一样)

其中config.a是包config编译后生成的;bin/test是生成的二进制文件

这个时候可以执行:bin/test了。会输出:Hello, GO!

3、补充说明

1)包可以多层目录,比如:net/http包,表示源文件在src/net/http目录下面,不过源文件中的包名是最后一个目录的名字,如http
而在import包时,必须完整的路径,如:import “net/http”

2)有时候会见到local import(不建议使用),语法类似这样:

import “./config”

当代码中有这样的语句时,很多时候都会见到类似这样的错误:local import “./config” in non-local package

我所了解的这种导入方式的使用是:当写一个简单的测试脚本,想要使用go run命令时,可以使用这种导入方式。
比如上面的例子,把test/main.go移到src目录中,test目录删除,修改main.go中的import “config”为import “./config”,然后可以在src目录下执行:go run main.go

可见,local import不依赖于GOPATH

4、Windows下的install.bat

@echo off

setlocal

if exist install.bat goto ok
echo install.bat must be run from its folder
goto end

: ok

set OLDGOPATH=%GOPATH%
set GOPATH=%~dp0

gofmt -w src

go install test

:end
echo finished

注,冒号和ok之间不应该有空格,但是放在一起总是会被wordpress转成一个表情。汗……

5、更新日志

1)2012-12-05 发布
2)2013-04-13 修正:目录名可以和包名不同,但建议一致;将make文件名改为install

1 Star2 Stars3 Stars4 Stars5 Stars (还没有人评分,赶紧评一下)
Loading...

39 thoughts on “Go项目的目录结构

  1. 嗯 学习。
    “注意,config.go中的package名称必须和目录config一致,而文件名可以随便。mian.go表示main包,文件名建议为main.go。” 单词写错了一个 不是mian.go是main.go

    1. 你是第一个评论的哦。呵呵。看的好仔细。
      另外,根据建议,避免make和linux的make命令冲突,可以考虑命名为:install.sh或make.sh

  2. 每次去添加环境变量很烦人的,LIteIde中有个设置gopath的菜单,设置了后系统中也没设置上(liteide中起作用),感觉也挺方便

  3. 很好的文章,谢谢你的分享

    按照你文章的,我操作了一遍,都运行的很好,但是遇到了一个小问题,就是生产pkg没问题,但是bin生成不了,生成到go的安装包的bin下去了,请问能够解决吗?

    1. 之所以生成到go的安装包中,是因为你设置了$GOBIN环境变量,一般这个环境变量不需要设置的。设置了下面的环境变量就可以(linux为例):
      export GOROOT=
      export PATH=$PATH:$GOPATH/bin

  4. 我也是新建了一个目录cmdTest\\src,在src里面有一个main.go文件,当我使用go install的时候没有产生pkg和bin这两个文件夹。我已经把E:\MyGoDemo\cmdTest路径加到GOPATH里面去了。为什么还是没有产生相应的文件呢?下面是我的go env。
    E:\MyGoDemo\cmdTest\src>go env
    set GOARCH=386
    set GOBIN=
    set GOCHAR=8
    set GOEXE=.exe
    set GOGCCFLAGS=-g -O2 -m32 -mthreads
    set GOHOSTARCH=386
    set GOHOSTOS=windows
    set GOOS=windows
    set GOPATH=c;\GO;E:\MyGoDemo\cmdTest
    set GOROOT=c:\GO
    set GOTOOLDIR=c:\GO\pkg\tool\windows_386
    set CGO_ENABLED=1

    1. 放在src的某个目录下才行。
      我的文章中是放在src/test/目录下,然后go install test的
      而不是放在src根目录下

      1. 现在是能够生成了pkg,但是bin还是生成不了。我没有设置GOBIN啊,就是没有生成可执行文件,这是怎么回事呢?


  5. if [ ! -f make ]; then
    4
    echo 'make must be run within its container folder' 1>&2
    5
    exit 1
    6
    fi


    楼主,make文件很好用。
    在Make中的这部分代码表示什么意思?谢谢!

    1. 表示 执行make时,只能在make文件所在目录执行,在其他目录执行,GOPATH路径设置会不对,因此限制只能在当前目录(make所在目录)运行该文件

  6. 注意,config.go中的package名称必须和目录config一致,而文件名可以随便。main.go表示main包,文件名建议为main.go。

    有一点不是很明白, 既然所有包名要与文件夹名相同, 为什么main包名没有与文件夹名相同呢?
    而且平时写测试的时候也没有按包名等于文件夹名的方式来写, 也是正确的?

  7. 按找你上面的例子2的第2个例子,在编译main.go文件时,总出现imported and not used:”config”

  8. 关于冒号+ok会被转成表情的问题
    可以把wordpress的options表中
    option_name字段值为clcs_smilies的行清空

  9. 我根据LZ的帖子自己写了一个sh一步完成这个帖子说的,希望对大家有用,代码如下:
    #!/bin/bash
    #————————————–
    # Module : mk_go_pro.sh
    # Author : Blair Zhong
    # Created : 2013.07.23
    # Modify :
    # Version : 1.0
    # Useage : ./mk_go_pro.sh
    # ./mk_go_pro.sh porject_name
    # Description: 创建一个go可编译的工程
    #————————————–
    # 根据 Go语言学习园地博客的帖子编写,如有侵权请联系本人
    # http://blog.studygolang.com/2012/12/go项目的目录结构/
    # 默认情况下运行本程序,会生成如下目录和文件
    # test
    # ├── bin
    # ├── install.sh
    # ├── pkg
    # └── src
    # ├── config
    # │   └── config.go
    # └── test
    # └── main.go
    #
    # 5 directories, 3 files
    #
    # 其中:
    # 1, install.sh为安装文件,
    # 2, config.go为test项目的配置文件
    # 3, main.go这个你懂的
    # 生成完毕之后运行进入test目录,运行install.sh会生成如下文件和目录
    # ├── bin
    # │   └── test
    # ├── install.sh
    # ├── pkg
    # │   └── darwin_amd64
    # │   └── config.a
    # └── src
    # ├── config
    # │   └── config.go
    # └── test
    # └── main.go
    # 6 directories, 5 files
    #
    # 多了两个文件
    # 1, bin目录下的test,这个是可执行稳健
    # 2, pkg/darwin_amd64下的config.a,这个是config编译后产生的文件
    #
    # enjoy it!

    PWD=$(pwd)
    cd $PWD

    if [[ “$1” = “” ]]; then
    echo “Useage: ./mk_go_pro.sh porject_name”
    echo -ne “Please input the Porject Name[test]”
    read Answer
    if [ “$Answer” = “” ]; then
    echo -e “test”;
    PRO_NAME=test;
    else
    PRO_NAME=$Answer;
    fi
    else
    PRO_NAME=$1;
    fi
    #创建目录
    echo “Init Directory …”
    mkdir -p $PRO_NAME/bin
    mkdir -p $PRO_NAME/pkg
    mkdir -p $PRO_NAME/src/config
    mkdir -p $PRO_NAME/src/$PRO_NAME

    #创建install文件
    echo “Create install/install.sh …”
    cd $PRO_NAME
    echo ‘#!/bin/bash’ > install.sh
    echo ‘if [ ! -f install.sh ]; then’ >> install.sh
    echo “echo ‘install must be run within its container folder’ 1>&2” >> install.sh
    echo “exit 1” >> install.sh
    echo “fi” >> install.sh
    echo >> install.sh
    echo “CURDIR=\`pwd\`” >> install.sh
    echo “OLDGOPATH=\”\$GOPATH\”” >> install.sh
    echo “export GOPATH=\”\$CURDIR\”” >> install.sh
    echo >> install.sh
    echo “gofmt -w src” >> install.sh
    echo “go install $PRO_NAME” >> install.sh
    echo “export GOPATH=\”\$OLDGOPATH\”” >> install.sh
    echo >> install.sh
    echo “echo ‘finished'” >>install.sh
    chmod +x install.sh

    #创建config.go文件
    echo “Create src/config/config.go …”
    cd src/config
    echo package config > config.go
    echo >> config.go
    echo func LoadConfig\(\) { >> config.go
    echo >> config.go
    echo } >> config.go

    #创建main.go
    echo “Create src/$PRO_NAME/main.go …”
    cd ../$PRO_NAME/
    echo “package main” > main.go
    echo >> main.go
    echo “import (” >> main.go
    echo ” \”config\”” >> main.go
    echo ” \”fmt\”” >> main.go
    echo “)” >> main.go
    echo >> main.go
    echo “func main() {” >> main.go
    echo ” config.LoadConfig()” >> main.go
    echo ” fmt.Println(\”Hello $PRO_NAME!\”)” >> main.go
    echo “}” >> main.go
    echo “All Done!”

  10. 你好,我是go的初学者,我发现有些包命名会导致里面的方法出现undefined
    第一种,可以go build成功
    src/main.go:
    package main
    import (
    “mybase”
    )
    func main() {
    mybase.Test()
    mybase.LoadTest()
    }
    src/mybase/test.go:
    package mybase
    import (
    “fmt”
    )
    func Test() {
    fmt.Println(“…”)
    }
    func LoadTest() {
    fmt.Println(“TestMore”)
    }
    但是我把mybase的包名改为dwbase的时候go build出现以下错误
    undefined: dwbase.Test
    undefined: dwbase.LoadTest
    改动如下
    package main
    import (
    “dwbase”
    )
    func main() {
    dwbase.Test()
    dwbase.LoadTest()
    }
    src/dwbase/test.go:
    package dwbase

    import (
    “fmt”
    )
    func Test() {
    fmt.Println(“…”)
    }
    func LoadTest() {
    fmt.Println(“TestMore”)
    }
    想了解下出现这种情况的原因,因为不只dwbase会出现这个情况,myframework也同样会出现同种错误

  11. 指定一个目录作为GOPATH,今后凡是新增go项目,就在那个GOPATH目录下创建。这么做有什么劣势吗?

  12. 假如我的工程 在 d:\works\proj-go\p2016_01 下。p2016_01\有 src pkg 等等,,怎么指定p2016_01为默认的gopath啊?

  13. 如果项目引入其他go get 第三方库,windows install.bat 脚本有问题!应该将OLDGOPATH 跟当前项目入口用’;’拼接再赋给GOPATH变量!

发表评论

电子邮件地址不会被公开。