Go语言的代码组织结构详细介绍
包(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工具可以将注释提取出来。
链接:
命令:
% godoc fmt
% godoc fmt printf