czyt / go100mistakes

如何避免Go语言的100个错误

• 作者：Teiva Harsanyi
• 原名：《100 Go Mistakes and How to Avoid Them》
• 译者：李天时
• 校订：上杉夏香

使用 Github Pages 以获取最佳阅读体验。

本地：你可在项目根目录中执行 make，并通过浏览器阅读（在线预览）。

法律声明

从原作者处得知，已经有简体中文的翻译计划。购买地址

译者纯粹出于 学习目的 与 个人兴趣 翻译本书，不追求任何经济利益。

译者保留对此版本译文的署名权，其他权利以原作者和出版社的主张为准。

本译文只供学习研究参考之用，不得公开传播发行或用于商业用途。有能力阅读英文书籍者请购买正版支持。

• 1 Go:入门容易，掌握难
  • 1.1 Go 大纲
  • 1.2 简单并不意味着容易
  • 1.3 100 个 Go 错误
  • 1.4 本章总结
• 2 代码和项目组织
  • 2.1 意外的阴影变量
  • 2.2 不必要的嵌套代码
  • 2.3 滥用的 init 函数
  • 2.4 过度使用 getters 和 setters
  • 2.5 接口污染
  • 2.6 在生产者端的接口
  • 2.7 返回接口
  • 2.8 any say nothing
  • 2.9 令人困惑的泛型
  • 2.10 没有意识到类型嵌入可能存在的问题
  • 2.11 不使用函数式选项模式
  • 2.12 项目组织不善
  • 2.13 创建公共包
  • 2.14 忽略软件包名称冲突
  • 2.15 缺少代码文档
  • 2.16 不使用代码检查工具
• 3 数据类型
  • 3.1 与八进制文字混淆
  • 3.2 忽略整数溢出
  • 3.3 不被理解的浮点型
  • 3.4 不被理解的切片长度和容量
  • 3.5 低效的切片初始化
  • 3.6 令人困惑的切片，nil vs 空切片
  • 3.7 没有正确检查切片是否为空
  • 3.8 无法正确复制切片
  • 3.9 使用切片附加的意外副作用
  • 3.10 切片与内存泄漏
  • 3.11 低效的 map 初始化
  • 3.12 映射和内存泄漏
  • 3.13 错误的比较值
• 4 控制结构
  • 4.1 在 range 循环中不被重视的元素副本
  • 4.2 在 range 循环中被忽视的参数求值方式
  • 4.3 在 range 循环中使用指针元素被忽略的影响
  • 4.4 在 map 迭代过程中做出错误的假设
  • 4.5 忽略 break 语句的工作方式
  • 4.6 在循环中使用 defer
• 5 字符串
  • 5.1 Go 中超难理解的符文(runes)概念
  • 5.2 字符串中有捣乱格式的字符，导致的字符串迭代混乱
  • 5.3 被滥用的 trim 函数
  • 5.4 欠优化的字符串连接
  • 5.5 无用的字符串转换
  • 5.6 子字符串与内存泄漏
• 6 函数与方法
  • 6.1 接收器应该定义为值类型还是指针类型？
  • 6.2 什么时候使用返回值参数
  • 6.3 定义返回值参数的坑
  • 6.4 返回一个 nil 接收器引发的坑爹事件
  • 6.5 不要使用文件名作为函数参数
  • 6.6 defer 函数中参数和接收器是如何被赋值的
• 7 错误管理
  • 7.1 恐慌(panicking)
  • 7.2 被忽略的包装(wrap)错误
  • 7.3 错误类型比较的坑
  • 7.4 错误值比较的坑
  • 7.5 重复处理了两次错误
  • 7.6 忽略错误，引入的坑
  • 7.7 不处理 defer 的错误，引入的坑
• 8 并发：基础
  • 8.1 并发和并行，傻傻分不清楚
  • 8.2 并发并不总是更快
  • 8.3 并发业务应该使用 channel 还是 mutex
  • 8.4 竞争问题引入的坑
  • 8.5 goroutines 数量取决于工作负载类型
  • 8.6 令人头大的 Go 上下文
• 9 并发：实践
  • 9.1 传递不恰当的上下文
  • 9.2 goroutine 已启动，啥时候停，不确定
  • 9.3 goroutine 和循环变量，一不小心就出错
  • 9.4 期望使用 select 和 channel 的确定性执行
  • 9.5 不要使用布尔类型的通道
  • 9.6 不要使用零值通道
  • 9.7 通道缓冲区尺寸引入的坑
  • 9.8 忘记字符串格式化引入的坑
  • 9.9 append 数据引发的数据竞争
  • 9.10 切片和 map 使用互斥锁引入的坑
  • 9.11 使用 sync.WaitGroup 引入的坑
  • 9.12 被遗忘的 sync.Cond
  • 9.13 多个 goroutine 并行执行，使用 errgroup 聚合返回错误
  • 9.14 拷贝同步类型变量引入的坑
• 10 标准库
  • 10.1 提供错误的时间周期(time Duration)
  • 10.2 time.After 引发的内存泄漏
  • 10.3 JSON 编码和解码引入的坑
  • 10.4 SQL 类库的常见错误
  • 10.5 瞬态资源一定要关闭
  • 10.6 回复 HTTP 请求后忘记调用 return 语句
  • 10.7 不要使用默认的 HTTP 客户端和服务器
• 11 测试
  • 11.1 测试也需要分类
  • 11.2 启用 race 标志检查是否存在数据竞争
  • 11.3 测试的 parallel 与 shuffle 模式
  • 11.4 表驱动测试，简化测试代码的神器
  • 11.5 在单元测试中使用 sleep 引入的坑
  • 11.6 测试不稳定，都是 time API 在捣乱
  • 11.7 原生测试包，好处多
  • 11.8 测试代码中编写不准确的基准
  • 11.9 没有探索所有的 Go 测试特性
• 12 优化
  • 12.1 基于 CPU 缓存的优化
  • 12.2 并发代码导致 CPU 缓存的虚假共享
  • 12.3 CPU 指令级并行性对程序的优化
  • 12.4 数据在内存中对齐，有什么好处
  • 12.5 逃逸分析到底是啥
  • 12.6 减少内存分配对程序的优化
  • 12.7 Go 语言的内联优化
  • 12.8 pprof 诊断工具
  • 12.9 Go 的垃圾回收是如何工作的
  • 12.10 Docker 和 Kubernetes 内部机制对 Go 程序的影响

协议

CC-BY 4.0

翻译心得

翻译要做到信、达、雅。

举个例子

Forever21 是一个美国服装品牌，怎么翻译成中文？

• 信：准确的翻译，永远21。
• 达：阅读通顺，永远21岁。
• 雅：接地气，永远18岁。