Go項目的目錄結構詳解_Golang

項目目錄結構如何組織，一般語言都是沒有規定。但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