程序员的README

第 1 章 前面的旅程 1

1.1 你的目的地 1

1.2 你的旅程地图 2

1.2.1 新手营 3

1.2.2 试炼之河 5

1.2.3 贡献者之角 5

1.2.4 运维之海 6

1.2.5 胜任之湾 6

1.3 前进！ 7



第 2 章 步入自觉阶段 8

2.1 学习如何学习 9

2.1.1 前置学习 9

2.1.2 在实践中学习 9

2.1.3 运行实例代码 11

2.1.4 阅读 11

2.1.5 观看讲座 13

2.1.6 适度地参加会议和聚会 14

2.1.7 跟班学习并同有经验的工程师结对 15

2.1.8 用副业项目实践 16

2.2 提出问题 17

2.2.1 动手调查一下 17

2.2.2 设置一个时间限制 17

2.2.3 写下全过程 18

2.2.4 别打扰别人 19

2.2.5 多用“非打扰式”交流 20

2.2.6 批量处理你的同步请求 20

2.3 克服成长的障碍 21

2.3.1 冒充者综合征 21

2.3.2 邓宁-克鲁格效应 22

2.4 行为准则 23

2.5 升级加油站 23



第3 章 玩转代码 25

3.1 软件的熵 26

3.2 技术债 26

3.3 变更代码 29

3.3.1 善于利用现有代码 30

3.3.2 过手的代码要比之前更干净 32

3.3.3 做渐变式的修改 33

3.3.4 对重构要务实 33

3.3.5 善用IDE 34

3.3.6 请使用VCS 的实践 34

3.4 避“坑”指南 35

3.4.1 保守一些的技术选型 36

3.4.2 不要特立独行 39

3.4.3 不要只分叉而不向上游提交修改 40

3.4.4 克制重构的冲动 40

3.5 行为准则 42

3.6 升级加油站 42



第4 章 编写可维护的代码 44

4.1 防御式编程 45

4.1.1 避免空值 45

4.1.2 保持变量不可变 46

4.1.3 使用类型提示和静态类型检查器 46

4.1.4 验证输入 47

4.1.5 善用异常 49

4.1.6 异常要有精确含义 50

4.1.7 早抛晚捕 51

4.1.8 智能重试 52

4.1.9 构建幂等系统 53

4.1.10 及时释放资源 53

4.2 关于日志的使用 54

4.2.1 给日志分级 55

4.2.2 日志的原子性 56

4.2.3 关注日志性能 57

4.2.4 不要记录敏感数据 59

4.3 系统监控 59

4.3.1 使用标准的监控组件 60

4.3.2 测量一切 63

4.4 跟踪器 64

4.5 配置相关注意事项 64

4.5.1 配置无须新花样 65

4.5.2 记录并校验所有的配置 66

4.5.3 提供默认值 67

4.5.4 给配置分组 67

4.5.5 将配置视为代码 67

4.5.6 保持配置文件清爽 68

4.5.7 不要编辑已经部署的配置 68

4.6 工具集 68

4.7 行为准则 70

4.8 升级加油站 71



第5 章 依赖管理 72

5.1 依赖管理基础知识 73

5.1.1 语义化版本 74

5.1.2 传递依赖 75

5.2 相依性地狱 76

5.3 避免相依性地狱 80

5.3.1 隔离依赖项 80

5.3.2 按需添加依赖项 81

5.3.3 指定依赖项的版本 82

5.3.4 依赖范围小化 84

5.3.5 保护自己免受循环依赖的影响 84

5.4 行为准则 85

5.5 升级加油站 85



第6 章 测试 87

6.1 测试的多种用途 87

6.2 测试类型 88

6.3 测试工具 91

6.3.1 模拟库 91

6.3.2 测试框架 92

6.3.3 代码质量工具 93

6.4 自己动手编写测试 95

6.4.1 编写干净的测试 95

6.4.2 避免过度测试 96

6.5 测试中的确定性 98

6.5.1 种子随机数生成器 99

6.5.2 不要在单元测试中调用远程系统 99

6.5.3 采用注入式时间戳 99

6.5.4 避免使用休眠和超时 102

6.5.5 记得关闭网络套接字和文件句柄 102

6.5.6 绑定到0 端口 103

6.5.7 生成的文件路径和数据库位置 103

6.5.8 隔离并清理剩余的测试状态 103

6.5.9 不要依赖测试顺序 104

6.6 行为准则 105

6.7 升级加油站 105



第7 章 代码评审 107

7.1 为什么需要评审代码 107

7.2 当你的代码被评审时 109

7.2.1 准备工作 109

7.2.2 用评审草案降低风险 110

7.2.3 提交评审请勿触发测试 111

7.2.4 预排大体量的代码修改 111

7.2.5 不要太在意 112

7.2.6 保持同理心，但不要容忍粗鲁 113

7.2.7 保持主动 113

7.3 评审别人的代码时 114

7.3.1 分流评审请求 114

7.3.2 给评审预留时间 114

7.3.3 理解修改的意图 115

