首页 > 资讯 > 精选 >Go编码规范有哪些

273

分享到

Go编码规范有哪些

2023-07-04 18:07:50 273人浏览安东尼

摘要

本文小编为大家详细介绍“Go编码规范有哪些”，内容详细，步骤清晰，细节处理妥当，希望这篇“Go编码规范有哪些”文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。1. 代码风格1.1 代码格式代码必须用 gofmt 进行

本文小编为大家详细介绍“Go编码规范有哪些”，内容详细，步骤清晰，细节处理妥当，希望这篇“Go编码规范有哪些”文章能帮助大家解决疑惑，下面跟着小编的思路慢慢深入，一起来学习新知识吧。

1. 代码风格

1.1 代码格式

代码必须用 gofmt 进行格式化，goland 可以配置，可以自行搜索一下配置
我们编写的代码每行应该不超过 120 个字符，超出部分用换行解决。
单个文件最大行数最大不超过 800 行.
单个函数最大行数不超过 80 行。
import 规范

不要使用相对路径引入包，例如 import ../util/net
在导入包时，多个相同包名冲突时，必须使用导入别名

// bad"GitHub.com/google/uuid"// gooduuid "github.com/google/uuid"

导入的包建议分组，引用匿名包建议用一个新的分组，并加上注释方便后面小伙伴阅读

import (    // Go 标准库    "fmt"    //第三方包    "github.com/jinzhu/gORM"    "github.com/google/uuid"    "github.com/go-redis/Redis/v8"    // 匿名包    /import mysql driver    _"github.com/jinzhu/gorm/dialects/Mysql"    // 内部包    slice "xxx.local/pkg/v1/goslice"    meta "xxx.local/pkg/v1/meta"    gomap "xxx.local/pkg/v2/gomap")

1.2 声明、初始化和定义

一个函数需要使用多个变量时，可以在函数最开头处使用 var 声明。在函数外部声明的变量不能使用 :=

var (    port = 8081    metricServerPort = 2001)

在初始化结构体用 &struct 代替 new(struct)，确保与结构体初始化一致，初始化结构体时换行。

// badstu := new(S)stu.Name = "张三"// goodstu := &S{    Name:"李四"}

使用 make 在声明 map、array 等应该指定容器的容量，从而达到预先分配内容。

users := make(map[int]string, 10)tags := make([]int, 0, 10)

使用标准 var 关键字事，不要指定类型，除非它与表达式的类型不同。

// badvar _f string F()func F() string {    return "hello world!"}// good var _f F()func F() string {    return "hello world!"}

1.3 error 处理

若函数返回 error，必须对 error 进行处理，如果业务允许可以用 _ 接受忽略。对应 defer 可以不用显式进行处理。

// badfunc InitConfig() error {    ...}InitConfig()// goodfunc InitConfig() error {    ...}err := InitConfig()if err != nil {    ...}// or _ := InitConfig()

error 作为返回值时必须作为最后一个参数返回

// badfunc InitConfig() (error,int) {    ...}// good func InitConfig() (int, error) {    ...}

错误需要单独处理，尽量不要与其他的逻辑耦合在一起。

// badres, err := InitConfig()if err != nil || res != nil {    return err}// goodres, err := InitConfig()if err != nil {    return err}if res != nil {    return fmt.Errorf("invalid result")}

1.4 panic处理

业务代码中禁止抛出 panic 错误。
panic 只允许出现在在服务启动之前，如读取配置、链接存储（redis、mysql 等）。
业务代码中建议用 error 而不是 panic 来传递。

1.5 单元测试

每个重要的函数都要编写测试用例，合并代码要自动化运行一下所有的 test。
文件命名 xxx_test.go。
函数命名建议使用 Test函数名。

2. 命名规范

在每个语言中，命名规范在代码规范中非常重要，一个统一的、精确的命名不仅仅可以提高代码的可读性，也可以让人觉的这个同志真的会呀。牛！

2.1 包命名规范

包名必须与目录名一致（这和其他 PHP、Java 还是有一点不太一样的），尽量采取有意义、简短的包名，不要与 go 的标准库名称一样。
包名小写，没有下划线，可以使用中划线隔开，使用多级目录来划分目录。
包名不要出现复数命名。
包名命名尽量简单一目了然，ge：user、log。

2.2 文件命名规范

文件名要见名思义，尽量简而短
文件名小写，组合词用下划线分割

2.3 函数命名规范

与 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
单元测试的函数用大驼峰，TestFunc。

2.4 结构体命名规范

与 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
避免使用 info 、data 这种无意义的名称。
命名使用名词而非动词。
结构体在声明和初始化的时候需要换行，eg：

type Student struct{    Name string    Age uint8}student := Student{    Name: "张三",    Age: 18,}

2.5 变量命名规范

和 php、Java 一样，必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
若变量为私有时，可以使用小写命名。
局部变量可以简写，eg：i 表示 index。
若变量代表 bool 值，则可以使用 Is 、Can、Has 前缀命名，eg：

var isExit boolvar canReturn bool

2.6 常量命名规范

必须遵循驼峰规范，Go 语言中需要根据访问的控制决定大驼峰还是小驼峰。
若代表枚举值，需要先创建。

type Code intconst (    ErrNotFound Code = iota    ErrFatal)

3. 类型

3.1 字符串

好像学过的语言中，都是从字符串开始说起的。就像写代码第一行都是从 Hello World！一样！同意的点赞哈。

字符串判空值

// badif s == "" {    ...} // good if len(s) == 0 {    ...}

字符串去除前后子串。

// badvar s1 "hello world"var s2 "hello"var s3 strings.TrimPrefix(s1, s2)// goodvar s1 "hello world"var s2 "hello"var s3 stringif strings.HasPrefix(s1, s2){    s3 = s1[len(s2):]}

3.2 切片 slice

声明 slice。

// bads := []string{}s := make([]string, 10)// goodvar s []strings := make([]string, 0, 10)

非空判断。

//badif len(slice) >0 {    ...} // good if slice != nil && len(slice) > 0 {    ...}

slice copy。

// badvar b1,b2 []bytefor i, v := range b1 {    b2[i] = v}for i := range b1 {    b2[i] = b1[i]}// goodcopy(b2,b1)

slice 新增。

// badvar a,b []intfor _, v := range a {    b = append(b,v)}// goodvar a, b []intb := append(b, a...)

3.4 结构体 struct

初始化需要多行。

type Student struct{    Name string    Age uint8}student := Student{    Name: "张三",    Age: 18,}

4. 控制语句

4.1 if

if 可以用局部变量的方式初始化。

if err := InitConfig; err != nil {    return err}

4.2 for

不允许在 for 中使用 defer， defer 只在函数结束时才会执行。

// badfor file := range files {    fd, err := os.Open(file)    if err != nil {        return err    }    defer fd.close()}// good    for file := range files{    func() {        fd,err := os.open(file)        if err！=nil {            return err        }        defer fd.close()    }()}

4.3 range

如果不需要 key 直接用 _ 忽略，value 也一样。

for _, v := range students {    ...}for i, _ := range students {    ...}for i, v := range students {    ...}

注：若操作指针时请注意不能直接用 s := v。想知道可以评论区告诉我哦！

4.4 switch

和其他语言不一样，必须要有 defalt

switch type {    case 1:        fmt.Println("type = 1")        break     case 2:        fmt.Println("type = 2")        break     default :        fmt.Println("unKnown type")}