01 - 什么是好的代码?

对开发人员来说,辨别代码的“好”和“烂”,是个非常重要的能力,这也是我们写出好代码的前提。

那什么是好的代码,我们应该从哪些维度评判代码质量的高低呢?

答案是:很难通过某(几)个词汇来全面地评价代码质量。

“评价”这个词本身就有很强的主观性,每个人的标准都不尽一致。但不可否认的是,越有经验的工程师,给出的评价也就越准确。

02 - 评价代码的标准有哪些

2.1 可维护性(maintainability)

“维护”,就是修改 bug、修改老代码、添加新代码之类的工作。

  • “代码易维护”,就是在不破坏原有代码设计、不引入新 bug 的情况下,能够快速修改或者添加代码。
  • “代码不易维护”,就是修改或者添加代码时很可能引入新的 bug,并且需要花费很长的时间才能完成。

大多数项目中,维护代码的时间要远多于编写代码的时间,所以代码的可维护性非常重要。

影响代码的可维护性的因素有很多,比如:

  • 代码的分层是否清晰,模块化是否良好,模块间耦合性是否足够低(要高内聚、低耦合);
  • 项目代码量的多少,业务的复杂程度,使用到的技术的复杂程度;
  • 另外,各类过程文档的编写、团队成员的开发水平等因素也会影响代码的可维护性。

2.2 可读性(readability)

首先,代码被阅读的次数要远远超过被编写、修改的次数,读不懂代码,就很难安全地添加新功能、修复旧 bug。

代码的可读性,与代码是否符合编码规范、代码的命名(包括类、函数、变量等)是否达意、注释是否详尽、函数是否长短合适、模块划分是否清晰等因素有关。

影响代码的可维护性的因素有很多,比如:

  • Code Review(代码审查)是个很好的测验代码可读性的方法。
  • 如果你的同事可以轻松读懂你写的代码,说明你的代码可读性很好;
  • 如果其他人在读你的代码时,有很多疑问,说明你的代码可读性并不高。

2.3 可扩展性(extensibility)

可扩展性表示代码应对未来需求变化的能力。

如果原有的代码已经预留好了扩展点(比如原代码中抽象了很多底层可以复用的模块),我们在修改很少代码的情况下,添加新的功能。

这个时候,就可以说代码的可扩展性好,也可以说成代码的灵活性(flexibility)好。

影响代码的可维护性的因素有很多,比如:

代码的可读性和可扩展性,在很大程度上决定了代码是否有良好的维护性。

2.4 简洁性(simplicity)

用最简单的方法解决最复杂的问题,能做到这一点的,都是真正的大牛。

程序开发中有个很有名的 KISS 原则:“Keep It Simple, Stupid”,就是说要尽量保持代码简单,甚至于傻瓜化,这其实也意味着代码易读、易维护。

2.5 可复用性(reusability)

开发过程中,要多复用已有的代码,尽力避免堆砌重复(相似)的代码。

与可复用性相关的设计原则和实践经验有:

  • 与 KISS 原则齐名的 DRY(Don’t Repeat Yourself)原则,强调的就是要提高代码的可复用性;
  • 有面向对象编程基础的同学,应该都知道继承、多态存在的目的之一,就是提高代码的可复用性;
  • 单一职责原则、解耦、高内聚、模块化等实践经验都能提高代码的可复用性。

2.6 可测试性(testability)

这个评判维度比较少提及,但却是非常重要的代码质量评价标准。

为了降低线上的故障率,我们的代码需要通过测试环节的检验。可测试性良好的代码有利于编写单元测试,有利于我们在测试环节更全面地发现问题、更快地定位到是哪些代码产生了这些问题。

可测试性高的代码大多有这些特征:

职责单一;
输入明确(可控制);
输出清晰(可预测);
运算状态(一般是错误状态)可见;……

03 - 本篇总结

设计问题没有标准答案,关键是我们要有自己的思考:

为什么有这种设计原则、思想或模式?
它能解决什么问题?有哪些应用场景?
该如何权衡、恰当地在项目中应用?

同时要认识到,上述评价维度 不是完全独立 的,有些具有包含关系,也有的会互相影响。比如:

代码的可读性好、可扩展性好,就意味着代码的可维护性好;
有些代码的可扩展性和可复用性好,抽象出了很多接口、类和方法,但却又导致代码的可读性和简洁性下降。

现在,我们摸清了好代码的样子,也知道了好代码的常见评判标准,接下来我们就要学习各类设计原则和设计思想了哦。

开始期待吧 :-)


参考资料:

极客时间-王争《设计模式之美》

版权声明

