java开发中的代码设计规范

---

1 前序

当你十分纠结新创建的一个类如何命名，或者创建一个方法如何给他起一个比较富有直译的方法名的时候，这个时候，束缚你的并不是你的代码能力，有时候就是你对于代码整体逻辑的设计的能力，而这个能力，是需要你长期的代码编写和代码设计的过程中，慢慢锻造出来的。

每一个人其实都会有这么一个情况，有时候我们在看别人的代码的时候，总是觉得看的逻辑不清晰，看不懂，这并不能说明他的代码写的不好，只是每一个程序员之间的风格不同。

有的人喜欢将一个类的主要功能介绍直接一条一条的写在类的注解javadoc上，有的人喜欢在具体的功能方法点上去一步一步的阐述自己的代码逻辑。
有的人追求的是业务逻辑架构的整体性，连贯性，而有的人是喜欢对于业务逻辑的底层技术进行深入追究，慢慢雕琢，这些对于代码设计的最初的初衷的不同，最后都是会导致代码风格的差异化。

但是，尽管是设计的初衷的不同，但是最终对于代码整体业务逻辑都是相同的，都是能够解决业务需求的。

2 如何写好业务代码？

针对这个问题，知乎直接是开了这么一个话题：
如何写好业务代码
其中阿里云的小伙伴也针对了这个博客进行了一个完整性的回答：
一文教会你如何写复杂业务代码

3 代码整洁之道–读后感

针对于代码设计，有这么一本书是不得不看的。《代码整洁之道》，细细品味，其中的一些设计里面还是很有意义值得借鉴的。

我本来是在阅读代码整洁之道这本书的时候是做了一点思维导向图，但是偶然看了网上有一个思维导向图写的很好，特定拿过来用一下，原图地址：
地址：代码整洁之道读书笔记

3.1 类名

• 在多数其他情况下，单字母名称不是个好选择，读者必须在脑中将它映射为真实概念，仅仅因为有了a和b，就要取名为c，并在并非像样的理由
• 很少有名称是能自我介绍的，反之，你需要用有良好的命名的类，函数或者名称空间来放置名称，给读者提供语境，如果没有这么做，给名称添加前缀就是最好一招了（常用）

4 设计模式

创建型模式：用于描述“怎样创建对象”，它的主要特点是“将对象的创建与使用分离”。GoF 中提供了单例、原型、工厂方法、抽象工厂、建造者等 5 种创建型模式。
结构型模式：用于描述如何将类或对象按某种布局组成更大的结构，GoF 中提供了代理、适配器、桥接、装饰、外观、享元、组合等 7 种结构型模式。
行为型模式：用于描述类或对象之间怎样相互协作共同完成单个对象都无法单独完成的任务，以及怎样分配职责。GoF 中提供了模板方法、策略、命令、职责链、状态、观察者、中介者、迭代器、访问者、备忘录、解释器等 11 种行为型模式

• 单例（Singleton）模式：某个类只能生成一个实例，该类提供了一个全局访问点供外部获取该实例，其拓展是有限多例模式。

单例模式中，区分了对应的饱汉和饿汉的模式，饿汉的模式，故名思意，就是在获取之前就实例化了对应的实例。
常见的单例模式：
饱汉模式（需要通过双重锁校验对应的高性能下的实例唯一）
饿汉模式（不存在这个问题）
枚举法
静态内部类

// 饿汉模式
private static final Instance instnce = new Instance();
private Instance() {}
public static Instance getInstance() {
	return instance;
}

• 原型（Prototype）模式：将一个对象作为原型，通过对其进行复制而克隆出多个和原型类似的新实例。

Object 的 clone方法，理解浅拷贝和深拷贝的含义

• 工厂方法（Factory Method）模式：定义一个用于创建产品的接口，由子类决定生产什么产品。
• 抽象工厂（AbstractFactory）模式：提供一个创建产品族的接口，其每个子类可以生产一系列相关的产品。

BeanFactory

• 建造者（Builder）模式：将一个复杂对象分解成多个相对简单的部分，然后根据不同需要分别创建它们，最后构建成该复杂对象。

