代码整洁之道—技术分享

文档说明

《代码整洁之道》是2009年12月由人民邮电出版社出版的图书，作者是马丁。本文仅分享阅读之后的收获。有兴趣的请详细阅读原著。

代码简洁

有意义的命名

• 类的命名
  能够凸显出所属领域，比如说XXXContorller，XXXService,XXXUtils,XXXHandler等，一般 我们经常取业务相关的名称，并以该类所属领域来命名类名

• 方法的命名
  能够凸显出方法的作用，比如saveXXX(),updateXXX(),doXXX()等，一般我们经常以作用为前缀再加上业务相关的名称来命名方法名

• 属性的命名
  属性的命名，尽可能可以包含业务名称，比如登录状态属性，有的同学可能喜欢简单风格直接用status，我个人更倾向与带上业务表示loginStatus这样子

只做一件事

• 类层次
  DDD领域驱动现在在技术圈一直是个很热门的话题。如果类的作用边界上下文定义在自己的专属领域，那么我愿称之为专一的类。
  常见的一般有负责业务，负责存储的，负责提供辅助的等，不同的类应该划分在自己专属的领域

• 方法层次
  如果说类需要在领域层面专注于一件事，那么方法则是需要将一个领域的某一道工序，尽可能分解组合，已达到方法的复用，解耦和内聚

结构化编程

仅从原著中摘出一句分享:
每个函数、函数中的每个代码块都应该有一个入口、一个出口，遵循这些规则，意味着在每一个函数中只该有一个return语句，循环中不能有break或continue语句，而且永永远远不能有任何goto语句

有效且优雅的注释

• 业务解释
  类一般可以简介下它所属的领域即可
  方法一般需要简介下它处理的业务，如果业务流程复杂且长，建议简单描述下处理流程
• TODO标记
  主要记录未完成或待完善的事项
• 使用警示
  常常对于一些公用的方法，如果有必要可以备注下使用需要注意的事项，这对其他同学使用应该会非常友好

代码格式化

代码格式化，现在基本编写工具都有，SQL代码的格式化也需要注意下吧。

得墨忒耳律

暴露抽象接口，隐藏实现，详细可自行查询资料。

错误处理

• 抽离try catch代码块
  try catch包裹的代码块用方法抽离，这样看起来会简洁舒服很多
• catch处理
  有的同学打印错误日志，直接返回null或者错误代码
  有的同学抛出业务异常（也是书中推荐的方式）
  个人倾向于后者

类瘦身

曾见到过，一个类上百个属性。。。
尤其Controller查询参数VO,有的同学crud一个VO搞定，可能是为了赶时间吧
在某些场景下继承、组合也许是不错的选择

写在最后

相互学习，提升自己。每个人心中对简洁的定义或许并不相同，欢迎大家评论，愿与诸君共勉