Go项目的目录结构
yugongpeng_blog · · 3910 次点击 · · 开始浏览转载:http://blog.studygolang.com/2012/12/go%E9%A1%B9%E7%9B%AE%E7%9A%84%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84/
项目目录结构如何组织,一般语言都是没有规定。但Go语言这方面做了规定,这样可以保持一致性
1、一般的,一个Go项目在GOPATH下,会有如下三个目录:
1
|--bin
2
|--pkg
3
|--src
其中,bin存放编译后的可执行文件;pkg存放编译后的包文件;src存放项目源文件。一般,bin和pkg目录可以不创建,go命令会自动创建(如 go install),只需要创建src目录即可。
对于pkg目录,曾经有人问:我把Go中的包放入pkg下面,怎么不行啊?他直接把Go包的源文件放入了pkg中。这显然是不对的。pkg中的文件是Go编译生成的,而不是手动放进去的。(一般文件后缀.a)
对于src目录,存放源文件,Go中源文件以包(package)的形式组织。通常,新建一个包就在src目录中新建一个文件夹 。
2、举例说明
比如:我新建一个项目,test,开始的目录结构如下:
1
test--|--src
为了编译方便,我在其中增加了一个install文件,目录结构:
1
test/
2
|--
install
3
`--
src
其中install的内容如下:(linux下)
1
#!/usr/bin/env
bash
2
3
if
[ ! -f install
]; then
4
<span
id="16_nwp"
style="width:
auto; height: auto; float: none;"><a
id="16_nwl"
href="http://cpro.baidu.com/cpro/ui/uijs.php?c=news&cf=1001&ch=0&di=128&fv=17&jk=e005ae8275023293&k=echo&k0=echo&kdi0=0&luki=8&n=10&p=baidu&q=74042097_cpr&rb=0&rs=1&seller_id=1&sid=9332027582ae05e0&ssp2=1&stid=0&t=tpclicked3_hc&tu=u1989498&u=http%3A%2F%2Fblog%2Estudygolang%2Ecom%2F2012%2F12%2Fgo%25E9%25A1%25B9%25E7%259B%25AE%25E7%259A%2584%25E7%259B%25AE%25E5%25BD%2595%25E7%25BB%2593%25E6%259E%2584%2F&urlid=0"
target="_blank"
mpid="16"
style="text-decoration:
none;"><span
style="color:#0000ff;font-size:13.9200000762939px;width:auto;height:auto;float:none;">echo</span></a></span>
'install
must be run within its container folder'
1>&2
5
exit
1
6
fi
7
8
CURDIR=`pwd`
9
OLDGOPATH="$GOPATH"
10
export
GOPATH="$CURDIR"
11
12
gofmt
-w src
13
14
go
install
test
15
16
export
GOPATH="$OLDGOPATH"
17
18
echo
'finished'
之所以加上这个install,是不用配置GOPATH(避免新增一个GO项目就要往GOPATH中增加一个路径)
接下来,增加一个包:config和一个main程序。目录结构如下:
1
test
2
|--
install
3
`--
src
4
|--
config
5
|
`-- config.go
6
`--
test
7
`--
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代码
1
package
config
2
3
func
LoadConfig() {
4
5
}
main.go代码
1
package
main
2
3
import
(
4
"config"
5
"fmt"
6
)
7
8
func
main() {
9
config.LoadConfig()
10
fmt.Println("Hello,
GO!")
11
}
接下来,在项目根目录执行./install
这时候的目录结构为:
1
test
2
|--
bin
3
|
`-- test
4
|--
install
5
|--
pkg
6
|
`-- linux_amd64
7
|
`-- config.a
8
`--
src
9
|--
config
10
|
`-- config.go
11
`--
test
12
`--
main.go
13
(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
有疑问加站长微信联系(非本文作者)
入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889
关注微信- 请尽量让自己的回复能够对别人有帮助
- 支持 Markdown 格式, **粗体**、~~删除线~~、
`单行代码` - 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
- 图片支持拖拽、截图粘贴等方式上传
收入到我管理的专栏 新建专栏
转载:http://blog.studygolang.com/2012/12/go%E9%A1%B9%E7%9B%AE%E7%9A%84%E7%9B%AE%E5%BD%95%E7%BB%93%E6%9E%84/
项目目录结构如何组织,一般语言都是没有规定。但Go语言这方面做了规定,这样可以保持一致性
1、一般的,一个Go项目在GOPATH下,会有如下三个目录:
1
|--bin
2
|--pkg
3
|--src
其中,bin存放编译后的可执行文件;pkg存放编译后的包文件;src存放项目源文件。一般,bin和pkg目录可以不创建,go命令会自动创建(如 go install),只需要创建src目录即可。
对于pkg目录,曾经有人问:我把Go中的包放入pkg下面,怎么不行啊?他直接把Go包的源文件放入了pkg中。这显然是不对的。pkg中的文件是Go编译生成的,而不是手动放进去的。(一般文件后缀.a)
对于src目录,存放源文件,Go中源文件以包(package)的形式组织。通常,新建一个包就在src目录中新建一个文件夹 。
2、举例说明
比如:我新建一个项目,test,开始的目录结构如下:
1
test--|--src
为了编译方便,我在其中增加了一个install文件,目录结构:
1
test/
2
|--
install
3
`--
src
其中install的内容如下:(linux下)
1
#!/usr/bin/env
bash
2
3
if
[ ! -f install
]; then
4
<span
id="16_nwp"
style="width:
auto; height: auto; float: none;"><a
id="16_nwl"
href="http://cpro.baidu.com/cpro/ui/uijs.php?c=news&cf=1001&ch=0&di=128&fv=17&jk=e005ae8275023293&k=echo&k0=echo&kdi0=0&luki=8&n=10&p=baidu&q=74042097_cpr&rb=0&rs=1&seller_id=1&sid=9332027582ae05e0&ssp2=1&stid=0&t=tpclicked3_hc&tu=u1989498&u=http%3A%2F%2Fblog%2Estudygolang%2Ecom%2F2012%2F12%2Fgo%25E9%25A1%25B9%25E7%259B%25AE%25E7%259A%2584%25E7%259B%25AE%25E5%25BD%2595%25E7%25BB%2593%25E6%259E%2584%2F&urlid=0"
target="_blank"
mpid="16"
style="text-decoration:
none;"><span
style="color:#0000ff;font-size:13.9200000762939px;width:auto;height:auto;float:none;">echo</span></a></span>
'install
must be run within its container folder'
1>&2
5
exit
1
6
fi
7
8
CURDIR=`pwd`
9
OLDGOPATH="$GOPATH"
10
export
GOPATH="$CURDIR"
11
12
gofmt
-w src
13
14
go
install
test
15
16
export
GOPATH="$OLDGOPATH"
17
18
echo
'finished'
之所以加上这个install,是不用配置GOPATH(避免新增一个GO项目就要往GOPATH中增加一个路径)
接下来,增加一个包:config和一个main程序。目录结构如下:
1
test
2
|--
install
3
`--
src
4
|--
config
5
|
`-- config.go
6
`--
test
7
`--
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代码
1
package
config
2
3
func
LoadConfig() {
4
5
}
main.go代码
1
package
main
2
3
import
(
4
"config"
5
"fmt"
6
)
7
8
func
main() {
9
config.LoadConfig()
10
fmt.Println("Hello,
GO!")
11
}
接下来,在项目根目录执行./install
这时候的目录结构为:
1
test
2
|--
bin
3
|
`-- test
4
|--
install
5
|--
pkg
6
|
`-- linux_amd64
7
|
`-- config.a
8
`--
src
9
|--
config
10
|
`-- config.go
11
`--
test
12
`--
main.go
13
(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