模板方法

原文地址1

原文地址2

一、模板方法模式的定义

模板方法模式（TemplateMethod Pattern）其定义如下：

Define theskeleton of an algorithm in an operation, deferring some steps to subclasses.Template Method lets subclasses redefine certain steps of an algorithm withoutchanging the algorithm's structure。

定义一个操作中的算法的骨架，而将一些步骤延迟到子类中。使得子类可以不改变一个算法的结构即可重定义该算法的某些特定步骤。

通常我们会遇到这样的一个问题：我们知道一个算法所需的关键步骤，并确定了这些步骤的执行顺序。但是某些步骤的具体实现是未知的，或者说某些步骤的实现与具体的环境相关。模板方法模式把我们不知道具体实现的步骤封装成抽象方法，提供一个按正确顺序调用它们的具体方法(这些具体方法统称为“模板方法”),这样构成一个抽象基类。子类通过继承这个抽象基类去实现各个步骤的抽象方法，而工作流程却由父类控制。

二、引入例子

生产悍马车，悍马车有两个型号，H1和H2，

抽象悍马模型

在抽象类中，我们定义了悍马模型都必须具有的特质：能够启动、停止，喇叭会响，引擎可以轰鸣，

public abstract class HummerModel {public abstract void start();public abstract void stop();public abstract void alarm();public abstract void engineBoom();public abstract void run();}

H1型号悍马模型

