This commit is contained in:
Unknwon
2015-03-05 02:48:45 -05:00
parent eab1d98ba8
commit 5ec2c25387
5 changed files with 66 additions and 54 deletions

View File

@@ -9,7 +9,7 @@
## 翻译进度 ## 翻译进度
9.5 [自定义包和可见性](eBook/09.5.md) 9.7 [使用 go install 安装自定义包](eBook/09.7.md)
## 支持本书 ## 支持本书

View File

@@ -1,29 +1,29 @@
# 9.6 为自定义包使用 godoc # 9.6 为自定义包使用 godoc
208 godoc工具第 3.6 节)在显示自定义包中的注释也有很好的效果:注释必须以 // 开始并无空行放在声明类型函数前。godoc 会为每个文件生成一系列的网页。
godoc工具(3.6章节)在显示自定义包中的注释也有很好的效果:注释必须以//开始并无空行放在声明(包,类型,函数)前。godoc会为每个文件生成一系列的网页。
例如: 例如:
-在do_examples目录下我们有11.7节中的用来排序的go文件文件中有一些注释文件需要未编译 -do_examples 目录下我们有11.7 节中的用来排序的 go 文件,文件中有一些注释(文件需要未编译)
- 命令行下进入目录下并输入命令:
-命令行下进入目录下并输入命令:
godoc -http =:6060 -paht="." godoc -http =:6060 -paht="."
(.是指当前目录,-path参数可以是/path/to/my/package1这样的形式指出package1在你源码中的位置或接受用冒号形式分隔的路径无根目录的路径为相对于当前目录的相对路径) `.` 是指当前目录,-path 参数可以是 /path/to/my/package1 这样的形式指出 package1 在你源码中的位置或接受用冒号形式分隔的路径,无根目录的路径为相对于当前目录的相对路径
-在浏览器打开地址 http://localhost:6060 - 在浏览器打开地址http://localhost:6060
然后你会看到本地的 godoc 页面(详见第 3.6 节)从左到右一次显示出目录中的包:
然后你会看到本地的godoc页面(参见3.6章节)从左到右一次显示出目录中的包
doc_example: doc_example:
doc_example | Packages | Commands | Specification doc_example | Packages | Commands | Specification
下面是链接到源码和所有对象时有序概述(所以是很好的浏览和查找源代码的方式),连同文件/评论。 下面是链接到源码和所有对象时有序概述所以是很好的浏览和查找源代码的方式,连同文件/注释:
sort包 sort
```go
func Float64sAreSorted func Float64sAreSorted
type IntArray type IntArray
@@ -31,6 +31,7 @@ type IntArray func IntsAreSortedfunc IsSortedfunc Sort
func IntsAreSortedfunc IsSortedfunc Sort func IntsAreSortedfunc IsSortedfunc Sort
func (IntArray) Len func (IntArray) Len
func SortFloat64s func SortFloat64s
func (IntArray) Less

View File

@@ -1,37 +1,45 @@
# 9.7使用go install安装自定义包 # 9.7 使用 go install 安装自定义包
go installGo中自动包安装工具如需要将包安装到本地它会从远端仓库下载包检出编译安装一气呵成。 go installGo 中自动包安装工具:如需要将包安装到本地它会从远端仓库下载包:检出,编译,安装一气呵成。
在包安装前的先决条件是要自动处理包自身依赖关系的安装。被依赖的包也会安装到子目录下,但是没有文档和示例:可以到网上浏览。 在包安装前的先决条件是要自动处理包自身依赖关系的安装。被依赖的包也会安装到子目录下,但是没有文档和示例:可以到网上浏览。
被安装包的列表可以在$GORROT/goinstall.log找到。 被安装包的列表可以在 $GORROT/goinstall.log 找到。
go install使用了GOPATH变量(参见2.2节)。 go install 使用了 GOPATH 变量(详见第 2.2 节)。
远端包(参见9.5节) 远端包(详见第 9.5 节)
假设我们要安装一个有趣的包tideland(它包含了许多帮助示例参见http://code.google.com/p/tideland-cgl) 假设我们要安装一个有趣的包 tideland它包含了许多帮助示例,参见http://code.google.com/p/tideland-cgl
因为我们需要创建目录在Go安装目录下所以我们需要使用root或者su的身份执行命令。 因为我们需要创建目录在 Go 安装目录下,所以我们需要使用 root 或者 su 的身份执行命令。
确保Go环境变量已经设置在root用户下的./bashrc文件中。 确保 Go 环境变量已经设置在 root 用户下的 ./bashrc 文件中。
使用命令安装go install tideland-cgl.googlecode.com/hg 使用命令安装:`go install tideland-cgl.googlecode.com/hg`
可执行文件hg.a将被放到$GOROOT/pkg/linux_amd64/tideland-cgl.googlecode.com目录下源码文件被放置在$GOROOT/src/tideland-cgl.googlecode.com/hg目录下同样有个hg.a放置在_obj的子目录下。 可执行文件 hg.a 将被放到 $GOROOT/pkg/linux_amd64/tideland-cgl.googlecode.com 目录下,源码文件被放置在 $GOROOT/src/tideland-cgl.googlecode.com/hg 目录下,同样有个 hg.a 放置在 _obj 的子目录下。
现在就可以在go代码中使用这个包中的功能了例如使用报名cgl导入 现在就可以在 go 代码中使用这个包中的功能了,例如使用报名 cgl 导入:
import cgl "tideland-cgl.googlecode.com/hg" ```go
import cgl "tideland-cgl.googlecode.com/hg"
从Go1起go install安装Google Code的导入路径形式是"code.google.com/p/tideland-cgl" ```
从 Go1 起 go install 安装 Google Code 的导入路径形式是:`"code.google.com/p/tideland-cgl"`
升级到新的版本: 升级到新的版本:
更新到新版本的Go之后本地安装包的二进制文件将全被删除。当调用install-a工具将通过读取$GOROOT/goinstall.log重新安装以前的安装包。如果你想更新重编译重安装所有的go安装包可以使用go install -a -u -clean 或者 go install -a -u -nuke 更新到新版本的 Go 之后本地安装包的二进制文件将全被删除。当调用 install -a 工具将通过读取 $GOROOT/goinstall.log 重新安装以前的安装包。如果你想更新重编译重安装所有的go安装包可以使用`go install -a -u -clean` 或者 `go install -a -u -nuke`
go的版本发布的很频繁所以需要注意发布版本和包的兼容性。go1之后都是自己编译自己了。 go 的版本发布的很频繁所以需要注意发布版本和包的兼容性。go1 之后都是自己编译自己了。
go install同样可以使用go install编译链接并安装本地自己的包:参见9.8.2章节 go install 同样可以使用 go install 编译链接并安装本地自己的包(详见第 9.8.2 节)
更多信息可以在http://golang.org/cmd/gohttp://golang.org/cmd/goinstall找到。 更多信息可以在 http://golang.org/cmd/gohttp://golang.org/cmd/goinstall 找到。
## 链接
- [目录](directory.md)
- 上一节:[为自定义包使用 godoc](09.6.md)
- 下一节:[自定义包的目录结构、go install 和 go test](09.8.md)

View File

@@ -1,56 +1,57 @@
#9.8 自定义包:目录结构,go installgo test # 9.8 自定义包目录结构go installgo test
212
为了示范我们创建了一个名为uc的简单包,它含有一个UpperCase函数将字符串的所有字母转换为大写。当然这并不值得创建一个自己包同样的功能已被包含在"strings"包里,但是同样的技术也可以应用在更复杂的包中。 为了示范我们创建了一个名为uc的简单包,它含有一个UpperCase函数将字符串的所有字母转换为大写。当然这并不值得创建一个自己包同样的功能已被包含在"strings"包里,但是同样的技术也可以应用在更复杂的包中。
##9.8.1 自定义包的目录结构 ##9.8.1 自定义包的目录结构
下面的结构给了你一个好的示范(uc代表通用包名, 名字为粗体的代表目录,斜体代表可执行文件): 下面的结构给了你一个好的示范(uc代表通用包名, 名字为粗体的代表目录,斜体代表可执行文件):
/home/user/goprograms /home/user/goprograms
ucmain.go (uc包主程序) ucmain.go (uc包主程序)
Makefile (ucmain的2-makefile) Makefile (ucmain的2-makefile)
ucmain ucmain
src/uc (包含uc包的go源码) src/uc (包含uc包的go源码)
uc.go uc.go
uc_test.go uc_test.go
Makefile (包的1-makefile) Makefile (包的1-makefile)
uc.a uc.a
_obj _obj
uc.a uc.a
_test _test
uc.a uc.a
bin (包含最终的执行文件) bin (包含最终的执行文件)
ucmain ucmain
pkg/linux_amd64 pkg/linux_amd64
uc.a (包的目标文件) uc.a (包的目标文件)
将你的项目放在goprograms目录下(你可以创建一个环境变量GOPATH,参考2.2/3章节:在.profile和.bashrc文件中添加export GOPATH=/home/user/goprograms)而你的项目将作为src的子目录。uc包 中的功能在uc.go中实现。 将你的项目放在goprograms目录下(你可以创建一个环境变量GOPATH,参考2.2/3章节:在.profile和.bashrc文件中添加export GOPATH=/home/user/goprograms)而你的项目将作为src的子目录。uc包 中的功能在uc.go中实现。
示例 9.6 [uc.go](examples/chapter_9/uc.go) 示例 9.6 [uc.go](examples/chapter_9/uc.go)
package uc package uc
import "strings" import "strings"
func UpperCase(str string) string { func UpperCase(str string) string {
return strings.ToUpper(str) return strings.ToUpper(str)
} }
包通常附带一个或多个测试文件在这我们创建了一个uc_test.go文件如9.8章节所述 包通常附带一个或多个测试文件在这我们创建了一个uc_test.go文件如9.8章节所述
示例 9.7 [test.go](examples/chapter_9/uc.go) 示例 9.7 [test.go](examples/chapter_9/uc.go)
package uc package uc
import "testing" import "testing"
type ucTest struct { type ucTest struct {
in, out string in, out string
} }
var ucTests = []ucTest { var ucTests = []ucTest {
ucTest{"abc", "ABC"}, ucTest{"abc", "ABC"},
ucTest{"cvo-az", "CVO-AZ"}, ucTest{"cvo-az", "CVO-AZ"},
ucTest{"Antwerp", "ANTWERP"}, ucTest{"Antwerp", "ANTWERP"},
} }
func TestUC(t *testing.T) { func TestUC(t *testing.T) {
@@ -73,12 +74,12 @@
include $(GOROOT)/scr/Make.pkg include $(GOROOT)/scr/Make.pkg
在该目录下的命令行调用: gomake 在该目录下的命令行调用: gomake
这将创建一个_obj目录并将包编译生成的存档uc.a放在该目录下 这将创建一个_obj目录并将包编译生成的存档uc.a放在该目录下
这个包可以通过go test测试 这个包可以通过go test测试
创建一个ud.a的测试文件在目录下输出为PASS时测试通过 创建一个ud.a的测试文件在目录下输出为PASS时测试通过
在13.8章节我们将给出另外一个测试例子并进行深入研究 在13.8章节我们将给出另外一个测试例子并进行深入研究
@@ -87,9 +88,9 @@
接下来我们创建主程序ucmain.go: 接下来我们创建主程序ucmain.go:
示例 9.8 [ucmain.go](/examples/chapter_9/ucmain.go) 示例 9.8 [ucmain.go](/examples/chapter_9/ucmain.go)
package main package main
import ( import (
"fmt" "fmt"
"./uc/uc" "./uc/uc"
) )
@@ -97,7 +98,7 @@
func main() { func main() {
str1 := "USING package uc" str1 := "USING package uc"
fmt.Println(uc.UpperCase(str1)) fmt.Println(uc.UpperCase(str1))
} }
然后在这个目录下输入go install 然后在这个目录下输入go install

View File

@@ -79,6 +79,8 @@
- 9.4 [精密计算和 big 包](09.4.md) - 9.4 [精密计算和 big 包](09.4.md)
- 9.5 [自定义包和可见性](09.5.md) - 9.5 [自定义包和可见性](09.5.md)
- 9.6 [为自定义包使用 godoc](09.6.md) - 9.6 [为自定义包使用 godoc](09.6.md)
- 9.7 [使用 go install 安装自定义包](09.7.md)
- 9.8 [自定义包的目录结构、go install 和 go test](09.8.md)
- 第10章结构struct与方法method - 第10章结构struct与方法method
- 第11章接口interface与反射reflection - 第11章接口interface与反射reflection