Java设计模式之模板方法模式

4.模板方法模式

如果你有一个任务，在一个星期内制造10万悍马车模型，只考虑最基本的实现，不考虑太多别的问题，你会怎么做？

既然不考虑扩展性，那就好办了，先按照最一般的经验设计类图，如下图所示

非常简单的实现，悍马车有两个型号，H1和H2。按照要求，只需要悍马模型，那就只给悍马模型，先写个抽象类，然后两个不同型号的实现类，通过简单的继承就可以实现业务要求。悍马模型的抽象类代码如下：

    //悍马模型抽象类
    public abstract class HummerModel{
        //模型发动
        protected abstract void start();
        //模型能停止
        protected abstract void stop();
        //模型喇叭会响
        protected abstract void alarm();
        //引擎会响
        protected abstract void engineBoom();
        //模型会跑
        protected abstract void run();
    }

在抽象类中，我们定义了悍马模型必须具有的特性，能发动、停止、喇叭会响，引擎可以轰鸣，而且还可以停止。但是每个型号的悍马实现是不同的，H1型号悍马实现如下：

public class Hummer1Model extends HummerModel {
	@Override
	protected void start() {
        System.out.println("悍马H1发动......");
	}
	@Override
	protected void stop() {
		System.out.println("悍马H1停止......");
	}
	@Override
	protected void alarm() {
		System.out.println("悍马H1鸣笛......");
	}
	@Override
	protected void engineBoom() {
		System.out.println("悍马H1引擎声音是这样的......");
	}
	@Override
	protected void run() {
		//先发动汽车
        this.start();
        //引擎开始轰鸣
        this.engineBoom();
        //跑的过程中遇到一条狗,于是按喇叭
        this.alarm();
        //到达目的地停车
        this.stop();
	}
}

注意看run()方法，这是一个汇总方法，一个模型生产成功了，总要拿给客户检测，run()方法就是一种检验方法，让它跑起来，通过run()方法，把所有功能都测试到了。

H2型号悍马代码如下：

public class Hummer2Model extends HumanModel {
	@Override
	protected void start() {
        System.out.println("悍马H2发动......");
	}
	@Override
	protected void stop() {
		System.out.println("悍马H2停止......");
	}
	@Override
	protected void alarm() {
		System.out.println("悍马H2鸣笛......");
	}
	@Override
	protected void engineBoom() {
		System.out.println("悍马H2引擎声音是这样的......");
	}
	@Override
	protected void run() {
		//先发动汽车
        this.start();
        //引擎开始轰鸣
        this.engineBoom();
        //跑的过程中遇到一条狗,于是按喇叭
        this.alarm();
        //到达目的地停车
        this.stop();
	}
}

程序写到这里，就发现问题了，两个实现类的run()方法都是完全相同的，那这个run()方法的实现应该出现在抽象类，而不是实现类上，抽象是所有子类的共性封装。

注意：在软件开发过程中，如果相同的一段代码复制过两次，就需要对设计产生怀疑，架构师要明确说明为什么相同的逻辑要出现两次或者更多次。

既然发现问题了，那就需要马上改正，修改后的类图如下：

在改正后，在HumerModel中加入了一个run()方法，这个方法是一个实现方法，HumerModel修改后源代码如下：

//悍马模型抽象类
public abstract class HumanModel{
  	//模型发动
  	protected abstract void start();
  	//模型能停止
  	protected abstract void stop();
  	//模型喇叭会响
  	protected abstract void alarm();
  	//引擎会响
  	protected abstract void engineBoom();
  	//模型会跑
  	public final void run(){
        //先发动汽车
        this.start();
        //引擎开始轰鸣
        this.engineBoom();
        //跑的过程中遇到一条狗,于是按喇叭
        this.alarm();
        //到达目的地停车
        this.stop();
    }
}

在抽象的悍马模型上已经定义了run()方法的执行规则，先启动，然后引擎轰鸣，中间还要按一下喇叭，然后停车，他的两个具体实现类就不需要实现run()方法了。

场景类实现的任务就是把生产出的模型展现给客户，其源代码如下：

//场景类
public class Client{
    public static void main(String[] args){
        //需要H1型号的悍马
        HummerModel h1 = new Hummer1Model();
        //h1模型展示
        h1.run();
    }
}

运行结果如下：

悍马H1发动...
悍马H1引擎声音是这样的...
悍马H1鸣笛...
悍马H1停车...

目前客户只要求看H1型号的悍马车，没问题，生产出来，同时可以运行起来给他看看。