public class HummerH1Model extends HummerModel {//H1型号的悍马车鸣笛public void alarm() {System.out.println("悍马H1鸣笛...");}//引擎轰鸣声public void engineBoom() {System.out.println("悍马H1引擎声音是这样在...");}//汽车发动public void start() {System.out.println("悍马H1发动...");}//停车public void stop() {System.out.println("悍马H1停车...");}//开动起来public void run() {//先发动汽车this.start();//引擎开始轰鸣this.engineBoom();//然后就开始跑了，跑的过程中遇到一条狗挡路，就按喇叭this.alarm();//到达目的地就停车this.stop();}}

H2型号悍马模型

public class HummerH2Model extends HummerModel {//H2型号的悍马车鸣笛public void alarm() {System.out.println("悍马H2鸣笛...");}//引擎轰鸣声public void engineBoom() {System.out.println("悍马H2引擎声音是这样在...");}//汽车发动public void start() {System.out.println("悍马H2发动...");}//停车public void stop() {System.out.println("悍马H2停车...");}//开动起来public void run() {//先发动汽车this.start();//引擎开始轰鸣this.engineBoom();//然后就开始跑了，跑的过程中遇到一条狗挡路，就按喇叭this.alarm();//到达目的地就停车this.stop();}}

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

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

应用模板方法修改悍马模型

public abstract class HummerModel {public abstract void start();public abstract void stop();public abstract void alarm();public abstract void engineBoom();public 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 HummerH1Model();//H1模型演示h1.run();}}

三、结构和通用代码

3.1、结构

准备一个抽象类，定义一个操作中的算法的骨架，将一些步骤声明为抽象方法迫使子类去实现。不同的子类可以以不同的方式实现这些抽象方法。模板模式的关键是：子类可以置换掉父类的可变部分，但是子类却不可以改变模板方法所代表的顶级逻辑。

抽象模板

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

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

• 模板方法 可以有一个或几个，一般是一个具体方法，也就是一个骨架，实现对基本方法的调度，完成固定的逻辑。注意为了防止恶意的操作，一般模板方法都加上final关键字，不允许被覆写。

具体模板

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

3.2、通用代码

AbstractClass

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

ConcreteClass1

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

ConcreteClass2

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();}}

四、模板方法模式的应用

1. 模板方法模式的优点

• 封装不变部分，扩展可变部分。

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

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

我们例子中刚刚走过的弯路就是最好的证明，如果我们不抽取到父类中，任由这种散乱的代码发生，想想后果是什么样子？维护人员为了修正一个缺陷，需要到处查找类似的代码！

• 行为控制交由子类来实现。

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

2. 模板方法模式的缺点

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

3. 模板方法模式的使用场景

• 多个子类有公有的方法，并且逻辑基本相同时。
• 重要、复杂的算法，可以把核心算法设计为模板方法，周边的相关细节功能则由各个子类实现。
• 重构时，模板方法模式是一个经常使用的模式，把相同的代码抽取到父类中，然后通过钩子函数（见“模板方法模式的扩展”）约束其行为。

4.板方法模式与对象的封装性

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

五、框架中的应用

模板方法在一些开源框架中应用非常很多，它提供了一个抽象类，然后开源框架写了一堆子类，在《XXX In Action》中就说明了，如果你需要扩展功能，可以继承了这个抽象类，然后覆写protected方法，再然后就是调用一个类似execute方法，就完成你的扩展开发，非常容易扩展的一种模式

（1） JUnit中的TestCase以及它的子类就是一个模板方法模式的例子。在TestCase这个抽象类中将整个测试的流程设置好，比如先执行setup方法初始化测试资源，再运行测试方法，然后再tearDown来释放测试资源。但是我们将在setup、tearDown里面作些什么？谁知道呢？！因此，这些步骤的具体实现都会延迟到子类中去，也就是我们实现的测试类中。

（2） Struts框架控制器的核心类RequestProcess里面的process方法也是采用了经典的模板方法模式，里面定义好了流程的步骤，而步骤里面的很多环节，我们都是可以重写的。

（3）模板方法模式在Servlet中的应用

使用过Servlet的人都清楚，除了要在web.xml做相应的配置外，还需继承一个叫HttpServlet的抽象类。HttpService类提供了一个service()方法，这个方法调用七个do方法中的一个或几个，完成对客户端调用的响应。这些do方法需要由HttpServlet的具体子类提供，因此这是典型的模板方法模式。下面是service()方法的源代码：

protected void service(HttpServletRequest req, HttpServletResponse resp)throws ServletException, IOException {String method = req.getMethod();if (method.equals(METHOD_GET)) {long lastModified = getLastModified(req);if (lastModified == -1) {// servlet doesn't support if-modified-since, no reason// to go through further expensive logicdoGet(req, resp);} else {long ifModifiedSince = req.getDateHeader(HEADER_IFMODSINCE);if (ifModifiedSince < (lastModified / 1000 * 1000)) {// If the servlet mod time is later, call doGet()// Round down to the nearest second for a proper compare// A ifModifiedSince of -1 will always be lessmaybeSetLastModified(resp, lastModified);doGet(req, resp);} else {resp.setStatus(HttpServletResponse.SC_NOT_MODIFIED);}}} else if (method.equals(METHOD_HEAD)) {long lastModified = getLastModified(req);maybeSetLastModified(resp, lastModified);doHead(req, resp);} else if (method.equals(METHOD_POST)) {doPost(req, resp);} else if (method.equals(METHOD_PUT)) {doPut(req, resp);        } else if (method.equals(METHOD_DELETE)) {doDelete(req, resp);} else if (method.equals(METHOD_OPTIONS)) {doOptions(req,resp);} else if (method.equals(METHOD_TRACE)) {doTrace(req,resp);} else {//// Note that this means NO servlet supports whatever// method was requested, anywhere on this server.//String errMsg = lStrings.getString("http.method_not_implemented");Object[] errArgs = new Object[1];errArgs[0] = method;errMsg = MessageFormat.format(errMsg, errArgs);resp.sendError(HttpServletResponse.SC_NOT_IMPLEMENTED, errMsg);}}

下面给出一个简单的Servlet例子：TestServlet类是HttpServlet类的子类，并且置换掉了父类的两个方法：doGet()和doPost()。

public class TestServlet extends HttpServlet {public void doGet(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {System.out.println("using the GET method");}public void doPost(HttpServletRequest request, HttpServletResponse response)throws ServletException, IOException {System.out.println("using the POST method");}}

从上面的例子可以看出这是一个典型的模板方法模式。

　　HttpServlet担任抽象模板角色

　　　　模板方法：由service()方法担任。

　　　　基本方法：由doPost()、doGet()等方法担任。

　　TestServlet担任具体模板角色

　　　　TestServlet置换掉了父类HttpServlet中七个基本方法中的其中两个，分别是doGet()和doPost()。

六、带钩子函数的模板方法的引入

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

类图似乎改动很小，在抽象类HummerModel中增加了一个实现方法isAlarm，确定各个型号的悍马是否需要声音，由各个实现类覆写该方法，

修改后的悍马模型

public abstract class HummerModel {protected abstract void start();protected abstract void stop();protected abstract void alarm();protected abstract void engineBoom();final public void run() {// 先发动汽车this.start();// 引擎开始轰鸣this.engineBoom();// 要让它叫的就是就叫，喇嘛不想让它响就不响if (this.isAlarm()) {this.alarm();}// 到达目的地就停车this.stop();}// 钩子方法，默认喇叭是会响的protected boolean isAlarm() {return true;}}

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

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

H2型号的悍马是没有喇叭声响的

public class HummerH2Model extends HummerModel {protected void alarm() {System.out.println("悍马H2鸣笛...");}protected void engineBoom() {System.out.println("悍马H2引擎声音是这样在...");}protected void start() {System.out.println("悍马H2发动...");}protected void stop() {System.out.println("悍马H2停车...");}//默认没有喇叭的protected boolean isAlarm() {return false;}}

Client

public class Client {public static void main(String[] args) throws IOException {System.out.println("-------H1型号悍马--------");System.out.println("H1型号的悍马是否需要喇叭声响？0-不需要 1-需要");String type = (new BufferedReader(new InputStreamReader(System.in))).readLine();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型号的悍马是由客户自己控制是否要响喇叭，也就是说外界条件改变，影响到模板方法的执行，在我们的抽象类中isAlarm的返回值就是影响了模板方法的执行结果，该方法就叫做钩子方法(Hook Method)，有了钩子方法模板方法模式才算完美，大家可以想想，由子类的一个方法返回值决定决定公共部分的执行结果。

七、带钩子函数的模板方法的代码框架

这里涉及到两个角色：

抽象模板(Abstract Template)角色有如下责任：

　■定义了一个或多个抽象操作，以便让子类实现。这些抽象操作叫做基本操作，它们是一个顶级逻辑的组成步骤。

　■定义并实现了一个模板方法。这个模板方法一般是一个具体方法，它给出了一个顶级逻辑的骨架，而逻辑的组成步骤在相应的抽象操作中，推迟到子类实现。顶级逻辑也有可能调用一些具体方法。

具体模板(Concrete Template)角色又如下责任：

　■实现父类所定义的一个或多个抽象方法，它们是一个顶级逻辑的组成步骤。

■每一个抽象模板角色都可以有任意多个具体模板角色与之对应，而每一个具体模板角色都可以给出这些抽象方法（也就是顶级逻辑的组成步骤）的不同实现，从而使得顶级逻辑的实现各不相同。

抽象模板角色类，abstractMethod()、hookMethod()等基本方法是顶级逻辑的组成步骤，这个顶级逻辑由templateMethod()方法代表。

public abstract class AbstractTemplate {/*** 模板方法*/public void templateMethod(){//调用基本方法abstractMethod();hookMethod();concreteMethod();}/*** 基本方法的声明（由子类实现）*/protected abstract void abstractMethod();/*** 基本方法(空方法)*/protected void hookMethod(){}/*** 基本方法（已经实现）*/private final void concreteMethod(){//业务相关的代码}
}

具体模板角色类，实现了父类所声明的基本方法，abstractMethod()方法所代表的就是强制子类实现的剩余逻辑，而hookMethod()方法是可选择实现的逻辑，不是必须实现的。

public class ConcreteTemplate extends AbstractTemplate{//基本方法的实现@Overridepublic void abstractMethod() {//业务相关的代码}//重写父类的方法@Overridepublic void hookMethod() {//业务相关的代码}
}

模板模式的关键是：子类可以置换掉父类的可变部分，但是子类却不可以改变模板方法所代表的顶级逻辑。

　　每当定义一个新的子类时，不要按照控制流程的思路去想，而应当按照“责任”的思路去想。换言之，应当考虑哪些操作是必须置换掉的，哪些操作是可以置换掉的，以及哪些操作是不可以置换掉的。使用模板模式可以使这些责任变得清晰。

模板方法模式中的方法

　　模板方法中的方法可以分为两大类：模板方法和基本方法。

模板方法

　　一个模板方法是定义在抽象类中的，把基本操作方法组合在一起形成一个总算法或一个总行为的方法。

　　一个抽象类可以有任意多个模板方法，而不限于一个。每一个模板方法都可以调用任意多个具体方法。

基本方法

基本方法又可以分为三种：抽象方法(Abstract Method)、具体方法(Concrete Method)和钩子方法(Hook Method)。

　　●抽象方法：一个抽象方法由抽象类声明，由具体子类实现。在Java语言里抽象方法以abstract关键字标示。

　　●具体方法：一个具体方法由抽象类声明并实现，而子类并不实现或置换。

　　●钩子方法：一个钩子方法由抽象类声明并实现，而子类会加以扩展。通常抽象类给出的实现是一个空实现，作为方法的默认实现。

　　在上面的例子中，AbstractTemplate是一个抽象类，它带有三个方法。其中abstractMethod()是一个抽象方法，它由抽象类声明为抽象方法，并由子类实现；hookMethod()是一个钩子方法，它由抽象类声明并提供默认实现，并且由子类置换掉。concreteMethod()是一个具体方法，它由抽象类声明并实现。

　　默认钩子方法

　　一个钩子方法常常由抽象类给出一个空实现作为此方法的默认实现。这种空的钩子方法叫做“Do Nothing Hook”。显然，这种默认钩子方法在缺省适配模式里面已经见过了，一个缺省适配模式讲的是一个类为一个接口提供一个默认的空实现，从而使得缺省适配类的子类不必像实现接口那样必须给出所有方法的实现，因为通常一个具体类并不需要所有的方法。

　　命名规则

　　命名规则是设计师之间赖以沟通的管道之一，使用恰当的命名规则可以帮助不同设计师之间的沟通。钩子方法的名字应当以do开始，这是熟悉设计模式的Java开发人员的标准做法。在上面的例子中，钩子方法hookMethod()应当以do开头；在HttpServlet类中，也遵从这一命名规则，如doGet()、doPost()等方法。