1.高质量编程

1.1简介

编写的代码能够达到正确可靠、简洁清晰的目标可称为高质量代码

各种边界条件是否考虑完备
异常情况处理，稳定性保证
易读易维护

编程原则实际应用场景干变万化，各种语言的特性和语法各不相同但是高质量编程遵循的原则是相通的

简单性消除“多余的复杂性”，以简单清晰的逻辑编写代码不理解的代码无法修复改进

可读性代码是写给人看的，而不是机器编写可维护代码的第一步是确保代码可读

生产力团队整体工作效率非常重要

1.2编码规范

如何编写高质量的Go代码

代码格式

利用Go官方自带的fmt格式化工具

注释

注释实现过程

注释代码的外部因素

提高额外的上下文

解释代码的限制条件

公共符号始终要注释

包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释

任何既不明显也不简短的公共功能必须予以注释

无论长度或复杂程度如何对库中的任何函数都必须进行注释

命名规范

变量 variable

简洁胜于冗长

缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写 ·例如使用ServeHTTP而不是ServeH化tp ·使用XMLHTTPRequest或者xmlHTTPRequest

变量距离其被使用的地方越远，则需要携带越多的上下文信息 ·全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义

函数 function

函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的

函数名尽量简短

当名为f0o的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义

当名为foo的包某个函数返回类型T时（T并不是F0o),可以在函数名中加入类型信息

包 package

只由小写字母组成。不包含大写字母和下划线等字符

简短并包含一定的上下文信息。例如schema、七ask等

不要与标准库同名。例如不要使用sync或者strings

以下规则尽量满足，以标准库包名为例

不使用常用变量名作为包名。例如使用bufio而不是buf

使用单数而不是复数。例如使用encoding而不是encodings

谨慎地使用缩写。例如使用mt在不破坏上下文的情况下比format更加简短

控制流程

4.1 避免嵌靠 => 减少else,而是采用if return

// Bad
if foo {
    return x
} else {
    return nil
}

// Good
if foo {
    return x
}
return nil

4.2 尽量保持正常代码路径为最小缩进优先处理错误情况特殊情况，尽早返回或继续循环来减少嵌套

// Bad
//最常见的正常流程的路径被嵌套在两个条件内
//成功的退出条件是return nil,.必须仔细匹配大括号来发现
//函数最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误
//如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套
func OneFunc() error {
    err := doSonmething()
    if err == nil {
        err := doAnotherThing()
        if err == nil {
            return nil // normal case
        }
        return err
    }
    return err
}

// Good
func OneFunc() error {
    if err := doSomething(); err != nil {
        return err
    }
    if err := doAnotherThing(); err != nil {
        return err
    }
    return nil // normal case
}

小结

线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支

正常流程代码沿着屏幕向下移动

提升代码可维护性和可读性

故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

5.1 简单错误

简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
优先使用errors.Wew来创建匿名变量来直接表示简单错误
如果有格式化的需求，使用fmt.Errorf

func defaultCheckRedirect(req *Request, via []*Request) error {
	if len(via) >= 10 {
		return errors.New("stopped after 10 redirects")
	}
	return nil
}

5.2 错误的Wrap和Unwrap

错误的Wrap实际上是提供了一个error嵌套另一个error的能力，从而生成一个error的跟踪链
在fmt-Errorf中使用：%w关键字来将一个错误关联至错误链中

list,_err := c.GetBytes(cache.Subkey(a.actionID,"srcfiles"))
if err != nil{
    return fmt.Errorf("reading srcfiles list:%w",err)
}

5.3 错误判定

判定一个错误是否为特定错误，使用errors./s
不同于使用==，使用该方法可以判定错误链上的所有错误是否含有特定的错误

data,err lockedfile.Read(targ)
if errors.Is(err,fs.ErrNotExist){
	return []byte{}, nil
}
return data,err

在错误链上获取特定种类的错误，使用errors·As

if _,err := os.Open("non-existing"); err != nil {
	var pathError *fs.PathError
	if errors.As(err,&pathError){
		fmt.Println("Failed at path:"pathError.Path)
	} else {
		fmt.Println(err)
    }
}

高质量编程 ｜ 青训营

1.高质量编程

1.1简介

1.2编码规范

高质量编程｜青训营