编程的智慧-简化版
这是王垠写的一篇关于如何写出高质量代码的实用技巧文章,很多人都会提到要写优雅的代码,要用设计模式,代码要清爽等等,但都停留在喊口号上,这篇文章没有口号,只有实在的技巧,但是内容很多,我对其核心部分做一个整理。
原文链接:编程的智慧
技巧
反复推敲代码
就像文学作品一样,代码是不可能一蹴而就的。灵感似乎总是零零星星,陆陆续续到来的。任何人都不可能一笔呵成,就算再厉害的程序员,也需要经过一段时间,才能发现最简单优雅的写法。有时候你反复提炼一段代码,觉得到了顶峰,没法再改进了,可是过了几个月再回头来看,又发现好多可以改进和简化的地方。这跟写文章一模一样,回头看几个月或者几年前写的东西,你总能发现一些改进。
孔子说:如切如磋如琢如磨。意思就是要不断的去打磨你的代码,做好一件事不见得有多大的成长,事后不断的反思,提炼才能让自己不断进步。
推敲的目的就是为了让代码:优雅,结构清晰,便于维护,易于扩展
可读的代码
函数
- 避免太长的函数,函数的第一规则是短小,第二规则是要更短小
- 函数只做一件事,每个函数一个抽象层级,不要写“通用的函数”
- 函数的参数越少越好,理想情况是0个,其次是一个,再次是两个,避免三个以上的参数。如果参数个数过多,说明要封装为一个类了。
- 把复杂的逻辑提取出去,做成“帮助函数”。
下图是一个比较清晰的函数调用层级:
变量
- 使用有意义的变量名,函数名,类名,不要因为想不到好的名称就随便起一个名字,好的名字在使用的过程会节省我们很多功夫,想想后面开发的时候因为随便起名导致找不到自己的变量,函数了,会不会耽误很多时间?
- 局部变量应该尽量接近使用它的地方。变量定义离用的地方越近,导线的长度就越短。你不需要摸着一根导线,绕来绕去找很远,就能发现接收它的端口,这样的电路就更容易理解。
- 局部变量名字应该简短。因为它们处于局部,再加上第2点已经把它放到离使用位置尽量近的地方,所以根据上下文你就会容易知道它的意思
- 不要重用局部变量。容易混淆,把局部变量的作用域不必要的增大。更好的做法是定义两个变量
- 把复杂的表达式提取出去,做成中间变量。一句话尽量不要用太复杂的表达式。
表达式
- 避免使用自增减表达式(i++,++i,i–,–i),建议拆开写
- 永远不要省略花括号。
- 避免使用continue和break。 建议调整代码逻辑来避免Continue与break
- 如果出现了continue,你往往只需要把continue的条件反向,就可以消除continue。
- 如果出现了break,你往往可以把break的条件,合并到循环头部的终止条件里,从而去掉break。
- 有时候你可以把break替换成return,从而去掉break。
- 如果以上都失败了,你也许可以把循环里面复杂的部分提取出来,做成函数调用,之后continue或者break就可以去掉了。
异常
- 异常捕捉,不应该使用Exception这么宽泛的类型。你应该正好catch可能发生的那种异常A。
- 尽量不要产生null指针。尽量不要用null来初始化变量,函数尽量不要返回null。
- 不要把null放进“集合数据结构”里面。或者你可以指定一个特殊的,真正合法的对象,用来表示“没有”。
- 函数调用者:明确理解null所表示的意义,尽早检查和处理null返回值,减少它的传播。
- 函数作者:明确声明不接受null参数,当参数是null时立即崩溃。不要试图对null进行“容错”,不要让程序继续往下执行。如果调用者使用了null作为参数,那么调用者(而不是函数作者)应该对程序的崩溃负全责。
程序的绝大部分功能,是进行信息处理。从一堆纷繁复杂,模棱两可的信息中,排除掉绝大部分“干扰信息”,找到自己需要的那一个。正确地对所有的“可能性”进行推理,就是写出无懈可击代码的核心思想。
代码漏掉任何一种可能出现的情况,都可能产生意想不到的灾难性结果。
防止过度工程
过度工程即将出现的一个重要信号,就是当你过度的思考“将来”,考虑一些还没有发生的事情,还没有出现的需求。比如,“如果我们将来有了上百万行代码,有了几千号人,这样的工具就支持不了了”,“将来我可能需要这个功能,所以我现在就把代码写来放在那里”,“将来很多人要扩充这片代码,所以现在我们就让它变得可重用”……
防止过度工程的原则如下:
- 先把眼前的问题解决掉,解决好,再考虑将来的扩展问题。
- 先写出可用的代码,反复推敲,再考虑是否需要重用的问题。
- 先写出可用,简单,明显没有bug的代码,再考虑测试的问题。
重点
在写代码的时候,如果不清楚怎么写才合适,先mark下来。功能完成之后进行推敲,建议参考《阿里巴巴Java开发手册》。上面的可读代码在阿里代码规约上也有描述,当然在平时想的多了,会有自己的一套优雅代码风格。
有时间去考一下代码规范认证,持照上路,不做代码杀手。