对于建造者设计模式，对于我自己的理解，它更像是对于一个多重态（类）创建的一种归纳方式。参考Spring Boot DataSourceBuilder类
https://zhuanlan.zhihu.com/p/58093669

• 代理（Proxy）模式：为某对象提供一种代理以控制对该对象的访问。即客户端通过代理间接地访问该对象，从而限制、增强或修改该对象的一些特性。

动态代理，Proxy, CGLIB

• 适配器（Adapter）模式：将一个类的接口转换成客户希望的另外一个接口，使得原本由于接口不兼容而不能一起工作的那些类能一起工作。

类的适配器模式（使用的是继承的模式），对于接口有一定的污染
对象的适配器模式（使用的是组合，内部持有一个适配类）

• 桥接（Bridge）模式：将抽象与实现分离，使它们可以独立变化。它是用组合关系代替继承关系来实现，从而降低了抽象和实现这两个可变维度的耦合度。

适配器不是使用组合来适配被适配者，而是继承被适配者和实现类

• 装饰（Decorator）模式：动态的给对象增加一些职责，即增加其额外的功 能。

装饰器和代理模式之间的区别：
装饰模式：侧重给一个实现类动态添加功能，不会对实现类的方法进行过滤拦截
代理模式：侧重将一个实现类的功能，委托给代理类来处理，可以对实现类的方法进行 过滤拦截（某种情况下，可能不执行实现类的方法）

/**
 * 定义了一个接口
 */
interface Component {
    void operator();
}

/**
 * 实现（被装饰的对象）
 */
class ConcreteComponent implements Component {

    @Override
    public void operator() {
        System.out.println("拍照功能");
    }
}

/**
 * 增加一个装饰器（抽象方法）
 */
abstract class Decorator implements Component {

    Component component;

    public Decorator(Component component) {
        this.component = component;
    }

    /**
     * 同时，你也可以把对应的抽象方法定义到这里
     */
    @Override
    public void operator() {
        // 执行原始的抽象方法，
        component.operator();
        deepDecorator();
    }

    /**
     * 定义对应的抽象方法，交给子类进行处理，并对原始的方法进行丰富
     */
    public abstract void deepDecorator();
}

/**
 * 第一个装饰器
 */
class ConcreteDecorator1 extends Decorator{


    public ConcreteDecorator1(Component component) {
        super(component);
    }


    @Override
    public void deepDecorator() {
        System.out.println("拍照完之后，增加一个美颜的功能");
    }
}

/**
 * 第二个装饰器
 */
class ConcreteDecorator2 extends Decorator {


    public ConcreteDecorator2(Component component) {
        super(component);
    }

    @Override
    public void deepDecorator() {
        System.out.println("增加一个滤镜的功能");
    }
}

测试：
// 装饰了第一个和第二个
Component component2 = new ConcreteDecorator1(new ConcreteDecorator2(component));
component2.operator();

• 外观（Facade）模式：为多个复杂的子系统提供一个一致的接口，使这些子系统更加容易被访问。
• 享元（Flyweight）模式：运用共享技术来有效地支持大量细粒度对象的复用。

享元模式主要有一下两种概念：
内部状态：即不会随着环境的改变而改变的可共享部分
外部状态，指随环境改变而改变的不可以共享的部分。享元模式的实现要领就是区分应用中的这两种状态，并将外部状态外部化。下面来分析其基本结构和实现方法。

• 组合（Composite）模式：将对象组合成树状层次结构，使用户对单个对象和组合对象具有一致的访问性。
• 模板方法（TemplateMethod）模式：定义一个操作中的算法骨架，而将算法的一些步骤延迟到子类中，使得子类可以不改变该算法结构的情况下重定义该算法的某些特定步骤。
• 策略（Strategy）模式：定义了一系列算法，并将每个算法封装起来，使它们可以相互替换，且算法的改变不会影响使用算法的客户。
• 命令（Command）模式：将一个请求封装为一个对象，使发出请求的责任和执行请求的责任分割开。
  职责链（Chain of Responsibility）模式：把请求从链中的一个对象传到下一个对象，直到请求被响应为止。通过这种方式去除对象之间的耦合。
  状态（State）模式：允许一个对象在其内部状态发生改变时改变其行为能力。
