Clean Code

Trainning

clean code，顾名思义就是整洁的代码，或者说清晰、漂亮的代码。从功能性赖理解就是可读性高，可维护性强。

1.代码大部分时候是用来维护的，而不是用来实现功能的

一方面是编译好让机器执行，完成功能需求；
另一方面，是写给身边的队友和自己看的，需要长期维护

2.优秀的代码大部分是可以自描述的，好于文档和注释

• 注释不能让写的烂的代码变的更好。如果别人只能依靠注释读懂你的代码的时候，你一定要反思代码出现了什么问题

• 比较适合写注释的两种场景：

  • public interface，向别人明确发布你功能的语义，输入输出，且不需要关注实现。
  • 功能容易有歧义的点，或者涉及比较深层专业知识的时候。比如，如果你写一个客户端，各种config参数的含义等。

3.设计模式只是手段，代码清晰才是目的

• 防止过度设计
• 大部分抽象只有一个实现的时候，要好好思考一下，是不是设计有点过度了，清晰永远是第一准则。

常见手段-Pracitce

• code review

• 勤于重构
  ① 掌握一些常见的“无痛”重构技巧，这在下文会有具体讲解。
  ② 小步快跑，不要企图一口吃成个胖子。改一点，测试一点，一方面减少代码merge的痛苦，另一方面减少上线的风险。
  ③ 建立自动化测试机制，要做到即使代码改坏了，也能保证系统最小核心功能的可用，并且保证自己修改的部分被测试覆盖到。
  ④ 熟练掌握IDE的自动重构功能。这些会很大程度上减少我们的体力劳动，避免犯错。

• 静态检查

• 多读开源代码和身边优秀同学的代码
  开源社区，为我们提供了这么好的学习机会。无论是JDK的源码，还是经典的Netty、Spring、Jetty，还是一些小工具如Guava等

skills

• 单一职责
• 优先定义整体框架
• 清晰的命名
• 避免过长参数
• 避免过长方法和类
• 让相同长度的代码段表示相同粒度的逻辑

   public void doSomeThing(Map params1,Map params2){
   Do1 do1 = getDo1(params1);
   Do2 do2 = new Do2();
   do2.setA(params2.get("a"));
   do2.setB(params2.get("b"));
   do2.setC(params2.get("c"));
   mergeDO(do1,do2);
   }
   private void getDo1(Map params1);
   private void mergeDo(do1,do2){...};

• 为每个方法找到合适的类归属，数据和行为尽量要在一起
• 警惕static
  static真正适用的场景：工具方法，而不是业务方法。
• 巧用method object
  
  • 一个有数据有行为的对象。依赖的数据会成为这个对象的变量，所有的行为会成为这个对象的内部方法。
  • 利用成员变量代替参数传递，会让代码简洁清爽很多。并且，把一段过程式的代码转换成对象代码，为很多面向对象编程才可以使用的继承／封装／多态等提供了基础

举个例子，上文引用的代码如果用method object表示大概会变成这样
 class DoMerger{
    map params1;
    map params2;
    Do1 do1;
    Do2 do2;
    public DoMerger(Map params1,Map params2){
       this.params1 = params1;
       this.params2 = parmas2;
    }
    public void invoke(){
        do1 = getDo1();
        do2 = getDo2();
       mergeDO(do1,do2);
    }
    private Do1 getDo1();
     private Do2 getDo2();
     private void mergeDo(){
        print(do1+do2);
     }
 }

• 面向接口编程
• 正确使用继承和组合
  
  • protected abstract 这种是最值得使用继承的，父类保留扩展点，子类扩展
  • protected final 这种方法，子类是只能使用不能修改实现的
    ① 抽象出主流程不能被修改的，然而一般情况下，public final更适合这个职能。如果只是流程的一部分，需要思考这个流程的类归属，大部分变成public组合到其他类里是更合适的。
    ② 父类是抽象类无法直接对外提供服务，又不希望子类修改它的行为，这种大多数情况下属于工具方法，比较适合用另一个领域对象来承载并用组合的方式来使用。

继承更多的是为扩展提供便利，为复用而存在的方法最好使用组合的方式

• 代码复用技巧
  
  • 模板方法
  • extract method
  • 责任链
  • 为集合显式定义它的行为
    对于有明确语义的集合的一些操作，尤其是全局的集合或者被经常使用的集合，做一些封装和抽象，如把Map封装成一个Cache类或者一个config类，再提供GetFromCache这样的方法。

References:
Clean Code`