SRE文档

深浅模式

1.golang标识符、关键字、命名规则 ​

1.1标识符 ​

标识符英文是identifier，通俗讲，就是给变量、常量、函数、方法、结构体、数组、切片、接口起名字。

只要定义了变量，必须使用，否则编译会出错

1.1.1标识符组成 ​

  1. 标识符由数字、字母和下划线(_)组成
  2. 只能以字母和下划线(_)开头
  3. 标识符区分大小写

1.2关键字 ​

go语音提供了25个关键字

breakdefaultfuncinterfaceselect
casedefergomapstruct
chanelsegotopackageswitch
constfallthroughifrangetype
continueforimportreturnvar

除了以上介绍的关键字，Go语言还有36个预定义标识符，其中包含了基本类型的名称和一些基本的内置函数

appendboolbytecapclosecomplexcomplex64compesx128uint16
copyfalsefloat32float64imageintint8int16uint32
int32int64iotalenmakenewnilpanicuint64
printprintlnrealrecoverstringtrueuintuint8uintptr

1.3命名规范 ​

Go是一门区分大小写的语言

命名规则涉及变量、常量、全局函数、结构、接口、方法等的命名。Go语音从语法层面进行了以下限定:任何需要对外暴漏的名字必须以大写字母开头，不需要对外暴漏的则应该以小写字母开头。

当命名（包含常量、变量、类型、函数名、结构字段等）以一个大写字母开头，如：GetUserName，那么使用这种形式的标识符的对象就可以被外部的代码所使用（客户端程序需要先导入这个包），这被称为导出（像面向对象语言中的public）；

命名如果是小写字母开头，则对外是不可见的，但是他们在整个包的内部是可见并且可用的（像面向对象语言中的private）

1.4包名称 ​

保持package的名字和目录保持一致，尽量采取有意义的包名，简短，有意义，尽量和标准库不要冲突。包名应该为小写单词，不要使用下划线或者混合大小写。

package service
package service

1.5文件命名 ​

尽量采取有意义的文件名，简短、有意义，应该为小写单词，使用下划线分割各个单词

customer_dao.go
customer_dao.go

1.6结构体命名 ​

采用驼峰命名法，首字母根据访问控制大写或者小写

struct 申明和初始化格式采用多行

type CustomerOrder struct {
	Name string
	Address string
}
order := CustomerOrder{"tom","beijing"}
type CustomerOrder struct {
	Name string
	Address string
}
order := CustomerOrder{"tom","beijing"}

1.7接口命名 ​

命名规则基本上和上面的结构体类型

单个函数的结构名以"er" 作为后缀，例如 Reader, Writer

type Reader interface ｛
	Read(p []byte) (n int, err error)
｝
type Reader interface ｛
	Read(p []byte) (n int, err error)
｝

1.8变量命名 ​

和结构体类似，变量名称一般遵循驼峰法，首字母根据访问控制原则大写或者小写，但遇到特有名词时，需要遵循以下规则：

如果变量为私有，切特有名词为首个单词，则使用小写，如appService若变量类型为bool类型，则名称应以Has，Is，Can或Allow 开头

var isExist bool
var hasConflict bool
var canMange bool
var allow GitHook bool
var isExist bool
var hasConflict bool
var canMange bool
var allow GitHook bool

1.9常量命名 ​

常量均需使用全部大写字母组成,并使用下划线分词

const APP_URL = "https://www.xx.com"
const APP_URL = "https://www.xx.com"

如果是枚举类型的常量，需要先创建相应类型：

type Scheme string

const(
	HTTP Scheme = "http"
	HTTPS Scheme = "https"
)
type Scheme string

const(
	HTTP Scheme = "http"
	HTTPS Scheme = "https"
)

2.0错误处理 ​

错误处理的原则就是不能丢弃任何有返回err 的调用，不要使用_ 丢弃，必须全部处理。接收到错误，要么返回err，或者使用log记录下来尽早return：一旦有错误发生，马上返回，尽量不要使用panic，除非你知道你在做什么，错误描述如果是英文必须为小写，不需要标点结尾，采用独立的错误流进行处理

go
//错误写法
if err != nil {
	//错误处理
} else ｛
	//正常代码
｝


//正确写法
if err != nil {
	//错误处理
	return //或者继续
}
//错误写法
if err != nil {
	//错误处理
} else ｛
	//正常代码
｝


//正确写法
if err != nil {
	//错误处理
	return //或者继续
}

2.1单元测试 ​

单元测试文件命名规范为example_test.go测试用例的函数名称必须以Test开头，例如：TestExample每个重要的函数都要首先编写测试用例，测试用例和正规代码一起提交方便进行回归测试