• 观察者（Observer）模式：多个对象间存在一对多关系，当一个对象发生改变时，把这种改变通知给其他多个对象，从而影响其他对象的行为。
  中介者（Mediator）模式：定义一个中介对象来简化原有对象之间的交互关系，降低系统中对象间的耦合度，使原有对象之间不必相互了解。
• 迭代器（Iterator）模式：提供一种方法来顺序访问聚合对象中的一系列数据，而不暴露聚合对象的内部表示。
• 访问者（Visitor）模式：在不改变集合元素的前提下，为一个集合中的每个元素提供多种访问方式，即每个元素有多个访问者对象访问。
• 备忘录（Memento）模式：在不破坏封装性的前提下，获取并保存一个对象的内部状态，以便以后恢复它。
• 解释器（Interpreter）模式：提供如何定义语言的文法，以及对语言句子的解释方法，即解释器。

5 设计原则

5.1 开闭原则

软件实体应当对扩展开放，对修改关闭
这里的软件实体包括以下几个部分：

• 1，项目中划分出的模块
• 2，类与接口
• 3，方法

开闭原则的含义是：当应用的需求改变时，在不修改软件实体的源代码或者二进制代码的前提下，可以扩展模块的功能，使其满足新的需求。

开闭原则的作用：
开闭原则是面向对象程序设计的终极目标，它使软件实体拥有一定的适应性和灵活性的同时具备稳定性和延续性。具体来说，其作用如下。
对软件测试的影响
软件遵守开闭原则的话，软件测试时只需要对扩展的代码进行测试就可以了，因为原有的测试代码仍然能够正常运行。
可以提高代码的可复用性
粒度越小，被复用的可能性就越大；在面向对象的程序设计中，根据原子和抽象编程可以提高代码的可复用性。
可以提高软件的可维护性
遵守开闭原则的软件，其稳定性高和延续性强，从而易于扩展和维护。

开闭原则的实现方法：
抽象约束、封装变化 ：即通过接口或者抽象类为软件实体定义一个相对稳定的抽象层，而将相同的可变因素封装在相同的具体实现类中。因为抽象灵活性好，适应性广，只要抽象的合理，可以基本保持软件架构的稳定，而软件中易变的细节可以从抽象派生来的实现类来进行扩展，当软件需要发生变化时，只需要根据需求重新派生一个实现类来扩展就可以了。

5.2 里氏替换原则

继承必须确保超类所拥有的性质在子类中仍然成立

里氏替换原则主要阐述了有关继承的一些原则也就是什么时候应该使用继承，什么时候不应该使用继承，以及其中蕴含的原理。里氏替换原是继承复用的基础，它反映了基类与子类之间的关系，是对开闭原则的补充，是对实现抽象化的具体步骤的规范。

里氏替换原则的作用

• 1，里氏替换原则是实现开闭原则的重要方式之一。
• 2，它克服了继承中重写父类造成的可复用性变差的缺点。
• 3，它是动作正确性的保障，即类的扩展不会给已有的系统引入新的错误，降低了代码出错的可能性

里氏替换原则通俗来讲就是：子类可以扩展父类的功能，但不能改变父类原有的功能。也就是说：子类继承父类时，除添加新的方法完成新增功能外，尽量不要重写父类的方法。

如果通过重写父类的方法来完成新的功能，这样写起来虽然简单，但是整个继承体系的可复用性会比较差，特别是运用多态比较频繁时，程序运行出错的概率会非常大。

5.3 依赖倒置原则

依赖倒置原则：高层模块不应该依赖底层模块，两者都应该依赖其抽象，抽象不应该依赖细节，细节应该依赖抽象。其核心思想：要面向接口编程，不要面向实现编程，

依赖倒置原则是实现开闭原则的重要途经之一，它降低了客户与实现模块之间的耦合。

由于在软件设计中，细节具有多变性，而抽象层则相对稳定，因此以抽象为基础搭建起来的架构要比以细节为基础搭建起来的架构要稳定得多。这里的抽象指的是接口或者抽象类，而细节是指具体的实现类。