7.3.4 提供全面的反馈 115

7.3.5 要承认优点 116

7.3.6 区分问题、建议和挑剔 116

7.3.7 不要只做橡皮图章 117

7.3.8 不要只局限于使用网页版的评审工具 118

7.3.9 不要忘记评审测试代码 118

7.3.10 推动决断 118

7.4 行为准则 119

7.5 升级加油站 120



第8 章 软件交付 121

8.1 软件交付流程 121

8.2 分支策略 122

8.3 构建环节 125

8.3.1 打包需要带版本号 126

8.3.2 将不同的资源单独打包 127

8.4 发布环节 129

8.4.1 请勿只想着发布 129

8.4.2 将包发布到仓库 130

8.4.3 保持版本不变性 131

8.4.4 频繁发布 131

8.4.5 对发布计划保持透明 132

8.4.6 撰写变更日志和发行说明 132

8.5 部署环节 133

8.5.1 自动部署 133

8.5.2 部署的原子性 134

8.5.3 独立地部署应用 134

8.6 展开环节 136

8.6.1 系统监控 137

8.6.2 特性开关 137

8.6.3 熔断器 138

8.6.4 并行的服务版本梯队 139

8.6.5 摸黑启动 141

8.7 行为准则 143

8.8 升级加油站 144



第9 章 On-Call 146

9.1 On-Call 的工作方式 147

9.2 On-Call 技能包 148

9.2.1 随时响应 148

9.2.2 保持专注 148

9.2.3 确定工作优先级 149

9.2.4 清晰的沟通 150

9.2.5 跟踪你的工作 151

9.3 事故处理 152

9.3.1 分流 153

9.3.2 协同 154

9.3.3 应急方案 155

9.3.4 解决方案 157

9.3.5 后续行动 159

9.4 提供支持 162

9.5 不要逞英雄 164

9.6 行为准则 165

9.7 升级加油站 165



第 10 章 技术设计流程 167

10.1 技术设计的V 形结构 168

10.2 关于设计的思考 169

10.2.1 定义问题 170

10.2.2 着手调查 171

10.2.3 进行实验 172

10.2.4 给些时间 173

10.3 撰写设计文档 174

10.3.1 文档持续变更 174

10.3.2 了解撰写文档的目的 175

10.3.3 学会写作 176

10.3.4 保证文档是的 176

10.4 使用设计文档模板 177

10.4.1 概要 178

10.4.2 现状与背景 178

10.4.3 变更的目的 178

10.4.4 需求 179

10.4.5 潜在的解决方案 179

10.4.6 建议的解决方案 180

10.4.7 设计与架构 180

10.4.8 测试计划 181

10.4.9 发布计划 181

10.4.10 遗留的问题 181

10.4.11 附录 181

10.5 协作设计 182

10.5.1 理解你的团队的设计评审流程 182

10.5.2 不要让人惊讶 183

10.5.3 用设计讨论来进行头脑风暴 183

10.5.4 为设计出力 184

10.6 行为准则 185

10.7 升级加油站 185



第 11 章 构建可演进的架构 187

11.1 理解复杂性 188

11.2 可演进的设计 189

11.2.1 你不是真的需要 189

11.2.2 小惊讶原则 191

11.2.3 封装专业领域知识 193

11.3 可演进的API 193

11.3.1 保持API 小巧 194

11.3.2 公开定义良好的服务端API 194

11.3.3 保持API 变更的兼容性 195

11.3.4 API 版本化 198

11.4 可持续的数据管理 199

11.4.1 数据库隔离 199

11.4.2 使用schema 201

11.4.3 schema 自动化迁移 203

11.4.4 保持schema 的兼容性 206

11.5 行为准则 207

11.6 升级加油站 208



第 12 章 敏捷计划 210

12.1 敏捷宣言 210

12.2 敏捷计划的框架 211

12.3 Scrum 框架 212

12.3.1 用户故事 213

12.3.2 任务分解 214

12.3.3 故事点 214

12.3.4 消化积压 216

12.3.5 冲刺计划 216

12.4 站会 217

12.5 评审机制 218

12.6 回顾会 219

12.7 路线图 220

12.8 行为准则 221

12.9 升级加油站 222



第 13 章 与管理者合作 223

13.1 管理者是做什么的 223

13.2 沟通、目标与成长 224

13.2.1 一对一面谈 225

13.2.2 PPP 227

13.2.3 OKR 229

13.2.4 绩效考核 230

13.3 向上管理 232

13.3.1 接收反馈 232

13.3.2 给予反馈 233

13.3.3 讨论你的目标 235

13.3.4 事情不顺时要采取行动 236

13.4 行为准则 238

13.5 升级加油站 239



第 14 章 职业生涯规划 241

14.1 迈向资深之路 241

14.2 职业生涯建议 242

14.2.1 T 型人才 242

14.2.2 参加工程师训练营 243

14.2.3 主导你自己的晋升 244

14.2.4 换工作需谨慎 246

14.2.5 自我调节 247

14.3 结尾寄语 248