Go項目的目錄結構

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	echo '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

4、Windows下的install.bat

1

@echo off

2

3

setlocal

4

5	if exist install.bat goto ok

6	echo install.bat must be run from its folder

7

goto end

8

9

: ok

10

11	set OLDGOPATH=%GOPATH%

12	set GOPATH=%~dp0

13

14	gofmt -w src

15

16	go install test

17

18

:end

19	echo finished

注,冒號和ok之間不應該有空格，但是放在一起總是會被wordpress轉成一個表情。汗……

5、更新日誌

1）2012-12-05 發佈
2）2013-04-13 修正：目錄名可以和包名不同，但建議一致；將make文件名改爲install