依赖倒置原则的实现方式：
依赖倒置原则的目的是通过要面向接口的编程来降低类间的耦合性，所以我们在实际编程中只要遵循以下4点，就能在项目中满足这个规则。

• 每个类尽量提供接口或抽象类，或者两者都具备。
• 变量的声明类型尽量是接口或者是抽象类。
• 任何类都不应该从具体类派生。
• 使用继承时尽量遵循里氏替换原则。

5.4 单一责任原则

单一责任原则又称为单一功能原则，这里的职责是指类变化的原因，单一职责原则规定一个类应该有且仅有一个引起它变化的原因，否则类应该被拆分

该原则提出对象不应该承担太多职责，如果一个对象承担了太多的职责，至少存在以下两个缺点：

• 1，一个职责的变化可能会削弱或者抑制这个类实现其他职责的能力；
• 2，当客户端需要该对象的某一个职责时，不得不将其他不需要的职责全都包含进来，从而造成冗余代码或代码的浪费。

单一职责原则的优点：
单一职责原则的核心就是控制类的粒度大小、将对象解耦、提高其内聚性。如果遵循单一职责原则将有以下优点。

• 降低类的复杂度。一个类只负责一项职责，其逻辑肯定要比负责多项职责简单得多。
• 提高类的可读性。复杂性降低，自然其可读性会提高。
• 提高系统的可维护性。可读性提高，那自然更容易维护了。
• 变更引起的风险降低。变更是必然的，如果单一职责原则遵守得好，当修改一个功能时，可以显著降低对其他功能的影响。

单一职责原则同样也适用于方法，一个方法应该尽可能做好一件事情，如果一个方法处理的事情太多，其颗粒度会变得很粗，不利用重用。

5.5 接口隔离原则

接口隔离原则要求程序员尽量将臃肿庞大的接口拆分成更小的和更具体的接口，让接口中只包含客户感兴趣的方法。

客户端不应该被迫依赖于它不适用的方法，一个类对另一个类的依赖应该建立在最小的接口上，

以上两个定义的含义是：要为各个类建立它们需要的专用接口，而不要试图去建立一个很庞大的接口供所有依赖它的类去调用。

接口隔离原则和单一职责原则都是为了提高类的内聚性，降低他们之间的耦合性，体现了封装的思想，但两者是不同的：

• 单一职责原则注重的是职责，而接口隔离原则注重的是对接口依赖的隔离。
• 单一职责原则主要是约束类，它针对的是程序中的实现和细节；接口隔离原则主要约束接口，主要针对抽象和程序整体框架的构建。

接口隔离原则的优点：
接口隔离原则是为了约束接口、降低类对接口的依赖性，遵循接口隔离原则有以下 5 个优点。

• 将臃肿庞大的接口分解为多个粒度小的接口，可以预防外来变更的扩散，提高系统的灵活性和可维护性。
• 接口隔离提高了系统的内聚性，减少了对外交互，降低了系统的耦合性。
• 如果接口的粒度大小定义合理，能够保证系统的稳定性；但是，如果定义过小，则会造成接口数量过多，使设计复杂化；如果定义太大，灵活性降低，无法提供定制服务，给整体项目带来无法预料的风险。
• 使用多个专门的接口还能够体现对象的层次，因为可以通过接口的继承，实现对总接口的定义。
• 能减少项目工程中的代码冗余。过大的大接口里面通常放置许多不用的方法，当实现这个接口的时候，被迫设计冗余的代码。

接口隔离原则的实现：
在具体应用接口隔离原则时，应该根据以下几个规则来衡量。

• 接口尽量小，但是要有限度。一个接口只服务于一个子模块或业务逻辑。
• 为依赖接口的类定制服务。只提供调用者需要的方法，屏蔽不需要的方法。
• 了解环境，拒绝盲从。每个项目或产品都有选定的环境因素，环境不同，接口拆分的标准就不同深入了解业务逻辑。
• 提高内聚，减少对外交互。使接口用最少的方法去完成最多的事情。

5.6 迪米特法则

其含义是：如果两个软件实体无需直接通信，那么就不应当发生直接的相互调用，可以通过第三方转发该调用。其目的是降低类之间的耦合度，提高模块的相对独立性。

