You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

251 lines
14 KiB
Markdown

2 years ago
# 11丨软件设计的开闭原则如何不修改代码却能实现需求变更
我在上篇文章讲到,软件设计应该为需求变更而设计,应该能够灵活、快速地满足需求变更的要求。优秀的程序员也应该欢迎需求变更,因为持续的需求变更意味着自己开发的软件保持活力,同时也意味着自己为需求变更而进行的设计有了用武之地,这样的话,技术和业务都进入了良性循环。
但是需求变更就意味着原来开发的功能需要改变,也意味着程序需要改变。如果是通过修改程序代码实现需求变更,那么代码一定会在不断修改的过程中变得面目全非,这也意味着代码的腐坏。
有没有办法不修改代码却能实现需求变更呢?
这个要求听起来有点玄幻,事实上却是软件设计需要遵循的最基本的原则:开闭原则。
## 开闭原则
开闭原则说:**软件实体(模块、类、函数等等)应该对扩展是开放的,对修改是关闭的**。
对扩展是开放的,意味着软件实体的行为是可扩展的,当需求变更的时候,可以对模块进行扩展,使其满足需求变更的要求。
对修改是关闭的,意味着当对软件实体进行扩展的时候,不需要改动当前的软件实体;不需要修改代码;对于已经完成的类文件不需要重新编辑;对于已经编译打包好的模块,不需要再重新编译。
通俗的说就是,**软件功能可以扩展,但是软件实体不可以被修改**。
功能要扩展,软件又不能修改,似乎是自相矛盾的,怎样才能做到不修改代码和模块,却能实现需求变更呢?
## 一个违反开闭原则的例子
在开始讨论前,让我们先看一个反面的例子。
假设我们需要设计一个可以通过按钮拨号的电话,核心对象是按钮和拨号器。那么简单的设计可能是这样的:
![](https://static001.geekbang.org/resource/image/5f/b4/5f91ab1ced961a153852186a76e1e9b4.jpg)
按钮类关联一个拨号器类,当按钮按下的时候,调用拨号器相关的方法。代码是这样的:
```
public class Button {
public final static int SEND_BUTTON = -99;
private Dialer dialer;
private int token;
public Button(int token, Dialer dialer) {
this.token = token;
this.dialer = dialer;
}
public void press() {
switch (token) {
case 0:
case 1:
case 2:
case 3:
case 4:
case 5:
case 6:
case 7:
case 8:
case 9:
dialer.enterDigit(token);
break;
case SEND_BUTTON:
dialer.dial();
break;
default:
throw new UnsupportedOperationException("unknown button pressed: token=" + token);
}
}
}
```
```
public class Dialer {
public void enterDigit(int digit) {
System.out.println("enter digit: " + digit);
}
public void dial() {
System.out.println("dialing...");
}
}
```
按钮在创建的时候可以创建数字按钮或者发送按钮执行按钮的press()方法的时候会调用拨号器Dialer的相关方法。这个代码能够正常运行完成需求设计似乎也没什么问题。
这样的代码我们司空见惯,但是它的设计违反了开闭原则:当我们想要增加按钮类型的时候,比如,当我们需要按钮支持星号(\*)和井号(#的时候我们必须修改Button类代码当我们想要用这个按钮控制一个密码锁而不是拨号器的时候因为按钮关联了拨号器所以依然要修改Button类代码当我们想要按钮控制多个设备的时候还是要修改Button类代码。
似乎对Button类做任何的功能扩展都要修改Button类这显然违反了开闭原则对功能扩展是开放的对代码修改是关闭的。
违反开闭原则的后果是这个Button类非常僵硬当我们想要进行任何需求变更的时候都必须要修改代码。同时我们需要注意大段的switch/case语句是非常脆弱的当需要增加新的按钮类型的时候需要非常谨慎地在这段代码中找到合适的位置稍不小心就可能出现bug。粗暴一点说**当我们在代码中看到else或者switch/case关键字的时候基本可以判断违反开闭原则了**。
而且这个Button类也是难以复用的Button类强耦合了一个Dialer类在脆弱的switch/case代码段耦合调用了Dialer的方法即使Button类自身也将各种按钮类型耦合在一起当我想复用这个Button类的时候不管我需不需要一个Send按钮Button类都自带了这个功能。
所以这样的设计不要说不修改代码就能实现功能扩展即使我们想修改代码进行功能扩展里面也很脆弱稍不留心就掉到坑里了。这个时候你再回头审视Button的设计是不是就感觉到了代码里面腐坏的味道如果让你接手维护这些代码实现需求变更是不是头疼难受
很多设计开始看并没有什么问题,如果软件开发出来永远也不需要修改,也许怎么设计都可以,但是当需求变更来的时候,就会发现各种僵硬、脆弱。所以设计的优劣需要放入需求变更的场景中考察。当需求变更时发现当前设计的腐坏,就要及时进行重构,保持设计的强壮和代码的干净。
## 使用策略模式实现开闭原则
设计模式中很多模式其实都是用来解决软件的扩展性问题的,也是符合开闭原则的。我们用**策略模式**对上面的例子重新进行设计。
![](https://static001.geekbang.org/resource/image/6y/f1/6yy9acfbacbe2bdae7d5a9111ea7cdf1.jpg)
我们在Button和Dialer之间增加了一个抽象接口ButtonServerButton依赖ButtonServer而Dialer实现ButtonServer。
当Button按下的时候就调用ButtonServer的buttonPressed方法事实上是调用Dialer实现的buttonPressed方法这样既完成了Button按下的时候执行Dialer方法的需求又不会使Button依赖Dialer。Button可以扩展复用到其他需要使用Button的场景任何实现ButtonServer的类比如密码锁都可以使用Button而不需要对Button代码进行任何修改。
而且Button也不需要switch/case代码段去判断当前按钮类型只需要将按钮类型token传递给ButtonServer就可以了这样增加新的按钮类型的时候就不需要修改Button代码了。
策略模式是一种行为模式多个策略实现同一个策略接口编程的时候client程序依赖策略接口运行期根据不同上下文向client程序传入不同的策略实现。
在我们这个场景中client程序就是Button策略就是需要用Button控制的目标设备拨号器、密码锁等等ButtonServer就是策略接口。通过使用策略模式我们使Button类实现了开闭原则。
## 使用适配器模式实现开闭原则
Button符合开闭原则了但是Dialer又不符合开闭原则了因为Dialer要实现ButtonServer接口根据参数token决定执行enterDigit方法还是dial方法又需要if/else或者switch/case不符合开闭原则。
那怎么办?
这种情况可以使用**适配器模式**进行设计。适配器模式是一种结构模式,用于将两个不匹配的接口适配起来,使其能够正常工作。
![](https://static001.geekbang.org/resource/image/5c/6e/5c210d3315a5b54e7652a5c3d02fd16e.jpg)
不要由Dialer类直接实现ButtonServer接口而是增加两个适配器DigitButtonDialerAdapter、SendButtonDialerAdapter由适配器实现ButtonServer接口在适配器的buttonPressed方法中调用Dialer的enterDigit方法和dial方法而Dialer类保持不变Dialer类实现开闭原则。
在我们这个场景中Button需要调用的接口是buttonPressed和Dialer的方法不匹配如何在不修改Dialer代码的前提下使Button能够调用Dialer代码就是靠适配器适配器DigitButtonDialerAdapter和SendButtonDialerAdapter实现了ButtonServer接口使Button能够调用自己并在自己的buttonPressed方法中调用Dialer的方法适配了Dialer。
## 使用观察者模式实现开闭原则
通过策略模式和适配器模式我们使Button和Dialer都符合了开闭原则。但是如果要求能够用一个按钮控制多个设备比如按钮按下进行拨号的同时还需要扬声器根据不同按钮发出不同声音将来还需要根据不同按钮点亮不同颜色的灯。按照当前设计可能需要在适配器中调用多个设备增加设备要修改适配器代码又不符合开闭原则了。
怎么办?
这种情况可以用**观察者模式**进行设计:
![](https://static001.geekbang.org/resource/image/2d/a5/2d48d29a74b12d65f102a3b46026eaa5.jpg)
这里ButtonServer被改名为ButtonListener表示这是一个监听者接口其实这个改名不重要仅仅是为了便于识别。因为接口方法buttonPressed不变ButtonListener和ButtonServer本质上是一样的。
重要的是在Button类里增加了成员变量List和成员方法addListener。通过addListener我们可以添加多个需要观察按钮按下事件的监听者实现当按钮需要控制新设备的时候只需要将实现了ButtonListener的设备实现添加到Button的List列表就可以了。
Button代码
```
public class Button {
private List<ButtonListener> listeners;
public Button() {
this.listeners = new LinkedList<ButtonListener>();
}
public void addListener(ButtonListener listener) {
assert listener != null;
listeners.add(listener);
}
public void press() {
for (ButtonListener listener : listeners) {
listener.buttonPressed();
}
}
}
```
Dialer代码和原始设计一样如果我们需要将Button和Dialer组合成一个电话Phone代码如下
```
public class Phone {
private Dialer dialer;
private Button[] digitButtons;
private Button sendButton;
public Phone() {
dialer = new Dialer();
digitButtons = new Button[10];
for (int i = 0; i < digitButtons.length; i++) {
digitButtons[i] = new Button();
final int digit = i;
digitButtons[i].addListener(new ButtonListener() {
public void buttonPressed() {
dialer.enterDigit(digit);
}
});
}
sendButton = new Button();
sendButton.addListener(new ButtonListener() {
public void buttonPressed() {
dialer.dial();
}
});
}
public static void main(String[] args) {
Phone phone = new Phone();
phone.digitButtons[9].press();
phone.digitButtons[1].press();
phone.digitButtons[1].press();
phone.sendButton.press();
}
}
```
观察者模式是一种行为模式,解决一对多的对象依赖关系,将被观察者对象的行为通知到多个观察者,也就是监听者对象。
在我们这个场景中Button是被观察者目标设备拨号器、密码锁等是观察者。被观察者和观察者通过Listener接口解耦合观察者的适配器通过调用被观察者的addListener方法将自己添加到观察列表当观察行为发生时被观察者会逐个遍历Listener List通知观察者。
## 使用模板方法模式实现开闭原则
如果业务要求按下按钮的时候除了控制设备按钮本身还需要执行一些操作完成一些成员变量的状态更改不同按钮类型进行的操作和记录状态各不相同。按照当前设计可能又要在Button的press方法中增加switch/case了。
怎么办?
这种情况可以用**模板方法模式**进行设计:
![](https://static001.geekbang.org/resource/image/d0/d7/d0c8c1379b2e5a7f124d20cf33b956d7.jpg)
在Button类中定义抽象方法onPress具体类型的按钮比如SendButton实现这个方法。Button类中增加抽象方法onPress并在press方法中调用onPress方法
```
abstract void onPress();
public void press() {
onPress();
for (ButtonListener listener : listeners) {
listener.buttonPressed();
}
}
```
所谓模板方法模式,就是在父类中用抽象方法定义计算的骨架和过程,而抽象方法的实现则留在子类中。
在我们这个例子中press方法就是模板press方法除了调用抽象方法onPress还执行通知监听者列表的操作这些抽象方法和具体操作共同构成了模板。而在子类SendButton中实现这个抽象方法在这个方法中修改状态完成自己类型特有的操作这就是模板方法模式。
通过模板方法模式每个子类可以定义自己在press执行时的状态操作无需修改Button类实现了开闭原则。
## 小结
**实现开闭原则的关键是抽象**。当一个模块依赖的是一个抽象接口的时候,就可以随意对这个抽象接口进行扩展,这个时候,不需要对现有代码进行任何修改,利用接口的多态性,通过增加一个新实现该接口的实现类,就能完成需求变更。不同场景进行扩展的方式是不同的,这时候就会产生不同的设计模式,大部分的设计模式都是用来解决扩展的灵活性问题的。
开闭原则可以说是软件设计原则的原则,是软件设计的核心原则,其他的设计原则更偏向技术性,具有技术性的指导意义,而开闭原则是方向性的,在软件设计的过程中,应该时刻以开闭原则指导、审视自己的设计:当需求变更的时候,现在的设计能否不修改代码就可以实现功能的扩展?如果不是,那么就应该进一步使用其他的设计原则和设计模式去重新设计。
更多的设计原则和设计模式,我将在后面陆续讲解。
## 思考题
我在观察者模式小节展示的Phone代码示例中并没有显式定义DigitButtonDialerAdapter和SendButtonDialerAdapter这两个适配器类但它们是存在的。在哪里呢
欢迎在评论区写下你的思考,我会和你一起交流,也欢迎把这篇文章分享给你的朋友或者同事,一起交流一下。