【Java设计模式 学习目标及大纲】高质量代码的标准及实现路径

如果说数据结构与算法是教我们写出高效的代码，那设计模式就是教我们写出可扩展、可读、可维护的高质量代码。在正式学习设计模式之前，我们需要知道什么是好代码，设计模式为什么被提出来，对于代码质量的提高的帮助是什么？那么什么是高质量代码的标准呢？

高质量代码的标准

代码质量的评价有很强的主观性，描述代码质量的词汇也有很多，比如可读性、可维护性、灵活、优雅、简洁等，这些词汇是从不同的维度去评价代码质量的。它们之间有互相作用，并不是独立的，比如，代码的可读性好、可扩展性好就意味着代码的可维护性好。代码质量高低是一个综合各种因素得到的结论。我们并不能通过单一的维度去评价一段代码的好坏

代码评价常用指标

最常用的、最重要的评价标准包括：可维护性、可读性、可扩展性、灵活性、简洁性（简单、复杂）、可复用性、可测试性

1 可维护性（maintainability）

什么是代码的可维护性？

所谓的代码维护无外乎就是修改 bug、修改老的代码、添加新的代码之类的工作，这类工作的便捷程度代表了代码的可维护性

什么样的代码算可维护性高呢？

客观上可以这么判断：

• 代码的可维护性是由很多因素协同作用的结果。代码的可读性好、简洁、可扩展性好，就会使得代码易维护；相反，就会使得代码不易维护。
• 更细化地讲，如果代码分层清晰、模块化好、高内聚低耦合、遵从基于接口而非实现编程的设计原则等等，那就可能意味着代码易维护。除此之外，代码的易维护性还跟项目代码量的多少、业务的复杂程度、利用到的技术的复杂程度、文档是否全面、团队成员的开发水平等诸多因素有关

主观上上可以这么判断：

• 代码易维护指，在不破坏原有代码设计、不引入新的 bug 的情况下，修改、添加功能能够轻松完成、bug 容易修复。那我们就可以主观地认为代码对我们来说易维护
• 代码不易维护指，修改或者添加代码需要冒着极大的引入新 bug 的风险，并且需要花费很长的时间才能完成，那我们就可以主观地认为代码对我们来说不易维护

2 可读性（readability）

代码的可读性应该是评价代码质量最重要的指标之一。我们在编写代码的时候，时刻要考虑到代码是否易读、易理解。

代码的可读性在非常大程度上会影响代码的可维护性。毕竟，不管是修改 bug，还是修改添加功能代码，我们首先要做的事情就是读懂代码。代码读不大懂，就很有可能因为考虑不周全，而引入新的 bug。

什么样的代码算可读性高呢？

客观上可以这么判断：

• 我们需要看代码是否符合编码规范、命名是否达意、注释是否详尽、函数是否长短合适、模块划分是否清晰、是否符合高内聚低耦合等等

主观上可以这么判断：

• code review 是一个很好的测验代码可读性的手段。如果同事可以轻松地读懂你写的代码，那说明你的代码可读性很好；如果同事在读你的代码时，有很多疑问，那就说明你的代码可读性有待提高了

3 可扩展性（extensibility）

什么是代码的可扩展性？

它表示我们的代码应对未来需求变化的能力，我们在不修改或少量修改原有代码的情况下，通过扩展的方式添加新的功能代码。。跟可读性一样，代码是否易扩展也很大程度上决定代码是否易维护

什么样的代码算可扩展性高呢？

如果代码预留了一些功能扩展点，你可以把新功能代码，直接插到扩展点上，而不需要因为要添加一个功能而大动干戈，改动大量的原始代码，这就说明代码的可扩展性不错

4 灵活性（flexibility）

什么样的代码算灵活性高呢？

实际上，灵活性是一个挺抽象的评价标准，要给灵活性下个定义也是挺难的，满足如下几个场景可以大致判断：

• 当我们添加一个新的功能代码的时候，原有的代码已经预留好了扩展点，我们不需要修改原有的代码，只要在扩展点上添加新的代码即可。这个时候，我们除了可以说代码易扩展，还可以说代码写得好灵活。
• 当我们要实现一个功能的时候，发现原有代码中，已经抽象出了很多底层可以复用的模块、类等代码，我们可以拿来直接使用。这个时候，我们除了可以说代码易复用之外，还可以说代码写得好灵活。
• 当我们使用某组接口的时候，如果这组接口可以应对各种使用场景，满足各种不同的需求，我们除了可以说接口易用之外，还可以说这个接口设计得好灵活或者代码写得好灵活。

