优秀代码所具备的5大品质 你的代码呢?

在我先前的博客中,我主要讲了我们的编码风格应该适应我们所处的业务领域。即不同的业务领域需要不同编码风格的软件。例如,为防御体系写的软件必须强健稳定,因为一次崩溃可能就会终结它的生命周期,而为市场交易写的软件,则必须可维护,并且还可以添加广告,通常这些项目和软件的生命周期都非常短,所以这些软件还必须可以重复使用。

虽然我之前从没看到过它被应用于这些业务领域,但是关于编码优先顺序这一观点却并不是最近才出来的。我第一次看到这一观点是在Steve Maguire写的一本由微软出版社于1997年出版的书上,书名叫做《Debugging the Development Process》。

在这本书中,Steve论述了关于在编写软件时,我们应该建立优先顺序的观点。他列举的他认为需要考虑的优先事项包括:

  • 规模
  • 速度
  • 稳健性
  • 安全性
  • 可测试性
  • 可维护性
  • 简单
  • 可重用性
  • 可移植性

现在说说那个时候的背景——1997年,那时的CD-RW驱动器和媒介刚问世,内存还很昂贵,处理器还很慢,语种选择还是C / C++。

随着时间的推移,现在的Java程序员通常毋需再考虑规模和速度,所以上面的列表可以缩减为:

  • 安全性
  • 可测试性
  • 稳健性
  • 可维护性
  • 简单
  • 可重用性

下面我们要讨论的是上面这个列表是否还适用于今天,具体为……

1.安全性

虽然写着的是“安全性”,但是Steve真正想说的是编程范例和算法。有些技术是比其他的要来得更安全,例如,使用查表返回值比使用逻辑驱动来计算数值要安全。我们设计时也需要考虑到安全性这一特点。

2.可测试性和稳健性

对我来说,这两者差不多。从定义上讲,经过充分测试的代码就会比较稳健。如果你正在使用测试驱动开发(TDD),那么你也可以将这一条从列表中删除,这是因为它们在此进程中是固有的。如果你是不喜欢使用TDD的程序员大军中的一员,那么这一条应该保留……

3.可维护性

这一条可以反映出一个人的代码风格、思维条理和清楚表达自己的能力。在风格方面,大家可以借鉴Uncle Bob在《Clean Code>中的描述,这也是我最喜欢的书籍之一。Uncle Bob的风格……怎么说呢,整体感觉就是干净。方法和类都很短,服从SRP和整洁的布局。这也是优秀软件的关键属性。

4.简单

代码简单是我们共同的目标追求,但是这并不意味着写出来的代码是被过分简化的,我们只需要做到,代码虽然最简化,没有装饰、没有镀金,也不具备以后可能需要添加的功能,但是依然可以完成工作。这种最简化代码的观点已然成为了敏捷社区的核心思想,甚至Shane Warden和James Shore也在他们的《The Art of Agile Development》一书中,花费了一整章的篇幅来描述这一观点,包括它的概念,如“once and only once”以及“you ain’t gonna need it”。

5.可重用性

这一点我就不多说了,我们总是希望现在写的代码以后还可以再次使用,省时省力。

综上所述

首先,自1997年以来,很多事情都发生了变化,这是毋庸置疑的。但是在我看来,一些好的观点依然值得我们学习和借鉴……

回到

顶部