关于代码质量的一点思考
最近在做基础开发框架登录模块的重构,所以来谈一谈关于代码质量的思考。
进入正题之前,先吐槽一下,看看能不能引起一点共鸣。
之所以要重构这部分的代码,原因很简单,公司的测试团队通过压力测试发现登录这块有性能问题。同时,基于另外一个使用产品基础开发框架的团队需要在登录这块进行一些业务上的扩展。怀着激动的心情打开这块的相关代码,首先第一感觉就是杂乱无章,排版糟糕。没办法,要解决问题,还是得硬着头皮看下去。接着,从前端UI界面的输入到提交看起,发现代码相当的绕,很难看懂其中的逻辑。另外,其中还有大片的冗余拖沓代码。虽然整体功能逻辑完整的实现了,但是实现细节一团糟。毫不夸张的说,很多部分的代码完全属于技术验证阶段的代码。遇到这样的代码,我想很少能有人能静下心来完完整整的看完…
下面说说我所认为的代码是怎么样的:
- 代码需要排版整洁干净、并且有清晰适当的注释,当打开代码源文件的瞬间,能给人一种赏心悦目的感觉。
- 代码要简洁,不拖沓,不能为了封装而封装,为了面向对象而面向对象。重复功能的代码尽量封装成方法,杜绝成段成段的相同代码、冗余代码。
- 代码的结构要清晰,让其他人能轻松的找到程序的入口,轻松摸清代码的整体脉络,并且不看每个方法中的具体内容,只需要看整个代码的骨骼即能了解程序的功能。
- 模块与模块的对接部分要简洁。大部分情况为沟通不彻底或者相互对对方的模块缺乏基本的了解造成。
- 注重代码的性能。这一块不仅需要从纯技术角度去考虑代码的性能,还需要深入的了解业务需求,往往一个灵光一闪的想法就能节约成片的代码、以简单的逻辑实现复杂的业务需求。
一些思考:
- 好的代码往往是经过不断的打磨产生的,一个精进的程序员应当具备一颗喜欢折腾代码的躁动的心。
- 对于框架级的代码,越早重构越好,越往后拖所带来的成本越大。
- 糟糕代码质量的代码后期维护成本不可估量,甚至会影响到后续新功能的开发,从这里真正能对比出一个优秀Programmer的价值。
- 写代码也是一门艺术。一段完美精致代码的创造过程不亚于一件艺术品的创作过程。
5 回复
要对代码负责
关于代码质量这东西,新手来说,经验传授很重要,重在教育,对于老手来说,都踩过坑了,所以知道好的代码是什么样的。写代码,真的需要强迫症!不断重构,把程序写漂亮
@DevinXian 实际情况是这部分代码是组里一个小孩儿都快大学毕业的老码农写的,所以才比较感慨…
啥人都有的,很多人到退休都没干明白的