Go專案的目錄結構詳解

2022-09-24 23:45:11 字數 3200 閱讀 5244

專案目錄結構如何組織,一般語言都是沒有規定。但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 ba程式設計客棧sh

if [ ! -f install ]; then

echo 'install must be run within its container folder' 1>&2

exit 1

ficurdir=`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中的名稱必須最好和目錄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()

接下來,在專案根目錄執行./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

本文標題: go專案的目錄結構詳解

本文位址: /jiaoben/golang/115370.html

Go專案的目錄結構

專案目錄結構如何組織,一般語言都是沒有規定。但go語言這方面做了規定,這樣可以保持一致性,做到統 一 規則化比較明確。1 一般的,乙個go專案在gopath下,會有如下三個目錄 bin pkg src 其中,bin存放編譯後的可執行檔案 pkg存放編譯後的包檔案 src存放專案原始檔。一般,bin和...

Go專案的目錄結構

專案目錄結構如何組織,一般語言都是沒有規定。但go語言這方面做了規定,這樣可以保持一致性,做到統 一 規則化比較明確。1 一般的,乙個go專案在gopath下,會有如下三個目錄 bin pkg src 其中,bin存放編譯後的可執行檔案 pkg存放編譯後的包檔案 src存放專案原始檔。一般,bin和...

Go專案的目錄結構

專案目錄結構如何組織,一般語言都是沒有規定。但go語言這方面做了規定,這樣可以保持一致性,做到統 一 規則化比較明確。1 一般的,乙個go專案在gopath下,會有如下三個目錄 bin pkg src 其中,bin存放編譯後的可執行檔案 pkg存放編譯後的包檔案 src存放專案原始檔。一般,bin和...