查看原文
其他

编码质量之道

码农小胖哥 码农小胖哥 2020-10-17


虽然我们可以借助与代码静态检测工具或者一些开发规约来约束开发者,使其编码趋于规范。但是很多开发者仍然不能写出高质量的代码。如何才能写出高质量的代码?我想这是很多开发者关心的问题。所以我总结了七个问题,我们作为开发人员每次代码commit时应该问自己是否做到了。

Q这是对的吗?A

代码实现了需求,达到了期望。并且可以通过某种方式测试;最好通过自动化测试,或者至少通过手动测试。这才是对的!

Q这真的安全吗?A

它是否防止误用,是否遵循最佳安全实践,是否验证其输入,是否防止注入等。是否经过测试证明它对这些已知攻击是安全的。只有处理了这些问题,你的代码才是安全的。

Q它的可读性和可维护性够吗?A

它是否让其他人轻松阅读,遵循并理解它,它是否有适当的注释,描述某段代码如何适应大局,它是否以小的可读单元分解代码。永远不要让别人在维护你的代码的同时心里却在问候你祖宗十八代。

Q它是可扩展的吗?A

是否允许使用其它用例进行扩展,它是否使用允许可扩展性的适当设计模式,是否可参数化和可配置,是否允许编写新功能而不会破坏旧功能,是否覆盖了现有功能的足够百分比测试,防止因为改变而导致“崩塌”。

Q它行之有效吗?A

是否在高负载下运行良好,是否关心算法复杂度(没有过早优化),是否使用批处理,是否避免一次性在内存中加载大块数据,是否正确使用异步处理。

Q它值得你引以为傲吗?A

一段好的代码才是你经验的象征而不是年限。并不是每一段代码都是让你有成就感,因为大多数代码都在执行平凡的逻辑。好的代码需要不断的打磨,不断的优化。

我想我们可以将这些问题放在心里。经常问自己这些问题。慢慢你将具有一些强迫症。慢慢你也会形成像工匠一样的品质。加上现代化的编程工具,你的代码质量就会逐渐提高。软件的成败取决于很多因素,往往不是程序员的错误。但是成功的软件一定是需要高质量的。开发者只有时刻注重代码的质量,才能为成功的软件做出贡献。


● java随机数中的陷阱

 java必学核心知识总结——注解

 简述设计模式原则

    您可能也对以下帖子感兴趣

    文章有问题?点此查看未经处理的缓存