学会去写好代码

一、为什么需要写好代码

写好代码可以让我们在项目后期收获很多好处,可以让我们减少很多维护成本,可以使我们后续的开发变得更加有效率

(一)维护成本

代码的开发只占其生命周期中很少的一部分,生命周期中大部分时间是处于维护阶段,所以让开发的代码变得易于维护很重要。代码最终还是由人维护的,所以我们要清楚代码不是给机器看的,是给人看的。代码需要写的让人容易理解,千万不要相信所谓的好的代码不需要注释,就连同JDK中的源代码都有很多注释,所以我们需要添加一些必要的注释,有些代码可能自己觉得很容易理解,代码也写的很见名知意了,但是对于其他人不见得是这样。

(二)业务扩展

对于业务型的项目,实际上我们的需求是不断的变化的,功能不是一成不变的,如果代码写的不好,后续的需求会开发的很艰难,大多数为了需求进度,我们会妥协,会用一次次的硬编码去临时解决问题,而不再事后去除硬编码,使我们的代码变得越来越难扩展,每一次写需求都会举步维艰,改一次就要重构一次。

(三)降低资源

现在的服务大部分都是大型服务,我们平时可能会经常被项目上要求降资源,好的代码可以让我们减少资源的浪费。

(四)提升安全

随着互联网的发展,网络安全、信息安全变得越来越重要,很多大型公司已经将安全提升到公司战略层次了,所以作为一个开发做好代码的安全十分的有必要。安全的代码可以避免很多的经济损失。

(五)提高性能

随着发展,用户对服务的时效性要求越来越高了,像刷个网页如果超过5S可能就走掉了。好的代码可以提高用户访问的性能或者说数据处理的性能。

二、什么是好代码

(一)通俗易懂

只有让其他人能很容易看懂自己写的代码才算得上好代码,在关键的分支或者处理点必须加有效的注释。

(二)易扩展

易扩展是站在开发人员的角度考虑的,因为对业务型的服务,考虑扩展是一个很重要的思想。如果代码设计的扩展性很好,后续的开发可能会让开发人员变得轻松。

(三)问题少

虽说在代码开发中遗留Bug是不可避免的现象,但是让自己开发的代码遗留尽可能少的Bug,应是每个开发者的使命。

(四)节省资源

好的代码应该在保证及时性、可用性等服务要求的前提下,尽量的节省资源,包括存储资源、CPU、内存等。

(五)安全

好的代码应该具有足够的安全性,包括服务运行的健壮性、用户的信息保密性等等。也要遵守开源协议,守住法律底线,尊重每一位开发人员及相关公司的劳动成果。

(六)易维护

可能有些会觉得易维护是和问题少有些重复,但我在此处重点提的是运维人员的维护,在真正的生产环境中代码问题实际已经很少了,更多的各种参数或配置的维护。我们应该将自己的代码设计的更灵活一点,不能想改一个小地方就需要重新生成镜像,重新去打包部署,那样代价就太大了。

三、怎样写好代码

实际开发过程中我们可以从多个角度去考虑,可以从时间、空间、安全、健壮性、资源、维护等多个维度去考虑。

(一)可维可测

从笔者自身开发经验来看,写的代码好不好可维可测是排在首位的。好的代码肯定是易维护、可测试的,在开发的时候不应该只考虑到功能是否实现,还需要怎样让代码变得更好维护、更方便测试。

(二)设计模式

根据业务场景的不同选择合适的设计模式,让后续的需求和变更变的更加容易、更加简单。

(三)检查工具

常见的静态问题代码检查工具有Pmd、Findbugs、Checkstyle、Cyclomatic Complexity、Codedex、圈深度、KW等,在实际开发过程中如果可以好好的利用这些检查工具,将提示的问题都解决了,代码质量肯定不会差太多的。

(四)硬编码

在开发过程中,难以避免引入硬编码。在有些场景下,硬编码是

猜你喜欢

转载自blog.csdn.net/u010313979/article/details/107227256