From 8a934e940dd9080fa93709a30d734d22df44e5c8 Mon Sep 17 00:00:00 2001 From: Unknwon Date: Fri, 6 Mar 2015 00:55:06 -0500 Subject: [PATCH] 9.8 --- README.md | 2 +- eBook/09.8.md | 144 ++++++++++++++++++++++++--------------------- eBook/09.9.md | 16 ++--- eBook/directory.md | 1 + 4 files changed, 89 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index e225159..c3c615d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ ## 翻译进度 -9.7 [使用 go install 安装自定义包](eBook/09.7.md) +9.8 [自定义包的目录结构、go install 和 go test](eBook/09.8.md) ## 支持本书 diff --git a/eBook/09.8.md b/eBook/09.8.md index 55daa25..591dfe9 100755 --- a/eBook/09.8.md +++ b/eBook/09.8.md @@ -1,50 +1,57 @@ # 9.8 自定义包的目录结构、go install 和 go test -212 -为了示范，我们创建了一个名为uc的简单包,它含有一个UpperCase函数将字符串的所有字母转换为大写。当然这并不值得创建一个自己包，同样的功能已被包含在"strings"包里，但是同样的技术也可以应用在更复杂的包中。 -##9.8.1 自定义包的目录结构 -下面的结构给了你一个好的示范(uc代表通用包名, 名字为粗体的代表目录，斜体代表可执行文件): +为了示范，我们创建了一个名为 uc 的简单包,它含有一个 UpperCase 函数将字符串的所有字母转换为大写。当然这并不值得创建一个自己包，同样的功能已被包含在 "strings" 包里，但是同样的技术也可以应用在更复杂的包中。 + +## 9.8.1 自定义包的目录结构 + +下面的结构给了你一个好的示范(uc 代表通用包名, 名字为粗体的代表目录，斜体代表可执行文件): /home/user/goprograms ucmain.go (uc包主程序) Makefile (ucmain的2-makefile) ucmain src/uc (包含uc包的go源码) uc.go uc_test.go Makefile (包的1-makefile) uc.a _obj uc.a _test uc.a bin (包含最终的执行文件) ucmain pkg/linux_amd64 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 - import "strings" +```go +package uc +import "strings" - func UpperCase(str string) string { - return strings.ToUpper(str) - } +func UpperCase(str string) string { + return strings.ToUpper(str) +} +``` -包通常附带一个或多个测试文件，在这我们创建了一个uc_test.go文件，如9.8章节所述 +包通常附带一个或多个测试文件，在这我们创建了一个 uc_test.go 文件，如第 9.8 节所述。 示例 9.7 [test.go](examples/chapter_9/uc.go) - package uc - import "testing" +```go +package uc +import "testing" - type ucTest struct { - in, out string - } +type ucTest struct { + in, out string +} - var ucTests = []ucTest { - ucTest{"abc", "ABC"}, - ucTest{"cvo-az", "CVO-AZ"}, - ucTest{"Antwerp", "ANTWERP"}, - } +var ucTests = []ucTest { + ucTest{"abc", "ABC"}, + ucTest{"cvo-az", "CVO-AZ"}, + ucTest{"Antwerp", "ANTWERP"}, +} - func TestUC(t *testing.T) { - for _, ut := range ucTests { - uc := UpperCase(ut.in) - if uc != ut.out { - t.Errorf("UpperCase(%s) = %s, must be %s", ut.in, uc, - ut.out) - } +func TestUC(t *testing.T) { + for _, ut := range ucTests { + uc := UpperCase(ut.in) + if uc != ut.out { + t.Errorf("UpperCase(%s) = %s, must be %s", ut.in, uc, + ut.out) } } -通过指令编译并安装包到本地：go install src/uc, 这会将uc.a复制到pkg/linux_amd64下面 -另外，使用make,通过以下内容创建一个包的Makefile(1)在src/uc目录下: +} +``` + +通过指令编译并安装包到本地：`go install src/uc`, 这会将 uc.a 复制到 pkg/linux_amd64 下面。 + +另外，使用 make,通过以下内容创建一个包的 Makefile(1) 在 src/uc 目录下: include $GOROOT/src/Make.inc @@ -53,37 +60,39 @@ uc.go\ include $(GOROOT)/scr/Make.pkg + 在该目录下的命令行调用: gomake -这将创建一个_obj目录并将包编译生成的存档uc.a放在该目录下 +这将创建一个 _obj 目录并将包编译生成的存档uc.a放在该目录下 -这个包可以通过go test测试 +这个包可以通过 go test 测试 -创建一个ud.a的测试文件在目录下，输出为PASS时测试通过 +创建一个 ud.a 的测试文件在目录下，输出为 PASS 时测试通过 -在13.8章节我们将给出另外一个测试例子并进行深入研究 +在第 13.8 节我们将给出另外一个测试例子并进行深入研究。 -备注：有可能你当前的用户不具有足够的资格使用go　install(没有权限)。这种情况下，选择root用户su。确保Go环境变量和Go源码路径也设置给su，同样也适用你的普通用户(详见2.3章节) +备注：有可能你当前的用户不具有足够的资格使用 go　install(没有权限)。这种情况下，选择 root 用户 su。确保 Go 环境变量和 Go 源码路径也设置给 su，同样也适用你的普通用户(详见第 2.3 节)。 -接下来我们创建主程序ucmain.go: +接下来我们创建主程序 ucmain.go: -示例 9.8 [ucmain.go](/examples/chapter_9/ucmain.go) +示例 9.8 [ucmain.go](/examples/chapter_9/ucmain.go)： - package main - import ( - "fmt" - "./uc/uc" - ) +```go +package main +import ( + "fmt" + "./uc/uc" +) - func main() { - str1 := "USING package uc" - fmt.Println(uc.UpperCase(str1)) - } +func main() { + str1 := "USING package uc" + fmt.Println(uc.UpperCase(str1)) +} +``` -然后在这个目录下输入go install +然后在这个目录下输入 `go install`。 -另外复制uc.a到uc目录并创建一个Makefile(2)并写入文本： -包含在$GOROOT/src/Make.inc +另外复制 uc.a 到 uc 目录并创建一个 Makefile(2) 并写入文本包含在 $GOROOT/src/Make.inc： TARG=ucmain GOFILES=\ @@ -91,25 +100,24 @@ include $GOROOT/src/Make.cmd -执行gomake编译ucmain.go到ucmain目录 +执行 gomake 编译 ucmain.go 到 ucmain 目录 -运行./ucmain显示: USING package uc! +运行 ./ucmain 显示: `USING package uc!`。 ## 9.8.2 本地安装包 -本地包在用户目录下： -使用给出的目录结构，以下命令用来从源码安装本地包： + +本地包在用户目录下，使用给出的目录结构，以下命令用来从源码安装本地包： go install /home/user/goprograms/src/uc # 编译安装uc cd /home/user/goprograms/uc go install ./uc # 编译安装uc（和之前的指令一样） cd .. go install . # 编译安装ucmain - 安装到$GOROOT下： - 如果我们想安装的包在系统上的其他Go程序中被使用，它一定要安装到$GOROOT下。 - 这样做，在.profile和.bashrc中设置GOPATH=$GOROOT。然后执行go install uc将会： + 安装到 $GOROOT 下： + 如果我们想安装的包在系统上的其他 Go 程序中被使用，它一定要安装到 $GOROOT 下。 + 这样做，在 .profile 和 .bashrc 中设置 GOPATH=$GOROOT。然后执行 go install uc 将会： -(1) 复制源代码到$GOROOT/src/pkg/linux_amd64/uc +(1) 复制源代码到 $GOROOT/src/pkg/linux_amd64/uc -(2) 复制包存档到$GOROOT/PKG/LINUX_AMD64/uc - -uc包可以通过"import uc"在任何Go程序中被引用。 +(2) 复制包存档到 $GOROOT/PKG/LINUX_AMD64/uc +uc 包可以通过 "import uc" 在任何 Go 程序中被引用。 ## 9.8.3 依赖系统的代码 @@ -118,8 +126,12 @@ uc包可以通过"import uc"在任何Go程序中被引用。 你有一个很好的理由去写平台平台特定的代码，例如汇编语言。这种情况下，按照下面的约定是合理的： prog1.go prog1_linux.go prog1_darwin.go prog1_windows.go - prog1.go定义了不同操作系统通用的接口，并将系统特定的代码写到prog1_os.go中。 - 对于Go工具你可以指定：prog1_$GOOS.go or prog1_$GOARCH.go - 或在平台Makefile中： prog1_$(GOOS).go\ or prog1_$(GOARCH).go\ - 示例 9.6: package strev - 运用前面9.7章节所有技术使用strev包解决练习9.2。 + prog1.go 定义了不同操作系统通用的接口，并将系统特定的代码写到 prog1_os.go 中。 + 对于 Go 工具你可以指定 prog1_$GOOS.go 或 prog1_$GOARCH.go + 或在平台 Makefile 中： prog1_$(GOOS).go\ 或 prog1_$(GOARCH).go\ + +## 链接 + +- [目录](directory.md) +- 上一节：[使用 go install 安装自定义包](09.7.md) +- 下一节：[通过 git 打包和安装](09.9.md) diff --git a/eBook/09.9.md b/eBook/09.9.md index 91e4b64..df9624a 100644 --- a/eBook/09.9.md +++ b/eBook/09.9.md @@ -1,5 +1,7 @@ -#9.9 通过git打包和安装 -##9.9.1 安装到github +# 9.9 通过 git 打包和安装 + +216 +##9.9.1 安装到github 以上的方式对于本地包来说是可以的，但是我们如何打包代码到开发者圈子呢？那么我们需要一个云端的源码的版本控制系统，比如著名的git。 在Linux和OS X的机器上git是默认安装的，在windows上你必须先自行安装,参见http:// help.github.com/win-set-up-git/ @@ -18,11 +20,11 @@ 也许你还不能登录，你可以去https://github.com/plans注册一个开源项目的免费帐号。输入正确的帐号密码和有效的邮箱地址并进一步创建用户。然后你将获得一个git命令的列表。本地仓库的操作的命令已经完成。一个优秀的系统http://help.github.com/在你遇到任何问题的时候将引导你。 -在云端创建一个新的uc仓库;发布的指令为(NNNN替代用户名): - +在云端创建一个新的uc仓库;发布的指令为(NNNN替代用户名): + git remote add orign git@github.com:NNNN/uc.git git push -u origin master - + 操作完成后检查github上的包页面: http://github.com/NNNN/uc ##9.9.2 从github安装 @@ -33,7 +35,7 @@ NNNN是你在github上的用户名 复制 ->uc.a包到目录$GOROOT/PKG/LINUX_AMD64/github.com ->源码到$GOROOT/src/pkg/github.com/NNNN/uc - + 这样现在这台机器上的其他Go应用程序也可以通过导入路径："github.com/NNNN/uc"代替"./uc/uc"来使用。 也可以将其缩写为: import uc "github.com/NNNN/uc" @@ -51,4 +53,4 @@ Gomake(和go install)将通过$GOROOT下的本地版本进行工作。 * googlecode(hg/git/svn) * launchpad(bzr) -版本控制系统可以选择你熟悉的或者本地使用的代码版本控制。Go核心代码的仓库是使用Mercurial(hg)来控制的，所以它是一个最可能保证你可以得到开发者项目中最好的软件。Git也很出名，同样也适用。如果你从未使用过的版本控制，这些网站有一些很好的帮助并且你可以通过在谷歌搜索"{name} tutorial"name为你想要使用的版本控制系统得到许多很好的教程。 \ No newline at end of file +版本控制系统可以选择你熟悉的或者本地使用的代码版本控制。Go核心代码的仓库是使用Mercurial(hg)来控制的，所以它是一个最可能保证你可以得到开发者项目中最好的软件。Git也很出名，同样也适用。如果你从未使用过的版本控制，这些网站有一些很好的帮助并且你可以通过在谷歌搜索"{name} tutorial"name为你想要使用的版本控制系统得到许多很好的教程。 diff --git a/eBook/directory.md b/eBook/directory.md index cf0b199..a2b5397 100644 --- a/eBook/directory.md +++ b/eBook/directory.md @@ -81,6 +81,7 @@ - 9.6 [为自定义包使用 godoc](09.6.md) - 9.7 [使用 go install 安装自定义包](09.7.md) - 9.8 [自定义包的目录结构、go install 和 go test](09.8.md) + - 9.9 [通过 git 打包和安装](09.9.md) - 第10章：结构（struct）与方法（method） - 第11章：接口（interface）与反射（reflection）