CleanCode代码整洁之道：读书笔记

Clean Code读书笔记

---

第一章 整洁代码

什么是整洁代码

• 代码逻辑直截了当
• 尽量较少依赖关系，使之便于维护
• 分层战略完善错误代码
• 性能调制最优
• 整洁代码只做一件事
  --- Bjarne C++发明者

破窗理论

• 可读性：整洁的代码犹如优美的散文
  --- Grady Booch， 面向对象分析与设计作者

• 有单元测试和验收测试

• 使用有意义的命名

• 代码应在字面上表达其含义

• 尽量少的依赖

• 尽量少的api

• 尽量小的代码块
  --- Dave Thomas

• 能通过所有测试
• 没有重复代码
• 体现系统中的全部设计理念
• 包括尽量少的实体，比如类、方法、函数等。
  --- Ron Jeffries（极限编程作者）

童子军军规：让营地比你来时更干净。

小结

整洁代码的特点有：

• 没有重复代码
• 只做一件事
• 尽量小的代码块，尽量少的实体，尽量少的API
• 尽量少的依赖，便于维护
• 字面含义能表达其含义，有意义，可读性强
• 能通过所有测试
• 体现系统中的全部设计理念
• 分层战略完善错误代码
• 性能调制最优

---

第二章 有意义的命名

名副其实

避免误导

• 避免变量名与系统中专有名词混淆，如hp、aix、sco等
• 避免用accountList来表示一个不是List类型的数据，可以改为accountGroup，或者accounts。
• 避免两个名称只有一小部分有区别，如XYZControllerForEffecientHandlingOfString，与XYZControllerForEffecientStoringOfString

做有意义的区分

• 如Product与ProductInfo，以及ProductData类，尽管名称不同，意思却无区别。
• moneyAmount与money没区别，customerInfo与customer没区别，theMessage与message没区别
• Variable一词永远不应该出现在变量名中
• Table一词永远不应当出现在表名中

要区分名称，就要以读者能鉴别不同之处的方式来区分。

使用读得出来的名称

• 不要使用自造词

使用可搜索的名称

• MAX_CLASSES_PER_STUDENT比7更有搜索
• e作为变量名不易于搜索

长名称胜于短名称

• 单字母名称仅用于短方法中的本地变量

避免使用编码

• 避免把类型或作用域编进名称里面
• 变量中不建议添加类型前缀。（因为Java是强类型语言，现在编译器能够在编译前检查类型。）
• 命名中添加类型会导致修改与维护的难度，也增加了阅读的难度。

匈牙利语标记法（Hungarian Notation, HN)是由于在历史中，编译器不做类型检查，程序员需要匈牙利语标记法来帮助自己记住类型。

避免使用前缀

• 应该用颜色高亮来区分成员。

接口和实现

• 若需要对接口和实现命名，不建议使用IShapeFactory,和ShapeFactory
• 如果非要选择其中之一进行编码，作者建议选择实现。如ShapeFactoryImp

类名

类名和对象名应该是名称或名词短语，不应该是动词

方法名

• 方法名应该是动词或动词短语
• 属性访问器、修改器、断言应该根据其值命名，并依据JavaBean标准加上get,set和is前缀。

每个概念对应一个词

• 避免同时使用fetch/retrieve/get
• 同一堆代码同时使用controller，manager， driver等会让人困惑。

避免用双关语

• 避免将同一单词用于不同目的。

使用解决方案领域名称

• 如果业务所涉及领域的名称不易于理解，就应该避免使用
• 应该使用计算机领域的词语去代替这些名称。

添加有意义的语境

• 如addrState,addrFirstName比State, FirstName更好
• 可以将变量放到类中，添加语境

不要添加没用的语境

• 避免使用几乎涉及所有名称的前缀
• 短名称能表达清楚时，就不要用长名称。（结合前面的思路，也不要太短，不然不易于搜索）。
• 精确命名是重点。