看到这个模式，是不是觉得很简单，自己一直在用，是的，我们经常在用，但是你不知道这是模板模式，那些所谓的高手就可以很牛地说：“用模板方法模式就可以实现”，你还要很崇拜地看着，哇，牛人，模板方法模式是什么？这就是模板方法模式。

4.1.模板方法模式的定义

模板方法模式(Template Method Pattern)是如此简单，以致让你感觉到你已经掌握其精髓了。其定义如下：

Define the skeleton of an algorithm in an operation,deferring some steps to subclass.Template Method lets subclass redefine certain steps of an algorithm without changing the algorithm’s structure(定义一个操作中的算法的框架，而将一些步骤延迟到子类中，使得子类可以不改变一个算法的结构即可重定义该算法的某些特定步骤)

模板方法模式的通用类图如下：

模板方法模式确实非常简单，仅仅使用了Java的继承机制，但它是一个应用非常广泛的模式。其中，AbstractClass叫做抽象模板，它的方法分为两类：

基本方法：

基本方法也叫作基本操作，是由子类实现的方法，并且在模板方法被调用。

模板方法：

可以是一个或多个，一般是一个具体方法，也就是一个框架，实现对基本方法的调度，完成固定的逻辑。

注意：为了防止恶意操作，一般模板方法都加上final关键字，不允许被覆写。

在类图中还有一个角色：具体模板。ConcreteClass1和ConcreteClass2属于具体模板，实现父类所定义的一个或多个抽象方法，也就是父类定义的基本方法在子类中得以实现。

AbstractClass代码如下：

//抽象模板类
public abstract class AbstractClass{
    //基本方法
    protected abstract void doSomething();
    //基本方法
    protected abstract void doAnything();
    //模板方法
    public final void templateMethod(){
        //调用基本方法，完成相关逻辑
        this.doSomething();
        this.doAnything();
    } 
}

具体模板代码如下：

public class ConcreteClass1 extends AbstractClass{
    //实现基本方法
    protected void doAnything(){
        //业务逻辑处理
    }
    protected void doSomething(){
        //业务逻辑处理
    }
}

public class ConcreteClass2 extends AbstractClass{
    //实现基本方法
    protected void doAnything(){
        //业务逻辑处理
    }
    protected void doSomething(){
        //业务逻辑处理
    }
}

场景类代码如下：

//场景类
public class Client{
    public static void main(String[] args){
        AbstractClass class1 = new ConcreteClass1();
        AbstractClass class2 = new ConcreteClass2();
        //调用模板方法
        class1.templateMethod();
        class2.templateMethod();
    }
}

注意：抽象模板中的基本方法尽量设计为protected类型，符合迪米特法则，不需要暴露的属性或方法尽量不要设置为protected类型。实现类若非必要，尽量不要扩大父类中的访问权限.

4.2.模板方法模式的应用场景

1.多个子类有共有的方法，并且逻辑基本相同时。

2.重要、复杂的算法，可以把核心算法设计为模板方法，周边的相关细节功能则又各个子类实现。

3.重构是，模板方法模式是一个经常使用的模式，把相同的代码抽取到父类中，然后通过钩子函数(“见模板方法模式的扩展”)约束其行为

4.3.模板方法模式的优点

封装不变的部分，扩展可变的部分

把认为不变的部分的算法封装到父类实现，而可变部分的则可以通过继承来继续扩展。在悍马模型例子中，就非常容易扩展，例如增加一个H3型号的悍马模型，很容易实现，添加一个子类，实现父类的基本方法就可以了。

提取公共部分代码，便于维护

在刚才的例子中就是最好的证明，如果我们不抽取到父类中，任由这种散乱的代码发生，后果就是当维护人员为了修正一个缺陷，需要到处查找类似的代码。

行为由父类控制，子类

基本方法是由子类实现的，因此子类可以通过扩展的方式增加相应的功能，符合开闭原则。

4.4.模板方法模式的缺点

按照我们的设计习惯，抽象类负责声明最抽象、最一般的事物属性和方法，实现类完成具体的事物属性和方法。但模板方法却颠倒了，抽象类定义了部分抽象方法，由子类实现，子类执行的结果影响了父类的结果，也就是子类对父类产生了影响，这在复杂的项目中，会带来代码阅读的难度，而且也会让新手产生不适感。

4.5.模板方法模式的扩展

如果有一天，客户提出H1型号的悍马喇叭想让它响它就响，H2型号的喇叭不要有声音。

解决方法如下，先画出类图，如下图：

类图改动似乎很小，在抽象类HummerModel中添加了一个实现方法isAlarm，确定各个型号的悍马是否需要声音，由于各个实现类覆写该方法，同时其他的基本方法由于不需要对外提供访问，因此也设计为protected类型，其源代码如下：

