項(xiàng)目目錄結(jié)構(gòu)如何組織,一般語(yǔ)言都是沒(méi)有規(guī)定。但Go語(yǔ)言這方面做了規(guī)定,這樣可以保持一致性。
1、一般的,一個(gè)Go項(xiàng)目在GOPATH下,會(huì)有如下三個(gè)目錄:
復(fù)制代碼 代碼如下:
|--bin
|--pkg
|--src
其中,bin存放編譯后的可執(zhí)行文件;pkg存放編譯后的包文件;src存放項(xiàng)目源文件。一般,bin和pkg目錄可以不創(chuàng)建,go命令會(huì)自動(dòng)創(chuàng)建(如 go install),只需要?jiǎng)?chuàng)建src目錄即可。
對(duì)于pkg目錄,曾經(jīng)有人問(wèn):我把Go中的包放入pkg下面,怎么不行?。克苯影袵o包的源文件放入了pkg中。這顯然是不對(duì)的。pkg中的文件是Go編譯生成的,而不是手動(dòng)放進(jìn)去的。(一般文件后綴.a)
對(duì)于src目錄,存放源文件,Go中源文件以包(package)的形式組織。通常,新建一個(gè)包就在src目錄中新建一個(gè)文件夾。
2、舉例說(shuō)明
比如:我新建一個(gè)項(xiàng)目,test,開(kāi)始的目錄結(jié)構(gòu)如下:
復(fù)制代碼 代碼如下:
test--|--src
為了編譯方便,我在其中增加了一個(gè)install文件,目錄結(jié)構(gòu):
復(fù)制代碼 代碼如下:
test/
|-- install
`-- src
其中install的內(nèi)容如下:(linux下)
復(fù)制代碼 代碼如下:
#!/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'
之所以加上這個(gè)install,是不用配置GOPATH(避免新增一個(gè)GO項(xiàng)目就要往GOPATH中增加一個(gè)路徑)
接下來(lái),增加一個(gè)包:config和一個(gè)main程序。目錄結(jié)構(gòu)如下:
復(fù)制代碼 代碼如下:
test
|-- install
`-- src
|-- config
| `-- config.go
`-- test
`-- main.go
注意,config.go中的package名稱(chēng)必須最好和目錄config一致,而文件名可以隨便。main.go表示main包,文件名建議為main.go。(注:不一致時(shí),生成的.a文件名和目錄名一致,這樣,在import 時(shí),應(yīng)該是目錄名,而引用包時(shí),需要包名。例如:目錄為myconfig,包名為config,則生產(chǎn)的靜態(tài)包文件是:myconfig.a,引用該包:import “myconfig”,使用包中成員:config.LoadConfig())
config.go和main.go的代碼如下:
config.go代碼
復(fù)制代碼 代碼如下:
package config
func LoadConfig() {
}
main.go代碼
復(fù)制代碼 代碼如下:
package main
import (
"config"
"fmt"
)
func main() {
config.LoadConfig()
fmt.Println("Hello, GO!")
}
接下來(lái),在項(xiàng)目根目錄執(zhí)行./install
這時(shí)候的目錄結(jié)構(gòu)為:
復(fù)制代碼 代碼如下:
test
|-- bin
| `-- test
|-- install
|-- pkg
| `-- linux_amd64
| `-- config.a
`-- src
|-- config
| `-- config.go
`-- test
`-- main.go
(linux_amd64表示我使用的操作系統(tǒng)和架構(gòu),你的可能不一樣)
其中config.a是包c(diǎn)onfig編譯后生成的;bin/test是生成的二進(jìn)制文件
這個(gè)時(shí)候可以執(zhí)行:bin/test了。會(huì)輸出:Hello, GO!
3、補(bǔ)充說(shuō)明
1)包可以多層目錄,比如:net/http包,表示源文件在src/net/http目錄下面,不過(guò)源文件中的包名是最后一個(gè)目錄的名字,如http
而在import包時(shí),必須完整的路徑,如:import “net/http”
2)有時(shí)候會(huì)見(jiàn)到local import(不建議使用),語(yǔ)法類(lèi)似這樣:
復(fù)制代碼 代碼如下:
import “./config”
當(dāng)代碼中有這樣的語(yǔ)句時(shí),很多時(shí)候都會(huì)見(jiàn)到類(lèi)似這樣的錯(cuò)誤:local import “./config” in non-local package
我所了解的這種導(dǎo)入方式的使用是:當(dāng)寫(xiě)一個(gè)簡(jiǎn)單的測(cè)試腳本,想要使用go run命令時(shí),可以使用這種導(dǎo)入方式。
比如上面的例子,把test/main.go移到src目錄中,test目錄刪除,修改main.go中的import “config”為import “./config”,然后可以在src目錄下執(zhí)行:go run main.go
可見(jiàn),local import不依賴于GOPATH
4、Windows下的install.bat
復(fù)制代碼 代碼如下:
@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
注,冒號(hào)和ok之間不應(yīng)該有空格,但是放在一起總是會(huì)被wordpress轉(zhuǎn)成一個(gè)表情。汗……
5、更新日志
1)2012-12-05 發(fā)布
2)2013-04-13 修正:目錄名可以和包名不同,但建議一致;將make文件名改為install
您可能感興趣的文章:- MongoDB學(xué)習(xí)筆記(四) 用MongoDB的文檔結(jié)構(gòu)描述數(shù)據(jù)關(guān)系
- Go語(yǔ)言基礎(chǔ)知識(shí)總結(jié)(語(yǔ)法、變量、數(shù)值類(lèi)型、表達(dá)式、控制結(jié)構(gòu)等)
- Go語(yǔ)言的代碼組織結(jié)構(gòu)詳細(xì)介紹
- Go語(yǔ)言中的流程控制結(jié)構(gòu)和函數(shù)詳解
- go語(yǔ)言工程結(jié)構(gòu)