[阅读] 代码整洁之道

图书名称：代码整洁之道 

本书主要提出了一些用于改善代码质量的方法原则，维持整洁的项目代码对于项目成功至关重要。

1. 命名

     起有意义的名字，无需注释即可看懂含义；

     避免使用XXList list 等命名方式，除非类型确定；

     避免使用XX1、XX2样子的命名，避免无意义的区分，XXInfo XXData根本无法区分，避免废话 XXVariable；

     名称要易读（不能简写的就使用全拼）；

     不要过短，那不利于搜索；

     不使用IXX为接口命名，宁可使用XXImp对实现类命名；

     尽量不用i j k等无意义代码；

     类名、对象名应该是名词短语，方法是动词短语；

     前后命名一致，不要一会儿Controller、一会儿Manager；

     保持一致时，意义应该统一，不能双关（如连接和放入集合都起名为add）；

     可以使用领域名词，但最好通俗易懂；

     语境需要，但不要到处加前缀表示语境；

2. 函数

     短小（一级缩进）；

     只做一件事；

     一个抽象层级；

     不怕长函数名；

     函数参数不宜超过3个；

    尽量不用输出参数；

    get set 分离，不用set 判断是否存在属性；

    使用异常代替返回错误码；

    最好把try catch 主体代码封装为另一个函数；

    返回错误码，通常对应了枚举类，到处依赖该枚举类，产生依赖磁铁，不利于修改；

    消除重复代码；

 

3. 注释

     能用代码表达的绝不使用注释；

     注释务必正确，否则还不如不加；

     不写多余注释；

     避免循规注解，例如每个函数都写注释是不合理的；

     慎用位置标记（如//////）

     无用代码不用注释，直接删掉，恢复依赖于源代码管理系统；

     不使用HTML标记；

  

 4. 格式

     包名、导入、函数名间放置空白行；

     相关的紧凑排列；

     调用者放在被调用者上面；

     宽度80-100个字符为宜，否则最好拆分；

5. 对象和数据结构

     接口比get set更利于隐藏；

6. 错误处理

    异常代替返回码；

    可控异常打破了封装性，底层添加一个异常，所有调用者必须捕获或在方法上抛出；

    打包调用第三方API，可以降低依赖；

    不返回NULL，改成抛出异常或返回空实例（空列表）；

    不传递NULL参数；

7. 边界

    对边界API进行封装，用于屏蔽具体实现细节；

    接口 -- adapter -- API

    

8. 单元测试

    每个测试一个断言；

9. 类

    类应当对扩展开放，对修改关闭；

    依赖倒置原则，类应该依赖于抽象，而非细节；

10. 系统

       使用Java代理，可以做一些额外的工作，实现InvocationHandler（AOP）；

 

11. 迭进

      一下子设计出一个完美的系统架构几乎不可能；

12. 并发编程

       并发不是总能提升性能，可能发生争用；

       分离并发代码与一般代码；

       数据副本方法避免共享数据；

       ReentrantLock Semaphore CountDownLatch 锁，有效使用；

       死锁：等待资源；活锁：反复尝试、失败、尝试（例如两个人在窄路相遇，同时向一个方向避让，然后又向另一个方向避让，如此反复）；

       不同操作系统线程处理可能不同，多平台测试；

17. 味道与启发

      注释应该只包含技术信息，作者、版本号应该交给源码管理系统；

      删除废弃注释；

      注释的代码及时删掉，因为很难推测它到底有没有意义；

      见到布尔值参数分成两个函数；

      多个函数分别处理优于使用选择算子区分；

      多态代替if else switch case；

      用浮点数表示货币就是犯罪；

      避免传递，那样不利于修改，如a.getB().getC().do()，a不应该调c的方法；

      常量不用继承获得，而是使用静态导入，import static ；

     

                                                                                                                                          读书笔记 2016-06-13