其定义是:只和你的朋友直接交谈，不和陌生人说话。

迪米特法则中的“朋友”是指：当前对象本身、当前对象的成员对象、当前对象所创建的对象、当前对象的方法参数等，这些对象同当前对象存在关联、聚合或组合关系，可以直接访问这些对象的方法。

迪米特法则的优点
迪米特法则要求限制软件实体之间通信的宽度和深度，正确使用迪米特法则将有以下两个优点。
降低了类之间的耦合度，提高了模块的相对独立性。
由于亲合度降低，从而提高了类的可复用率和系统的扩展性。

迪米特法则的实现方法
它强调两点：

• 1，从依赖者的角度来说，只依赖应该依赖的对象。
• 2，从被依赖者的角度来说，只暴露应该暴露的方法。

所以在运用迪米特法则的时候需要注意以下几点：

• 1，在类的划分上，应该创建弱耦合的类。类与类之间的耦合越弱，就越有利于实现可复用的目标。
• 2，在类的结构设计上，尽量降低类成员的访问权限。
• 3，在类的设计上，优先考虑将一个类设置成不变类。
• 4，在对其他类的引用上，将引用其他对象的次数降到最低。
• 5，不暴露类的属性成员，而应该提供相应的访问器（set 和 get 方法）。
• 6，谨慎使用序列化（Serializable）功能。

5.7 合成复用原则

合成复用原则又称为 组合/聚合 复用原则 它要求在软件复用时，要尽量先使用组合或者聚合等关联关系来实现，其次才考虑使用继承关系来实现。

如果要使用继承关系，则必须严格遵循里氏替换原则。合成复用原则同里氏替换原则相辅相成的，两者都是开闭原则的具体实现规范。

合成复用原则的重要性
通常类的复用分为继承复用和合成复用两种，继承复用虽然有简单和易实现的优点，但它也存在以下缺点

• 1，继承复用破坏了类的封装性。因为继承会将父类的实现细节暴露给子类，父类对子类是透明的，所以这种复用又称为“白箱”复用。
• 2，子类与父类的耦合度高。父类的实现的任何改变都会导致子类的实现发生变化，这不利于类的扩展与维护。
• 3，它限制了复用的灵活性。从父类继承而来的实现是静态的，在编译时已经定义，所以在运行时不可能发生变化。

采用组合或者聚合复用时，可以将已有对象纳入新对象中，使之成为新对象的一部分，新对象可以调用已有对象的功能，它有以下优点。

• 1，它维持了类的封装性。因为成分对象的内部细节是新对象看不见的，所以这种复用又称为“黑箱”复用。
• 2，新旧类之间的耦合度低。这种复用所需的依赖较少，新对象存取成分对象的唯一方法是通过成分对象的接口。
• 3，复用的灵活性高。这种复用可以在运行时动态进行，新对象可以动态地引用与成分对象类型相同的对象。

合成复合原则的实现方式：
合成复用原则是通过将已有的对象纳入新对象中，作为新对象的成员对象来实现的，新对象可以调用已有对象的功能，从而达到复用。

上面的七种设计原则是软件设计必须遵守的原则，各种原则要求的侧重点不同，其中，
开闭原则是总纲，它告诉我们要对扩展开放，对修改关闭；
里氏替换原则告诉我们不要破坏继承体系；
依赖倒置原则告诉我们要面向接口编程；
单一责任原则告诉我们实现类要职责单一；
接口隔离原则告诉我们在设计接口的时候要精简单一；
迪米特法则告诉我们要降低耦合度；
合成复用原则告诉我们要优先使用组合或者聚合关系复用，少用继承关系复用。

6 代码开发规划

原则：
先保证程序的正确性，防止过度工程
过度工程（over-engineering）：在正确可用的代码写出之前就过度的考虑扩展，重用的问题，使得工程过度复杂。

先把眼前的问题解决掉，解决好，再考虑将来的扩展问题。
先写出可用的代码，反复推敲，再考虑是否需要重用的问题。
先写出可用，简单，明显没有bug的代码，再考虑测试的问题。