要写漂亮的代码 (1)

  从个人的角度来看，漂亮的代码首先得满足这么一点，可读性强。

  如何让自己写的代码变得可读性强呢？ 从最简单也是最难的做起，有意义的名称 + 减少方法的长度。

  我看过很多遗留系统的代码，里面大都充斥着大方法，多层缩进。如果不是逼不得已，个人是不愿意去读的。就像读文章一样，写的狗屁不通的文章你愿意去看吗？ 而看文笔优雅的文章却是一种享受。所以我们写代码要漂亮、要优雅。

  这种代码维护成本相当高，要改一个bug或者新增加一个极小的功能，都可以把人玩死。首先是一个方法上来就三四百行，硬看是看不懂的，为什么？举这么几个例子：

  1. 没有意义的变量名（或者大量缩写），var a = xxx; var mmdi = xxx; 这种变量名称，凡是不是作者的人都看不懂，有些作者还比较好，放个注释在那。不过久而久之，代码经过删除、新增，注释不是位置不对了，就是意义不对了，反而容易误导。

  2. 多层缩进。看一个if语句，脑子里就要记着，这里有个分支。如果if里面还有N层if加switch，立马就会晕。

  if (aaa) {

    if(bb && cc) {

        ….

    } else if(xx) {

         …

     } else {}

   }

    这段代码读下来，脑细胞不知道要死多少。

  3. 过多条件组合。有时候经常看到这种代码，if(aaa && bbb && (ccc || ddd)) {}。这也是种迷惑人的手段，条件组合有很多，一会或一会与，意图不明。

  4. 一个方法里逻辑过多，导致方法过长。比如说：

   function demo() {

   //从request中拿变量

   以下20行

   //看看cache中有无数据

    以下5行

   //调用这，调用那，做些处理

    以下50行

   //把某些数据进行转换

    以下几十行

   //把数据放到view中去

    ….

   }

   还有些更厉害的

   //begin, 某某新增，为了什么功能

   几十行

   //end

   //begin，为了解决什么bug

   几十行

   //end

   这样下来，这个函数是没法读了，想要读完都不容易，鼠标滚轮都得滚坏。

 

  反例有很多很多，这里也不一一列举了。下面我们看看到底怎样做才能解决这个问题。

  1. 要用有意义的命名，不管是变量还是方法或者类等等，让人一眼看去，就明白这个东东是做什么的，它比注释管用，因为注释得另外去维护。

  2. 不要用缩写。凡是命名都写全称，不要怕名字长。

  3. 限制方法长度。在代码规范中强制要求，一个方法不能超过10行。这一点大多人听起来不可思议，其实很容易做到，具体怎么做，《重构》那本书都有。核心就是抽取方法。

  function demo() {

    get_all_params

    update_something

    put_something_into_view

  }

  4. 减少缩进，一个方法中一两级的缩进就ok了。

  5. 关于上面过多条件组合的，简单进行重构。凡是这种组合都抽取函数，if(is_user_admin())等。然后呢，在抽取的函数中也不要return aaa && bbb && ccc这种形式，写成这样：

  if(aaa) {return true;}

  if(bbb) {return true;}

  return false;

  看起来很傻的写法，其实很简单可读性很好，是好代码。

  这些都是一种习惯，习惯性的写出有意义的名称，习惯性的不断重构减少方法长度，条件反射一般写出漂亮的代码，我们都称之为代码洁癖。

  先从最基本的做起，写代码的时候花点时间想想怎么去命名，找同事来看看，这个名字好不好，容不容易看懂。花点时间琢磨一下，这段逻辑真的应该放在这里吗，能不能抽取到一个方法中去呢？