作者: 瘦风(https://healchow.com)

出处: 博客园 瘦风的博客(https://www.cnblogs.com/shoufeng)

感谢阅读, 右侧导航栏有「瘦风的南墙」公众号二维码,输出更及时、更体系,欢迎扫码关注

Design Patterns | 02 什么样的代码是好代码的更多相关文章

  1. [Design Patterns] 02. Structural Patterns - Facade Pattern

    前言 参考资源 史上最全设计模式导学目录(完整版) 只把常用的五星的掌握即可. 外观模式-Facade Pattern[学习难度:★☆☆☆☆,使用频率:★★★★★] 深入浅出外观模式(一):外观模式概 ...

  2. [Design Patterns] 3. Software Pattern Overview

    When you're on the way which is unknown and dangerous, just follow your mind and steer the boat. 软件模 ...

  3. Design Patterns Simplified - Part 3 (Simple Factory)【设计模式简述--第三部分(简单工厂)】

    原文链接:http://www.c-sharpcorner.com/UploadFile/19b1bd/design-patterns-simplified-part3-factory/ Design ...

  4. [Design Patterns] 4. Creation Pattern

    设计模式是一套被反复使用.多数人知晓的.经过分类编目的.代码设计经验的总结,使用设计模式的目的是提高代码的可重用性,让代码更容易被他人理解,并保证代码可靠性.它是代码编制真正实现工程化. 四个关键元素 ...

  5. 设计模式(Design Patterns)

    设计模式(Design Patterns) ——可复用面向对象软件的基础 设计模式(Design pattern)是一套被反复使用.多数人知晓的.经过分类编目的.代码设计经验的总结.使用设计模式是为了 ...

  6. 设计模式(Design Patterns)Java版

    设计模式(Design Patterns) ——可复用面向对象软件的基础 设计模式(Design pattern)是一套被反复使用.多数人知晓的.经过分类编目的.代码设计经验的总结.使用设计模式是为了 ...

  7. java Design Patterns

    设计模式(Design Patterns) ——可复用面向对象软件的基础 设计模式(Design pattern)是一套被反复使用.多数人知晓的.经过分类编目的.代码设计经验的总结.使用设计模式是为了 ...

  8. MapReduce Design Patterns(chapter 1)(一)

    Chapter 1.Design Patterns and MapReduce MapReduce 是一种运行于成百上千台机器上的处理数据的框架,目前被google,Hadoop等多家公司或社区广泛使 ...

  9. (转)MapReduce Design Patterns(chapter 1)(一)

    翻译的是这本书: Chapter 1.Design Patterns and MapReduce MapReduce 是一种运行于成百上千台机器上的处理数据的框架,目前被google,Hadoop等多 ...

随机推荐

  1. Qt uchar * 转 QImage

    QImage(uchar * data, int width, int height, Format format) QImage(const uchar * data, int width, int ...

  2. telnet不是内部或外部命令的问题解决

    在windows DOS 命令窗口中输入telnet命令,出现如下提示信息:     可能是没有安装telnet客户端的原因,又得开始捣鼓了  www.2cto.com     依次点击"开 ...

  3. Visual Studio通过Cordova支持混合跨平台移动开发

    Microsoft在Visual Studio 2013 Update 2中添加了对混合跨平台移动应用程序的本地支持. Microsoft早在2011年就已经开始了与PhoneGap的合作,那时候是为 ...

  4. python反转链表和成对反转

    https://www.cnblogs.com/tianqizhi/p/9673894.html https://blog.csdn.net/weixin_34168700/article/detai ...

  5. virtualenv 个人指南

    virtualenv是解决一个机器上多个应用需要的Python版本不一致的问题,virtualenv就是用来为一个应用创建一套"隔离"的Python运行环境,解决了解决了不同应用间 ...

  6. The difference between applicationContext.xml in Spring and xxx-servlet.xml in SpringMVC

    一直搞不明白两者的区别.如果使用了SpringMVC,事实上,bean的配置完全可以在xxx-servlet.xml中进行配置.为什么需要applicationContext.xml?一定必须? 因为 ...

  7. JQUERY的基本使用方法

    #准备工作 在官网下载JQUERY库 将库在你需要的网页上引用 123 <head><script src="jquery.js"></script& ...

  8. 时尚起义开源话题微博系统 v.0.4.5 上传漏洞

    漏洞出现在/action/upload.php文件中 <?php /** ** **By QINIAO **/ !defined('QINIAO_ROOT') && exit(' ...

  9. Alberto Del Bimbo:为什么说研究员要有想象力?

    ​ Del Bimbo:为什么说研究员要有想象力?" title="Alberto Del Bimbo:为什么说研究员要有想象力?"> ​ 说到科研,与日本式的&q ...

  10. java反序列化-ysoserial-调试分析总结篇(2)

    前言: 这篇主要分析commonCollections2,调用链如下图所示: 调用链分析: 分析环境:jdk1.8.0 反序列化的入口点为src.zip!/java/util/PriorityQueu ...