编写地道的Go代码

最地道的Go代码就是Go的标准库的代码,有空的时候可以多看看Google的工程师是如何实现的。

1. 注释

可以通过/* ... */或者//增加注释, //之后应该有个空格
如果想在每个文件的头部加上注释,需要在版权注释和Package前面加一个空行,否则版权注释会作为package的注释

// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

/*
Package net provides a portable interface for network I/O, including
TCP/IP, UDP, domain name resolution, and Unix domain sockets.
......
*/

package net
......

注:注释应该用一个完整的句子,注释的第一个单词应该是要注释的指示符,以便在godoc中容易查找;
注释应该以 . 结尾;

2. 声明slice

使用下面这种方式声明slice:

var s []string

而不是下面这种格式

t := []string{}

注:前者声明了一个nilslice, 而后者声明了一个长度为0的非nilslice

3. 字符串的大小写

错误字符串不应该大写,应写成:

fmt.Errorf("failed to write data.")

而不是写成:

fmt.Errorf("Failed to write data")

因为,这些字符串可能和其他字符串相连接,组合后的字符串如果中间有大写字母开头的单词很突兀,除非这些首字母大写单词是固定使用的单词。

注:缩写词必须保持一致,比如都大写URL或者小写url;
常亮一般声明为MaxLength,而不是以下划线分割MAX_LENGTH或者MAXLENGTH;

4.处理error而不是panic或者忽略

为了代码的强健性,不要使用_忽略错误,而是要处理每一个错误,尽管代码写起来有些繁琐也不要忽略错误;

尽量不要使用panic;

5. 一些名称

包名应该使用单数形式,比如util,model,而不是utils,models;

Receiver的名称应该缩写,一般使用一个或两个字符作为Receiver的名称,如:

func (f foo) method {

    ...

}

有些单词可能有多种写法,在项目中应保持一致,比如Golang采用的写法:

// marshaling
// unmarshaling
// canceling
// cancelation

而不是:

// marshalling
// unmarshalling
// cancelling
// cancellation

6.空字符串检查

正确方式:

if s == "" {
    ...
}

而不是:

if len(s) == 0 {
    ...
}

更不是:

if s == nil || s == ""{
    ...
}

7.非空slice检查

正确方式:

if len(s) > 0 {
    ...
}

而不是:


if s != nil && len(s) > 0 {
    ...
}

8. 直接使用bool值

对于bool类型的变量var b bool, 直接使用它作为判断,而不是使用它和true/false进行比较
正确方式:

if b {
    ...
}
if !b {
    ...
}

而不是:

if b == true {
    ...
}
if b == false {
    ...
}

9. byte/slice/string相等性比较

var s1 []byte
var s2 []byte

    ...
bytes.Equal(s1, s2) == 0
bytes.Equal(s1, s2) != 0

而不是:

var s1 []byte
var s2 []byte

    ...
bytes.Compare(s1, s2) == 0    
bytes.Compare(s1, s2) != 0

10. 检查是否包含子字符串

应使用strings.ContainesRune, strings.ContainesAny, strings.Contains

11. 复制slice

使用内建函数copy,而不是遍历slice逐个复制
正确方式

var b1, b2 []byte
copy(b2, b1)

12. 尽量缩短if

正确方式:

  var a, b int
  ...
  return a > b

而不是:

    var a, b int
    ...
    if a > b {
        return true
    } else {
        return false
    }

13.简化range

正确方式:

    for range m {
        ...
    }

而不是:

       var m map[string]int
       for _ = range m { 
    }
    for _, _ = range m {
    }

14.使用strings.TrimPrefix / strings.TrimSuffix

正确方式:

    var s1 = "a string value"
    var s2 = "a "
    var s3 = strings.TrimPrefix(s1, s2)

而不是:

       var s1 = "a string value"
       var s2 = "a "
       var s3 string
    if strings.HasPrefix(s1, s2) { 
        s3 = s1[len(s2):]
    }

15.append slice

正确方式:

    var a, b []byte
    a = append(b, a...)

而不是:

    var a, b []byte
    for _,v range a {
        append(b, v)
    }

参考文档

http://colobu.com/2017/02/07/write-idiomatic-golang-codes/

effective go

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容

  • 第5章 引用类型(返回首页) 本章内容 使用对象 创建并操作数组 理解基本的JavaScript类型 使用基本类型...
    大学一百阅读 3,152评论 0 4
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • 得到周二例会 成为一家透明的公司,这是未来每个公司将要发展的方向。不断给员工和客户附能。不是凭公司的发展理念和口号...
    潭客富林的家阅读 203评论 0 1
  • 细条叶子白星花,田园随处可安家。 历经一季暑热苦,结下串串小梢瓜。 两头尖尖似纺锤,入口甜脆味上佳。 采来权当野果...
    缘wxh阅读 685评论 23 26
  • 291976-陈国艳《2017-02-19》 【第8天总结】 A、目标完成情况 1、背诵复习2A完成50% 2、听...
    国艳更文的365天阅读 149评论 0 0