高质量编程
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
通用原则
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进 可读性
- 代码是写给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读 生产力
- 团队整体工作效率非常重要
编码规范
代码格式
使用gofmt自动格式化代码
注释
公共符号始终要注释
- 包中声明的每个公共的符号:变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何对库中的任何函数都必须进行注释
- 例外, 不需要注释实现接口的方法
注释应该解释代码作用 注释应该解释代码作用 注释应该解释代码是如何做的 注释应该解释代码实现的原因 注释应该解释代码在什么情况下会出错, 代码的限制条件
命名规范
变量
- 简洁胜于冗长
- 缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- 例如使用 ServeHTTP 而不是 ServeHttp
- 使用 XMLHTTPRequest 或者 xmlHTTPRequest
- 变量距离其被使用的地方越远，则需要带越多的上下文信息
- 全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义 函数
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
- 函数名尽量简短
- 当名为 foo 的包某个函数返回类型 Foo 时，可以省略类型信息而不导致歧义
- 当名为 foo 的包某个函数返回类型T时(T 并不是 Foo)，可以在函数名中加入类型信息 包
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如 schema、task 等
- 不要与标准库同名。例如不要使用 sync 或者 strings 以下尽可能满足
- 不使用常用变量名作为包名。例如使用 bufio 而不是 buf
- 使用单数而不是复数。例如使用 encoding 而不是 encodings
- 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短
控制流程
- 避免嵌套
- 尽量保持正常代码路径为最小缩进---优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
错误与异常
简单错误:
- 简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
- 优先使用 errors.New 来创建匿名变量来直接表示简单错误
- 如果有格式化的需求，使用 fmt.Errorf 错误的 Wrap 和 Unwrap
- 错误的 Wrap 实际上是提供了一个 error 嵌套另一个error 的能力，从而生成一个 error 的跟踪链
- 在 fmt.Errorf 中使用: %w 关键字来将一个错误关联至错误链中 错误判定
- 判定一个错误是否为特定错误，使用 errors.ls
- 不同于使用 ==，使用该方法可以判定错误链上的所有错误是否含有特定的错误
- 在错误链上获取特定种类的错误，使用errors.As panic
- 不建议在业务代码中使用 panic
- 调用函数不包含 recover :会造成程序崩溃若问题可以被屏蔽或解决，建议使用error 代替 panic
- 当程序启动阶段发生不可逆转的错误时可以在 init 或 main 函数中使用 panic recover
- recover 只能在被 defer 的函数中使用
- 嵌套无法生效
- 只在当前 goroutine 生效
- defer 的语句是后进先出
性能优化
- 尽可能在使用 make()初始化切片时提供容量信息
- 大内存的释放
- map预分配内存
- 字符串使用
strings.Builder拼接字符串 - 使用atomic包
性能调优实战
原则
- 要依靠数据不是猜测
- 要定位最大瓶颈而不是细枝未节
- 不要过早优化
- 不要过度优化
性能分析工具pprof
- 分析
- 展示
- 工具
- 采样
图片调优
优化方法：
- 选择适当的图片格式： 不同的图片格式适合不同类型的图像。常见的图片格式包括JPEG、PNG、GIF和WebP。JPEG适合照片和复杂图像，PNG适合带有透明度的图像，GIF适合动画图像，WebP是一种现代的高效图片格式，提供更好的压缩和质量。
- 压缩图片： 使用图片压缩工具来减小图片文件的大小，以减少带宽消耗。压缩可以在不损失太多质量的前提下降低文件大小。
- 调整图片尺寸： 根据实际需要，在合适的情况下，调整图片的尺寸，使其适应不同的屏幕和布局。
- 使用适当的分辨率： 对于不同设备，使用适当的分辨率的图片，避免加载过大的图像，节省带宽和加速加载速度。
- 图像懒加载： 对于长页面，使用图像懒加载技术，只加载可视区域内的图片，延迟加载其他图片，提高初始页面加载速度。
2.2.2. 前端资源调优
优化方法：
- 压缩和合并： 压缩CSS和JavaScript文件，以减少文件大小。合并多个CSS和JavaScript文件为一个，减少HTTP请求的数量。
- 使用浏览器缓存： 设置适当的缓存策略，让浏览器缓存静态资源，减少重复的加载请求。
- 使用CDN
- 异步加载
- 图像优化
2.2.3. 数据请求调优
案例分析：
优化方法：
减少请求数量
使用缓存： 使用服务器端缓存和浏览器缓存，以减少重复请求相同的数据。合理设置缓存过期时间，避免使用过期数据。
压缩数据： 使用压缩算法对数据进行压缩，减少传输的数据量，提高传输效率。常见的压缩算法有Gzip和Brotli。
使用CDN
数据预加载： 对于即将被用户访问的内容，使用预加载技术提前加载数据，减少用户等待时间。
