《代码整洁之道.pdf》由会员分享，可在线阅读，更多相关《代码整洁之道.pdf（60页珍藏版）》请在金锄头文库上搜索。
1、第 1 章 整洁代码. 1 1.1 要有代码. .2 1.2 糟糕的代码 2 1.3 混乱的代价 3 1.3.1 华丽新设计4 1.3.2 态度. . 4 1.3.3 迷题. . 5 1.3.4 整洁代码的艺术. 5 1.3.5 什么是整洁代码. 6 1.4 思想流派10 1.5 我们是作者. 11 1.6 童子军军规. 12 1.7 前传与原则. 12 1.8 小结. . 12 1.9 文献. . 13 第 2 章 有意义的命名15 2.1 介绍. 15 2.2 名副其实16 2.3 避免误导17 2.4 做有意义的区分 18 2.5 使用读得出来的名称.19 2.6 使用可搜索的名称 20
2、 2.7 避免使用编码. 21 2.7.1 匈牙利语标记法. 21 2.7.2 成员前缀 21 2.7.3 接口和实现. 22 2.8 避免思维映射. 22 2.9 类名. 23 2.10 方法名 23 2.11 别扮可爱 23 2.12 每个概念对应一个词. 24 2.13 别用双关语. 24 2.14 使用解决方案领域名称 25 2.15 使用源自所涉问题领域的 名称. 25 2.16 添加有意义的语境 25 2.17 不要添加没用的语境. 27 2.18 最后的话 27 第 3 章 函数 29 3.1 短小 32 3.2 只做一件事 33 3.3 每个函数一个抽象层级. 34 3.4 s
3、witch 语句 35 3.5 使用描述性的名称. 36 3.6 函数参数 37 3.6.1 一元函数的普遍形式. 38 3.6.2 标识参数 38 3.6.3 二元函数 38 3.6.4 三元函数 39 3.6.5 参数对象 39 3.6.6 参数列表 40 3.6.7 动词与关键字 40 3.7 无副作用 40 3.8 分隔指令与询问 42 3.9 使用异常替代返回错误码 42 3.9.1 抽离 Try/Catch 代码块. 43 3.9.2 错误处理就是一件事. 44 3.9.3 Error.java 依赖磁铁. 44 3.10 别重复自己. 44 3.11 结构化编程. 45 3.12
4、 如何写出这样的函数. 45 3.13 小结. 45 3.14 SetupTeardownIncluder 程序. 46 3.15 文献. 48 第 4 章 注释 49 4.1 注释不能美化糟糕的代码 50 4.2 用代码来阐述. 51 4.3 好注释. 51 4.3.1 法律信息 51 4.3.2 提供信息的注释. 51 4.3.3 对意图的解释 52 4.3.4 阐释 53 4.3.5 警示 53 4.3.6 TODO 注释. 54 4.3.7 放大 54 4.3.8 公共 API 中的 Javadoc 55 4.4 坏注释. 55 4.4.1 喃喃自语 55 4.4.2 多余的注释. 5
5、6 4.4.3 误导性注释. 58 4.4.4 循规式注释. 58 4.4.5 日志式注释. 59 4.4.6 废话注释 59 4.4.7 可怕的废话. 61 4.4.8 能用函数或变量时就 别用注释. 62 4.4.9 位置标记 62 4.4.10 括号后面的注释 62 4.4.11 归属与署名 63 4.4.12 注释掉的代码. 63 4.4.13 HTML 注释 64 4.4.14 非本地信息 64 4.4.15 信息过多. 65 4.4.16 不明显的联系. 65 4.4.17 函数头 66 4.4.18 非公共代码中的 Javadoc. 66 4.4.19 范例. 66 4.5 文献
6、 69 第 5 章 格式 71 5.1 格式的目的 72 5.2 垂直格式 72 5.2.1 向报纸学习. 73 5.2.2 概念间垂直方向上的 区隔. 73 5.2.3 垂直方向上的靠近 74 5.2.4 垂直距离 75 5.2.5 垂直顺序 79 5.3 横向格式 79 5.3.1 水平方向上的区隔与 靠近. 80 5.3.2 水平对齐 81 5.3.3 缩进 82 5.3.4 空范围. 84 5.4 团队规则 84 5.5 鲍勃大叔的格式规则 85 第 6 章 对象和数据结构 87 6.1 数据抽象 87 6.2 数据、对象的反对称性. 89 6.3 得墨忒耳律 91 6.3.1 火车失
7、事 91 6.3.2 混杂 92 6.3.3 隐藏结构 92 6.4 数据传送对象. 93 6.5 小结 94 6.6 文献 94 第 7 章 错误处理 95 7.1 使用异常而非返回码 96 7.2 先写 Try-Catch-Finally 语句. 97 7.3 使用不可控异常 98 7.4 给出异常发生的环境说明 99 7.5 依调用者需要定义异常类 99 7.6 定义常规流程 100 7.7 别返回 null 值 101 7.8 别传递 null 值 102 7.9 小结. 103 7.10 文献. 104 第 8 章 边界. 105 8.1 使用第三方代码. 106 8.2 浏览和学习
8、边界. 107 8.3 学习 log4j 108 8.4 学习性测试的好处不只是 免费. 110 8.5 使用尚不存在的代码. 110 8.6 整洁的边界 111 8.7 文献. 112 第 9 章 单元测试. 113 9.1 TDD 三定律 114 9.2 保持测试整洁 115 9.3 整洁的测试. 116 9.3.1 面向特定领域的测试 语言. 118 9.3.2 双重标准. 119 9.4 每个测试一个断言 121 9.5 F.I.R.S.T. 122 9.6 小结. 123 9.7 文献. 124 第 10 章 类 125 10.1 类的组织 126 10.2 类应该短小. 126 1
9、0.2.1 单一权责原则. 128 10.2.2 内聚. 129 10.2.3 保持内聚性就会得到 许多短小的类 130 10.3 为了修改而组织. 136 10.4 文献. 139 第 11 章 系统. 141 11.1 如何建造一个城市. 142 11.2 将系统的构造与使用分开 142 11.2.1 分解 main. 143 11.2.2 工厂. 143 11.2.3 依赖注入. 144 11.3 扩容 145 11.4 Java 代理. 148 11.5 纯 Java AOP 框架. 150 11.6 AspectJ 的方面 152 11.7 测试驱动系统架构. 153 11.8 优化
10、决策. 154 11.9 明智使用添加了可论证 价值的标准 154 11.10 系统需要领域特定语言. 154 11.11 小结 155 11.12 文献 155 第 12 章 迭进. 157 12.1 通过迭进设计达到整洁目的 157 12.2 简单设计规则 1：运行所有 测试 158 12.3 简单设计规则 24：重构 158 12.4 不可重复 159 12.5 表达力 161 12.6 尽可能少的类和方法. 162 12.7 小结. 162 12.8 文献. 162 第 13 章 并发编程 163 13.1 为什么要并发 164 13.2 挑战. 165 13.3 并发防御原则 166
11、 13.3.1 单一权责原则. 166 13.3.2 推论：限制数据作 用域 166 13.3.3 推论：使用数据复本 167 13.3.4 推论：线程应尽可能 地独立. 167 13.4 了解 Java 库 167 13.5 了解执行模型 168 13.5.1 生产者-消费者模型. 169 13.5.2 读者-作者模型. 169 13.5.3 宴席哲学家 169 13.6 警惕同步方法之间的依赖. 169 13.7 保持同步区域微小 170 13.8 很难编写正确的关闭代码. 170 13.9 测试线程代码 171 13.9.1 将伪失败看作可能的 线程问题. 171 13.9.2 先使非线
12、程代码可 工作 171 13.9.3 编写可插拔的线程 代码 172 13.9.4 编写可调整的线程 代码 172 13.9.5 运行多于处理器 数量的线程. 172 13.9.6 在不同平台上运行 172 13.9.7 装置试错代码 173 13.9.8 硬编码. 173 13.9.9 自动化. 174 13.10 小结 175 13.11 文献 175 第 14 章 逐步改进 176 14.1 Args 的实现 177 14.2 Args：草稿 183 14.2.1 所以我暂停了. 195 14.2.2 渐进. 195 14.3 字符串参数. 197 14.4 小结. 234 第 15 章 JUnit 内幕 235 15.1 JUnit 框架. 236 15.2 小
