组织Golang代码
本月初golang官方blog(需要自己搭梯子)上发布了一篇文章,简要介绍了近几个月Go在一 些技术会议上(比如Google I/O、Gopher SummerFest等)的主题分享并伴有slide链接。其中David Crawshaw的“Organizing Go Code”对Golang的代码风格以及工程组 织的最佳实践进行的总结很是全面和到位,这里按Slide中的思路和内容翻译和摘录如下(部分伴有我个人的若干理解)。
一、包 (Packages)
1、Golang程序由package组成
所有Go源码都是包得一部分。
每个Go源文件都起始于一条package语句。
Go应用程序的执行起始于main包。
package main
import "fmt"
func main() {
fmt.Println("Hello, world!")
}
对小微型程序而言,你可能只需要编写main包内的源码。
上面的HelloWorld程序import了fmt包。
函数Println定义在fmt包中。
2、一个例子:fmt包
// Package fmt implements formatted I/O.
package fmt
// Println formats using the default formats for its
// operands and writes to standard output.
func Println(a …interface{}) (n int, err error) {
…
}
func newPrinter() *pp {
…
}
Println是一个导出(exported)函数,它的函数名以大写字母开头,这意味着它允许其他包中的函数调用它。
newPrinter函数则并非导出函数,它的函数名以小写字母开头,它只能在fmt包内部被使用。
3、包的形态(Shape)
包是有关联关系的代码的集合,包规模可大可小,大包甚至可以横跨多个源文件。
同一个包的所有源文件都放在一个单一目录下面。
net/http包共由18个文件组成,导出了超过100个名字符号。
errors包仅仅由一个文件组成,并仅导出了一个名字符号。
4、包的命名
包的命名应该短小且有含义。
不要使用下划线,那样会导致包名过长;
不要过于概况,一个util包可能包含任何含义的代码;
使用io/ioutil,而不是io/util
使用suffixarray,而不是suffix_array
包名是其导出的类型名以及函数名的组成部分。
buf := new(bytes.Buffer)
仔细挑选包名
为用户选择一个好包名。
5、对包的测试
通过文件名我们可以区分出哪些是测试用源文件。测试文件以_test.go结尾。下面是一个测试文件的样例:
package fmt
import "testing"
var fmtTests = []fmtTest{
{"%d", 12345, "12345"},
{"%v", 12345, "12345"},
{"%t", true, "true"},
}
func TestSprintf(t *testing.T) {
for _, tt := range fmtTests {
if s := Sprintf(tt.fmt, tt.val); s != tt.out {
t.Errorf("…")
}
}
}
二、代码组织(Code organization)
1、工作区介绍(workspace)
你的Go源码被放在一个工作区(workspace)中。
一个workspace可以包含多个源码库(repository),诸如git,hg等。
Go工具知晓一个工作区的布局。
你无需使用Makefile,通过文件布局,我们可以完成所有事情。
若文件布局发生变动,则需重新构建。
$GOPATH/
src/
github.com/user/repo/
mypkg/
mysrc1.go
mysrc2.go
cmd/mycmd/
main.go
bin/
mycmd
2、建立一个工作区
mkdir /tmp/gows
GOPATH=/tmp/gows
GOPATH环境变量告诉Go工具族你的工作区的位置。
go get github.com/dsymonds/fixhub/cmd/fixhub
go get命令从互联网网下载源代码库,并将它们放置在你的工作区中。
包的路径对Go工具来说很是重要,使用"github.com"意味着Go工具知道如何去获取你的源码库。
go install github.com/dsymonds/fixhub/cmd/fixhub
go install命令构建一个可执行程序,并将其放置在$GOPATH/bin/fixhub中。
3、我们的工作区
$GOPATH/
bin/fixhub # installed binary
pkg/darwin_amd64/ # compiled archives
code.google.com/p/goauth2/oauth.a
github.com/…
src/ # source repositories
code.google.com/p/goauth2/
.hg
oauth # used by package go-github
…
github.com/
golang/lint/… # used by package fixhub
.git
google/go-github/… # used by package fixhub
.git
dsymonds/fixhub/
.git
client.go
cmd/fixhub/fixhub.go # package main
go get获取多个源码库。
go install使用这些源码库构建一个二进制文件。
4、为何要规定好文件布局
在构建时使用文件布局意味着可以更少的进行配置。
实际上,它意味着无配置。没有Makefile,没有build.xml。
在配置上花的时间少了,意味着在编程上可以花更多的时间。
Go社区中所有人都使用相同的布局,这会使得分享代码更加容易。
Go工具在一定程度上对Go社区的建设起到了帮助作用。
5、你的工作区在哪?
你可以拥有多个工作区,但大多数人只使用一个。那么你如何设置GOPATH这个环境变量呢?一个普遍的选择是:
GOPATH=$HOME
这样设置会将src、bin和pkg目录放到你的Home目录下。(这会很方便,因为$HOME/bin可能已经在你的PATH环境变量中了)。
6、在工作区下工作
CDPATH=$GOPATH/src/github.com:$GOPATH/src/code.google.com/p
$ cd dsymonds/fixhub
/tmp/gows/src/github.com/dsymonds/fixhub
$ cd goauth2
/tmp/gows/src/code.google.com/p/goauth2
$
将下面shell函数放在你的~/.profile中:
gocd () { cd `go list -f '{{.Dir}}' $1` }
$ gocd …/lint
/tmp/gows/src/github.com/golang/lint
$
三、依赖管理
1、在生产环境中,版本很重要
go get总是获取最新版本代码,即使这些代码破坏了你的构建。
这在开发阶段还好,但当你在发布阶段时,这将是一个问题。
我们需要其他工具。
2、版本管理
我最喜欢的技术:vendoring。
当构建二进制程序时,将你关心的包导入到一个_vendor工作区。
GOPATH=/tmp/gows/_vendor:/tmp/gows
注:
1、在build时,我们通过构建脚本,临时修改GOPATH(GOPATH := ${PWD}/_vendor:${GOPATH}), 并将_vendor放置在主GOPATH前面,利用go build解析import包路径解析规则,go build优先得到_vendor下的第三方包信息,这样即便原GOPATH下有不同版本的相同第三方库,go build也会优先导入_vendor下的同名第三方库。
2、go的相关工具在执行类似test这样的命令时会忽略前缀为_或.的目录,这样_vendor下的第三方库的test等操作将不会被执行。
当构建库时,将你关心的包导入你的源码库。重命名import为:
import "github.com/you/proj/vendor/github.com/them/lib"
长路径,不过对于自动化操作来说不算什么问题。写一个Go程序吧!
另外一种技术:gopkg.in。提供带版本的包路径:
gopkg.in/user/pkg.v3 -> github.com/user/pkg (branch/tag v3, v3.N, or v.3.N.M)
四、命名
1、命名很重要
程序源码中充满着各种名字。名字兼具代价和收益。
代价:空间与时间
当阅读代码时,名字需要短时记忆
你只能适应这么多,更长的名字需要占据更多的空间。
收益:信息
一个好名字不仅仅是一个指代对象,它还能够传达某种信息。
使用尽可能最短的名字用于在上下文中携带合理数量的信息。
在命名上花些时间(值得的)。
2、命名样式
使用camelCase,不要用下划线。
本地变量名字应该短小,通常由1到2个字符组成。
包名同行是一个小写词。
全局变量应该拥有长度更长的名字。
不要结巴!
使用bytes.Buffer,不要用bytes.ByteBuffer
使用zip.Reader,不要用zip.ZipReader
使用errors.New,不要用errors.NewError
使用r,不用bytesReader
使用i,不用loopIterator
3、文档化注释
文档化注释放在导出标示符的声明之前:
// Join concatenates the elements of elem to create a single string.
// The separator string sep is placed between elements in the resulting string.
func Join(elem []string, sep string) string {
godoc工具可以解析出这些注释并将其展示在Web上:
func Join
func Join (a []string, sep string) string
Join concatenates the elements of a to create a single string. The separetor string sep is placed between elements in the resulting string.
4、写文档化的注释
文档化的注释应用使用英文句子和段落。
除了为预定义格式进行的缩进外,没有其他特殊格式。
文档化注释应该以要描述的名词开头。
// Join concatenates… good
// This function… bad
包的文档应该放在包声明语句之前:
// Package fmt…
package fmt
在godoc.org上阅读Go世界的文档,比如:
godoc.org/code.google.com/p/go.tools/cmd/vet
组织Golang代码的更多相关文章
- #001 如何组织JS代码
如何组织JS代码 有没有这样的经历,在编写代码的时候,因为功能简单,写的时候比较随意,所有的JS代码都放在一个文件里面,但是随着功能的增加,发现代码很乱,不好维护. 简单的整理了一下,目前对已有项目的 ...
- TCP粘"包"问题浅析及解决方案Golang代码实现
一.粘"包"问题简介 在socket网络编程中,都是端到端通信,客户端端口+客户端IP+服务端端口+服务端IP+传输协议就组成一个可以唯一可以明确的标识一条连接.在TCP的sock ...
- 开始编写Golang代码
介绍 本文主要讲述如何写一个简单的Go包和如何使用golang的工具,如何获取.编译和安装Go的包,以及如何使用go的命令. Go的工具需要将代码按照一定的方式来组织.所以请认真阅读本文. 代码的组织 ...
- 使用BEM命名规范来组织CSS代码
BEM 是 Block(块) Element(元素) Modifier(修饰器)的简称 使用BEM规范来命名CSS,组织HTML中选择器的结构,利于CSS代码的维护,使得代码结构更清晰(弊端主要是名字 ...
- Golang代码实现HTTPs(HTTPS证书生成和部署)
在win7下试试: 1.实现一个最简单的HTTPS Web Server // gohttps/2-https/server.go package main import ( "fmt&qu ...
- golang代码片段(摘抄)
以下是从golang并发编程实战2中摘抄过来的代码片段,主要是实现一个简单的tcp socket通讯(客户端发送一个数字,服务端计算该数字的立方根然后返回),写的不错,用到了go的并发以及看下郝林大神 ...
- vim(三)golang代码跳转配
在golang的代码里跳来跳去.... godef 安装 跳转是通过godef实现,godef的安装目录一般是$GOBIN,只要让godef命令在$PATH下即可 godef 命令安装: go get ...
- 密码学奇妙之旅、02 混合加密系统、AES、RSA标准、Golang代码
CTR 计数器模式 计数器模式CTR是分组密码模式中的一种.通过将逐次累加的计数器进行加密来生成密钥流的流密码.每次加密时会生成一个不同的值来作为计数器的初始值. 可以事先进行加密.解密的准备. 加密 ...
- golang代码执行顺序
一:首先man.go,整个程序的入口 func main() { beego.Run() } 然后beego.run()代码 // Run beego application. // beego.Ru ...
随机推荐
- xp安装maven
1.下载apache-maven-2.0.8 2.设置xp环境变量 MAVEN_HOME D:\apache-maven-2.0.8 在path里面假如 %MAVEN_HOME%\bin 然后打开c ...
- makefile中使用echo向文件中输出版本号和编译时间
@echo "#define BUILD_TIME" `date +"%F_%H:%M:%S"` > buildTime_svnVer.h @echo & ...
- Android.mk与jni目录的关系
附1: Android.mk与jni目录的关系: 在某目录下,如/src/modules1/下存放Android.mk和Application.mk,调用ndk-build试图编译时,会遇到如下错误: ...
- mysql笔记6之数据类型
1 区别一: varchar:可变长度的字符串.根据添加的数据长度决定占用的字符数 char:固定长度的字符串 2区别二 int:没有限制 int(4):限制为4 3 区别三: 日期: date ...
- Json.net对数据的解析
在官网下载Json.net文件后,解压完将Net20下面的DLL复制到Assets目录下. using UnityEngine; using System.Collections; using New ...
- php csv操作
csv的写入数据: $data = array( array('qq号','登录时间','名称'), array('123456','2012-08-21 15:21:10'.chr(1),'我是来测 ...
- Android Studio开发环境的配置
为了使开发人员与时俱进, 在这里给大家讲解一下Android Studio的安装步骤及设置. 使用的是Android的最新版本,0.4.2版本,Android Studio可以脱离Eclipse单独运 ...
- compileSdkVersion,buildToolsVersion还有targetSdkVersion要一致,从而避免build的时候报错
Android Studio里的app的build.gradle文件: android { compileSdkVersion 24 buildToolsVersion "24.0.0&qu ...
- 关于java.lang.reflect.InvocationTargetException(jar 包缺少或者冲突)的错误
我在合肥那边运行了的是湖北石首市的项目没有错 可是回武汉之后 运行这个项目 点击这里的时候 就报错java.lang.reflect.InvocationTargetException 不是数据库 ...
- 关于数据结构的10个面试题(c语言实现)
关于数据结构的10个面试题(c语言实现) 2010-04-21 22:17 5702人阅读 评论(0) 收藏 举报 数据结构面试c语言bttree 1. 输入一个链表的头结点,从尾到头 ...