Go語言的程式碼組織結構詳細介紹

NO IMAGE

包(package)

一個程式以一個包的形式構建,這個包還可以使用其他包提供的一些設施。

一個golang程式的建立是通過連結一組包。

一個包可以由多個原始碼檔案組成。

匯入包中的名字可以通過packagename.Itemname訪問。

原始碼檔案結構

golang每個原始碼檔案包括:

– 一個package字句(檔案歸屬於哪個包);其名字將作為匯入包時的預設名字。
複製程式碼 程式碼如下:
package fmt

– 一個可選的import宣告集
複製程式碼 程式碼如下:
import “fmt” //使用預設名字
import myFmt “fmt” //使用名字myFmt

– 0個或多個全域性或“包級別”宣告。

單一檔案包

複製程式碼 程式碼如下:
package main // 這個檔案是包main的一部分

import “fmt” // 這個檔案使用了包”fmt”

const hello = “Hello, 世界\n”

func main() {
fmt.Print(hello)
}

main和main.main

每個Go程式包含一個名為main的包以及其main函式,在初始化後,程式從main開始執行。類似C,C 中的main()函式。

main.main函式沒有引數,沒有返回值。當main.main返回時,程式立即退出並返回成功。

os包

os包提供Exit函式以及訪問檔案I/O以及命令列引數的函式等。

複製程式碼 程式碼如下:
// A version of echo(1)  
package main  
 
import (  
    “fmt” 
    “os” 
)  
 
func main() {  
    if len(os.Args) < 2 { // length of argument slice  
        os.Exit(1)  
    }  
    for i := 1; i < len(os.Args); i {  
        fmt.Printf(“arg %d: %s\n”, i, os.Args[i])  
    }  
} // falling off end == os.Exit(0) 

全域性作用域與包作用域

在一個包中,所有全域性變數、函式、型別以及常量對這個包的所有程式碼可見。

對於匯入該包的包而言,只有以大寫字母開頭的名字是可見的:全域性變數、函式、型別、常量以及方法和結構體中全域性型別以及變數的欄位。
複製程式碼 程式碼如下:
const hello = “you smell” // 包內可見
const Hello = “you smell nice” //全域性可見
const _Bye = “stinko!” // _不是大寫字母

這與C/C 非常不同:沒有extern、static、private以及public。

初始化

有兩種方法可以在main.main執行前初始化全域性變數:

1) 帶有初始化語句的全域性宣告
2) 在init函式內部,每個原始檔中都可能有init函式。

包依賴可以保證正確的執行順序。

初始化總是單執行緒的。

初始化例子:
複製程式碼 程式碼如下:
package transcendental  
 
import “math” 
 
var Pi float64  
 
func init() {  
    Pi = 4*math.Atan(1) // init function computes Pi  
}  
 
package main  
 
import (  
    “fmt” 
    “transcendental” 
)  
 
var twoPi = 2*transcendental.Pi // decl computes twoPi  
 