如果一段代码易扩展、易复用或者易用，我们都可以称这段代码写得比较灵活

5 简洁性（simplicity）

KISS 原则：Keep It Simple，Stupid。这个原则说的意思就是，尽量保持代码简单。代码简单、逻辑清晰，也就意味着易读、易维护。我们在编写代码的时候，往往也会把简单、清晰放到首位，思从深而行从简，真正的高手能云淡风轻地用最简单的方法解决最复杂的问题

6 可复用性（reusability）

代码的可复用性可以简单地理解为，尽量减少重复代码的编写，复用已有的代码

7 可测试性（testability）

代码可测试性的好坏，能从侧面上非常准确地反应代码质量的好坏。代码的可测试性差，比较难写单元测试，那基本上就能说明代码设计得有问题

如何写出高质量代码

问如何写出高质量的代码，也就等同于在问，如何写出易维护、易读、易扩展、灵活、简洁、可复用、可测试的代码。其中，易维护、易读、易扩展又是提到最多的、最重要的三个评价标准。

要写出满足这些评价标准的高质量代码，我们需要掌握一些更加细化、更加能落地的编程方法论，包括面向对象设计思想、设计原则、设计模式、编码规范、代码重构等。而所有这些编程方法论的最终目的都是为了编写出高质量的代码。比如，

• 面向对象思想中的继承、多态能让我们写出可复用的代码
• 编码规范能让我们写出可读性好的代码
• 设计原则中的单一职责、DRY、基于接口而非实现、里式替换原则等，可以让我们写出可复用、灵活、可读性好、易扩展、易维护的代码
• 设计模式可以让我们写出易扩展的代码
• 持续重构可以时刻保持代码的可维护性

当然以上的评价标准也有一些包含关系：

评价标准	评价标准子项
可维护性	可读性、可扩展性
可读性	-
可扩展性	-
灵活性	可扩展性、可复用性
简洁性	-
可复用性	-
可测试性	-

高质量代码编程方法论

要具备编写高质量代码的能力，需要学习一些编程方法论，其中就包含面向对象设计思想、设计原则、设计模式、编程规范、重构技巧。

面向对象设计思想

主流的编程范式或者是编程风格有三种，它们分别是面向过程、面向对象和函数式编程。面向对象这种编程风格又是这其中最主流的。现在比较流行的编程语言大部分都是面向对象编程语言。大部分项目也都是基于面向对象编程风格开发的。面向对象编程因为其具有丰富的特性（封装、抽象、继承、多态），可以实现很多复杂的设计思路，是很多设计原则、设计模式编码实现的基础，设计思想需要了解如下路径

1. 面向对象的四大特性：封装、抽象、继承、多态
2. 面向对象编程与面向过程编程的区别和联系
3. 面向对象分析、面向对象设计、面向对象编程
4. 接口和抽象类的区别以及各自的应用场景
5. 基于接口而非实现编程的设计思想
6. 多用组合少用继承的设计思想
7. 面向过程的贫血模型和面向对象的充血模型

能回答完整以上问题即认为掌握了这种设计思想。

设计原则

设计原则是指导我们代码设计的一些经验总结。设计原则这块儿的知识有一个非常大的特点，那就是这些原则听起来都比较抽象，定义描述都比较模糊，不同的人会有不同的解读。所以，如果单纯地去记忆定义，对于编程、设计能力的提高，意义并不大。

1. SOLID 原则 -SRP 单一职责原则
2. SOLID 原则 -OCP 开闭原则
3. SOLID 原则 -LSP 里式替换原则
4. SOLID 原则 -ISP 接口隔离原则
5. SOLID 原则 -DIP 依赖倒置原则
6. DRY 原则、KISS 原则、YAGNI 原则、LOD 法则

对于每一种设计原则，我们需要掌握它的设计初衷，能解决哪些编程问题，有哪些应用场景。只有这样，我们才能在项目中灵活恰当地应用这些原则

设计模式

设计模式是针对软件开发中经常遇到的一些设计问题，总结出来的一套解决方案或者设计思路。大部分设计模式要解决的都是代码的可扩展性问题。设计模式相对于设计原则来说，没有那么抽象，而且大部分都不难理解，代码实现也并不复杂。这一块的学习难点是了解它们都能解决哪些问题，掌握典型的应用场景，并且懂得不过度应用

