[转]程序员不能不了解的~~~代码整洁之道

出处：

作者：myfoucs

• ​程序代表coder的尊严，作为一名合格的coder，需要维护好自己的尊严

• 洁癖是一个贬义词，但coder需却要一定洁癖，严要求才能出好代码，对看不惯的代码一定要及时重构

• 有追求的coder需要有工匠精神，精益求精，追求代码品味

• 决定coder资历的不是工作年限，而是代码品味，coder需要注重代码修身之道

• 不要用面向对象的语言，却写着面向过程的code

    了解了代码质量的价值目标之后，现在谈谈具体如何写出高质量的（业务）代码，或者说从哪些方面提升代码整洁度：

• 命名简洁清晰

1. 1.  命名体现一个coder的硬实力，好的命名会让注释显得有点多余；

   2. 命名尽可能简洁，不要出现一个方法名一大串英文单词构成；

   3. 命名尽可能用全单词，除非是公认的缩写；

   4. 好的命名不容易，需要有工匠精神，愿意去琢磨；                 

• 函数职责单一

      a.  函数需要具有一定封装性；

      b.  一个函数不应该承担过多的职责，原则上引起它修改的原因应该只有一个；

      c.  好的函数封装利于复用；

      d.  不要出现一个功能就一个方法实现，从头写到尾；

• 代码层次粒度

  1. 代码层次粒度，这个非常重要，直接决定程序的可读性和优雅性

  2. 好的层次粒度划分应该是这个功能划分成几个步骤实现，第一步干什么，第N步干什么，非常清晰，每一步所做的事情通过方法命名去描述，读起来非常优雅，就像读一本书的目录一样，如果只对其中部分函数（目录）有兴趣，可以直接进入该函数，而无需从头读到尾；

  3. 代码层次粒度要控制好，哪些方法应该暴露在外层，与另外一个方法是同一级别的，哪些应该收缩到函数里面，这个非常讲究，就像目录结构一样，哪些目录是同一级别还是上下级别，这个跟我们穿衣服也是一样的，哪些衣服穿在里面，哪些穿在外面更漂亮，我想大家心里都有数，写代码也是一样一样的；

  4. 代码粒度层次清晰后，代码会变得非常整洁；

• 函数出入参

  1. 出入参需要清晰，不能带入多余的入参，能传入一个可读的简单类型就不传入一个对象，这影响函数的可复用性；

  2. 出入参数量不宜过多，参数过多一定程度上说明违背函数职责单一性；

  3. 参数的顺序也是需要约定规则，哪些在前面，哪些在后面；

  4. 函数可以认为是一个（黑盒子）工具，对入参进行加工返回出参

  5. 对出入参的梳理，也就是对业务的重新梳理；

  6. 只有函数的出入参定义清晰之后，测试用例的变化才可控；

• 异常和日志处理

  1. 异常和日志的处理对于程序的重要性不言而喻，这个对于线上问题定位效率非常关键；

  2. 日志和异常的时机判断非常重要，什么时候应该是通过异常处理，什么时候是通过日志处理，这个需要结合具体问题具体分析；

  3. 日志的级别要适宜，必要的参数需要加入情况，方便线上快速定位；

  4. 异常码需要定义清晰，特别是与前端和外部系统交互的系统；

• 不做过度设计，合理抽象

  1. 不建议在项目早期做过度的设计，特别是在业务不清晰的前提下；

  2. 合理的抽象能让程序简洁清晰，可扩展性和可复用性增强，但是有个前提是对业务了解比较深入，能够探寻到其中的规律；

  3. 方案需要根据适宜的使用场景而定，不采用过于超前的方案，系统2年内能满足即可，过度设计一定程度上等于资源浪费；

• 坏味道代码

• 优雅的代码

     很感谢曾经的老leader，受益于曾经一段时间刻意强化代码质量意识，不断实践总结，才得以养成现在的好习惯，好的习惯会一直追随个人职业生涯。

 

惯例

如果你对本文有任何疑问或者高见，欢迎添加公众号共同交流探讨（添加公众号可以获得”Java高级架构“上10G的视频和图文资料哦）。