//悍马模型抽象类
public abstract class HumanModel{
  	//模型发动
  	protected abstract void start();
  	//模型能停止
  	protected abstract void stop();
  	//模型喇叭会响
  	protected abstract void alarm();
  	//引擎会响
  	protected abstract void engineBoom();
  	//模型会跑
  	public final void run(){
        //先发动汽车
        this.start();
        //引擎开始轰鸣
        this.engineBoom();
        //喇叭想让它响就响
        if(this.isAlarm()){
        	this.alarm();
        }
        //到达目的地停车
        this.stop();
    }
    //钩子方法，默认喇叭是会响得。
    protected boolean isAlarm(){
        return true;
    }
}

在抽象类中，isAlarm()是一个实现方法。其作用是模板方法根据其返回值决定是否要响喇叭，子类可以覆写该返回值，由于H1型号的喇叭是想让它响就响，不想让它响就不响，由人控制，其源码如下：

public class Hummer1Model extends HummerModel {
    //要响喇叭
    private boolean alarmFlag = true;
	@Override
	protected void start() {
        System.out.println("悍马H1发动......");
	}
	@Override
	protected void stop() {
		System.out.println("悍马H1停止......");
	}
	@Override
	protected void alarm() {
		System.out.println("悍马H1鸣笛......");
	}
	@Override
	protected void engineBoom() {
		System.out.println("悍马H1引擎声音是这样的......");
	}
    @Override
	protected Boolean isAlarm() {
		return this.alarmFlag;
	}
    //要不要响喇叭，是由客户来决定的
    public void setAlarm(boolean isAlarm){
        this.alarmFlag = isAlarm;
    }
}

只要调用H1型号的悍马，默认是有喇叭响的，也可以通过isAlarm(false)就可以实现，H2型号的悍马是没有喇叭响的，其代码如下：

public class Hummer2Model extends HummerModel {
	@Override
	protected void start() {
        System.out.println("悍马H1发动......");
	}
	@Override
	protected void stop() {
		System.out.println("悍马H1停止......");
	}
	@Override
	protected void alarm() {
		System.out.println("悍马H1鸣笛......");
	}
	@Override
	protected void engineBoom() {
		System.out.println("悍马H1引擎声音是这样的......");
	}
    @Override
	protected Boolean isAlarm() {
		return false;
	}
}

场景类代码如下：

//扩展后的场景类
public class Client{
    public static void main(String[] args){
        System.out.println("-------H1型号悍马--------");
        System.out.println("H1型号的悍马是否需要喇叭声响？ 0-不需要 1-需要");
	    String type=(new BufferedReader(new InputStreamReader(System.in))).r
		HummerH1Model h1 = new HummerH1Model();
         	if(type.equals("0")){
				h1.setAlarm(false);
			}
        h1.run();
		System.out.println("\n-------H2型号悍马--------");
		HummerH2Model h2 = new HummerH2Model();
		h2.run();
    }
}

运行是需要交互的， 首先， 要求输入H1型号的悍马是否有声音， 如下所示：

-------H1型号悍马--------
H1型号的悍马是否需要喇叭声响？ 0-不需要 1-需要
输入“0”后的运行结果如下所示：
-------H1型号悍马--------
H1型号的悍马是否需要喇叭声响？ 0-不需要 1-需要
0 
悍马H1发动...
悍马H1引擎声音是这样的...
悍马H1停车...
-------H2型号悍马--------
悍马H2发动...
悍马H2引擎声音是这样的...
悍马H2停车...
输入“1”后的运行结果如下所示：
-------H1型号悍马--------
H1型号的悍马是否需要喇叭声响？ 0-不需要 1-需要
1 
悍马H1发动...
悍马H1引擎声音是这样的...悍马H1鸣笛...
悍马H1停车...
-------H2型号悍马--------
悍马H2发动...
悍马H2引擎声音是这样的...
悍马H2停车...

H1型号的悍马是由客户自己控制是否要响喇叭， 也就是说外界条件改变， 影 响到模板方法的执行。 在我们的抽象类中isAlarm的返回值就是影响了模板方法的执行结 果， 该方法就叫做钩子方法（Hook Method） 。 有了钩子方法模板方法模式才算完美， 大家 可以想想， 由子类的一个方法返回值决定公共部分的执行结果， 是不是很有吸引力呀！

模板方法模式就是在模板方法中按照一定的规则和顺序调用基本方法， 具体到前面那个例子， 就是run()方法按照规定的顺序（先调用start()， 然后再调用engineBoom()， 再调用alarm()， 最后调用stop()）调用本类的其他方法， 并且由isAlarm()方法的返回值确定run()中的执行顺序变更。