总共有 23 种设计模式。这些模式可以分为三大类：创建型模式（Creational Patterns）、结构型模式（Structural Patterns）、行为型模式（Behavioral Patterns）。

模式分类	模式分类描述	模式
创建型	这些模式关注实例对象的创建 ，共5种	工厂方法模式、抽象工厂模式、单例模式、建造者模式、原型模式
结构型	这些模式关注类和对象的组合 ，共7种	适配器模式、装饰器模式、代理模式、外观模式、桥接模式、组合模式、享元模式
行为型	这些模式关注对象之间的通信 ，共11种	策略模式、模板方法模式、观察者模式、迭代子模式、责任链模式、命令模式、备忘录模式、状态模式、访问者模式、中介者模式、解释器模式

编码规范

编程规范主要解决的是代码的可读性问题。编码规范相对于设计原则、设计模式，更加具体、更加偏重代码细节。即便对设计原则不熟悉、对设计模式不了解，但最起码要掌握基本的编码规范，比如，如何给变量、类、函数命名，如何写代码注释，函数不宜过长、参数不能过多等等

编码规范也可以理解为重构中的小重构，关于编码规范我单独有个专栏专门去介绍：阿里巴巴Java编程规范学习

代码重构

在软件开发中，只要软件在不停地迭代，就没有一劳永逸的设计。随着需求的变化，代码的不停堆砌，原有的设计必定会存在这样那样的问题。针对这些问题，我们就需要进行代码重构。重构是软件开发中非常重要的一个环节。

持续重构是保持代码质量不下降的有效手段，能有效避免代码腐化到无可救药的地步。而重构的工具就是前面罗列的那些面向对象设计思想、设计原则、设计模式、编码规范。实际上，设计思想、设计原则、设计模式一个最重要的应用场景就是在重构的时候。代码重构需要掌握：

1. 重构的目的（why）、对象（what）、时机（when）、方法（how）
2. 保证重构不出错的技术手段：单元测试和代码的可测试性
3. 两种不同规模的重构：大重构（大规模高层次）和小重构（小规模低层次）

需要注意，以上重构工具中，虽然使用设计模式可以提高代码的可扩展性，但过度不恰当地使用，也会增加代码的复杂度，影响代码的可读性。在开发初期，除非特别必须，我们一定不要过度设计，应用复杂的设计模式。而是当代码出现问题的时候，我们再针对问题，应用原则和模式进行重构。这样就能有效避免前期的过度设计

总结一下

我们明确了什么是高质量的代码：易维护、易读、易扩展、灵活、简洁、可复用、可测试，也知道高质量代码的达成路径工具箱：面向对象设计思想是基本指导思想，是很多设计原则、设计模式的实现基础；设计原则是代码设计的抽象经验总结、是设计模式设计的指导原则；设计模式是代码设计的一套具体解决方案或设计思路，主要用来提高代码可扩展性；编程规范是一套可执行的代码编写规范，主要用来提高代码的可读性；代码重构依赖面向对象设计思想、设计原则、设计模式、编程规范实现，主要用来提高代码的可维护性。

• 面向对象设计思想因为其具有丰富的特性（封装、抽象、继承、多态），可以实现很多复杂的设计思路，是很多设计原则、设计模式等编码实现的基础。
• 设计原则是指导我们代码设计的一些经验总结，对于某些场景下，是否应该应用某种设计模式，具有指导意义。比如，“开闭原则”是很多设计模式（策略、模板等）的指导原则。
• 设计模式是针对软件开发中经常遇到的一些设计问题，总结出来的一套解决方案或者设计思路。应用设计模式的主要目的是提高代码的可扩展性。从抽象程度上来讲，设计原则比设计模式更抽象。设计模式更加具体、更加可执行。
• 编程规范主要解决的是代码的可读性问题。编码规范相对于设计原则、设计模式，更加具体、更加偏重代码细节、更加能落地。持续的小重构依赖的理论基础主要就是编程规范。
• 代码重构作为保持代码质量不下降的有效手段，利用的就是面向对象、设计原则、设计模式、编码规范这些理论。

实际上，面向对象、设计原则、设计模式、编程规范、代码重构，这五者都是保持或者提高代码质量的方法论，本质上都是服务于编写高质量代码这一件事的。也可以这么理解：1个设计思想、6个设计原则、23个设计模式、一套编程规范，在合适的时机进行代码重构，时刻保证和提高代码的质量