func main() {  
    fmt.Printf(“2*Pi = %g\n”, twoPi)  

輸出: 2*Pi = 6.283185307179586

包與程式構建

要構建一個程式,包以及其中的檔案必須按正確的次序進行編譯。包依賴關係決定了按何種次序構建包。

在一個包內部,原始檔必須一起被編譯。包作為一個單元被編譯,按慣例,每個目錄包含一個包,忽略測試,
複製程式碼 程式碼如下:
cd mypackage
6g *.go

通常,我們使用make; Go語言專用工具即將釋出(譯註:Go 1中可直接使用go build、go install等高階命令,可不再直接用6g、6l等命令了。)

構建fmt包

複製程式碼 程式碼如下:
% pwd
/Users/r/go/src/pkg/fmt
% ls
Makefile fmt_test.go format.go print.go # …
% make # hand-written but trivial
% ls
Makefile _go_.6 _obj fmt_test.go format.go print.go # …
% make clean; make

目標檔案被放在_obj子目錄中。

編寫Makefiles時通常使用Make.pkg提供的幫助。看原始碼。

測試

要測試一個包,可在這個包內編寫一組Go原始檔;給這些檔案命名為*_test.go。

在這些檔案內,名字以Test[^a-z]開頭的全域性函式會被測試工具gotest自動執行,這些函式應使用下面函式簽名:
複製程式碼 程式碼如下:
func TestXxx(t *testing.T)

testing包提供日誌、benchmarking、錯誤報告等支援。

一個測試例子

摘自fmt_test.go中的一段有趣程式碼:
複製程式碼 程式碼如下:
import (  
    “testing” 
)  
 
func TestFlagParser(t *testing.T) {  
    var flagprinter flagPrinter  
    for i := 0; i < len(flagtests); i {  
        tt := flagtests[i]  
        s := Sprintf(tt.in, &flagprinter)  
        if s != tt.out {  
            // method call coming up – obvious syntax.  
            t.Errorf(“Sprintf(%q, &flagprinter) => %q,” ” want %q”, tt.in, s, tt.out)  
        }  
    }  

gotest(譯註:在go 1中gotest工具用go test命令替代)
複製程式碼 程式碼如下:
% ls
Makefile fmt.a fmt_test.go format.go print.go # …
% gotest # by default, does all *_test.go
PASS
wally=% gotest -v fmt_test.go
=== RUN fmt.TestFlagParser
— PASS: fmt.TestFlagParser (0.00 seconds)
=== RUN fmt.TestArrayPrinter
— PASS: fmt.TestArrayPrinter (0.00 seconds)
=== RUN fmt.TestFmtInterface
— PASS: fmt.TestFmtInterface (0.00 seconds)
=== RUN fmt.TestStructPrinter
— PASS: fmt.TestStructPrinter (0.00 seconds)
=== RUN fmt.TestSprintf
— PASS: fmt.TestSprintf (0.00 seconds) # plus lots more
PASS
%

一個benchmark的測試例子

Benchmark的函式簽名如下:
複製程式碼 程式碼如下:
func BenchmarkXxxx(b *testing.B)

並被迴圈執行b.N次;其餘的由testing包完成。

下面是一個來自fmt_test.go中的benchmark例子:

複製程式碼 程式碼如下:
package fmt // package is fmt, not main  
import (  
    “testing” 
)  
func BenchmarkSprintfInt(b *testing.B) {  
    for i := 0; i < b.N; i {  
        Sprintf(“%d”, 5)  
    }  

Benchmarking: gotest

複製程式碼 程式碼如下:
% gotest -bench=”.” # regular expression identifies which
fmt_test.BenchmarkSprintfEmpty 5000000
310 ns/op
fmt_test.BenchmarkSprintfString 2000000
774 ns/op
fmt_test.BenchmarkSprintfInt
5000000
663 ns/op
fmt_test.BenchmarkSprintfIntInt 2000000
969 ns/op

%

庫就是包。

目前的庫規模是適中的,但還在增長。

一些例子:

包                      目的                          例子
fmt                  格式化I/O                     Printf、Scanf
os                   OS介面                        Open, Read, Write
strconv         numbers<-> strings          Atoi, Atof, Itoa
io                 通用I/O                            Copy, Pipe
flag              flags: –help等                      Bool, String
log               事件日誌                           Logger, Printf
regexp           正規表示式                      Compile, Match
template        html等                             Parse, Execute
bytes             位元組陣列                        Compare, Buffer

更多關於fmt

fmt包包含一些熟悉的名字:

複製程式碼 程式碼如下:
Printf – 列印到標準輸出
Sprintf – 返回一個字串
Fprintf – 寫到os.Stderr等

還有

複製程式碼 程式碼如下:
Print, Sprint, Fprint – 無格式no format
Println, Sprintln, Fprintln – 無格式,但中間加入空格,結尾加入\n

fmt.Printf(“%d %d %g\n”, 1, 2, 3.5)
fmt.Print(1, ” “, 2, ” “, 3.5, “\n”)
fmt.Println(1, 2, 3.5)

每個都輸出相同的結果:”1 2 3.5\n”

庫文件

原始碼中包含註釋。

命令列或web工具可以將註釋提取出來。

連結:http://golang.org/pkg/

命令:
複製程式碼 程式碼如下:
% godoc fmt
% godoc fmt Printf

您可能感興趣的文章:

MongoDB學習筆記(四) 用MongoDB的文件結構描述資料關係Go專案的目錄結構詳解Go語言基礎知識總結(語法、變數、數值型別、表示式、控制結構等)Go語言中的流程控制結構和函式詳解go語言工程結構