设计模式-模版方法模式

一、定义

模版方法模式是一种对象行为模式。定义一个抽象类，将部分逻辑以具体方法（算法骨架）及具体构造函数的形式实现，然后声明一些抽象方法迫使子类实现剩余逻辑；不同子类可以以不同方式实现这些抽象方法，从而对剩余的逻辑有不同的实现。

二、优点

1、封装了不变部分，扩展了可变部分，符合开闭原则。
2、提取了公共代码，便于维护。
3、行为由父类控制，子类实现。

三、缺点

每一个不同的实现都需要定义一个子类，后期会导致类的个数增加，系统更加庞大。

四、模式结构与实现

1）模式的结构

抽象处理者（AbstractClass）：定义算法骨架及部分由子类实现的抽象方法。
具体处理者（ConcreteClass）：继承抽象处理者。具体实现抽象处理类中定义的抽象方法。
结构图：

模版方法模式结构图.png

2）模式的实现

//测试类
public class Test {
    public static void main(String[] args) {
        AbstractClass demo=new ConcreteClass1();
        demo.templateMethod();
        demo=new ConcreteClass2();
        demo.templateMethod();
    }
}
//抽象处理者角色
public abstract class AbstractClass {
    protected void templateMethod() {
        operation1();
        operation2();
    }
    abstract void operation1();
    abstract void operation2();
}
//具体处理者角色1
public class ConcreteClass1 extends AbstractClass {
    @Override
    public void operation1() {
        System.out.println("ConcreteClass1执行operation1");
    }
    @Override
    public void operation2() {
        System.out.println("ConcreteClass1执行operation2");
    }
}
//具体处理者角色2
public class ConcreteClass2 extends AbstractClass {
    @Override
    public void operation1() {
        System.out.println("ConcreteClass2执行operation1");
    }
    @Override
    public void operation2() {
        System.out.println("ConcreteClass2执行operation2");
    }
}

运行结果：

ConcreteClass1执行operation1
ConcreteClass1执行operation2
ConcreteClass2执行operation1
ConcreteClass2执行operation2

五、应用场景

1、多个子类共有的方法且处理逻辑基本相同。
2、重要、复杂的算法，可以把核心算法设计为模板方法，周边的相关细节功能则由各个子类实现。
3、重构时，模板方法是一个经常使用的方法，把相同的代码抽取到父类中，然后通过构造函数约束其行为。

六、应用实例

1）需求

用模版方法模式实现泡茶流程和煮咖啡流程

2）分析

泡咖啡流程
1、把水煮沸
2、用沸水冲泡咖啡
3、把咖啡倒进杯子
4、加糖和牛奶

泡茶流程
1、把水煮沸
2、用沸水冲泡茶叶
3、把茶倒进杯子
4、加柠檬

3）设计思路

1、抽象类
定义一个抽象类（CaffeineBeverage），它定义了泡茶（咖啡）的大致流程；实现了将水烧开，将水倒入杯中等部分流程；
2、子类
定义茶类（Tea）、咖啡类（Coffee），它们各自实现了用开水冲泡茶叶（咖啡）；加入调味品等流程。
3、结构图

结构图.jpg

4）程序实现

//测试类
public class Test {
    public static void main(String[] args) {
        CaffeineBeverage demo=new Tea();
        demo.prepareRecipe();
        System.out.println("---------------------");
        demo=new Coffee();
        demo.prepareRecipe();
    }
}
//抽象处理者
public abstract class CaffeineBeverage {
    void prepareRecipe() {
        boilWater();
        brew();
        pourInCup();
        addCondiments();
    }
    abstract void addCondiments();
    abstract void brew();
    public void boilWater() {
        System.out.println("Boiling water");
    }
    public void pourInCup() {
        System.out.println("Pouring into cup");
    }
}
//具体处理者：茶
public class Tea extends CaffeineBeverage {
    @Override
    public void brew() {
        System.out.println("Steeping the tea");
    }
    @Override
    public void addCondiments() {
        System.out.println("Adding Lemon");
    }
}//具体处理者：咖啡
public class Coffee extends CaffeineBeverage {
    @Override
    public void addCondiments() {
        System.out.println("Dripping coffee through filter");
    }
    @Override
    public void brew() {
        System.out.println("Adding Sugar and Milk");
    }
}

程序运行结果如下：

Boiling water
Steeping the tea
Pouring into cup
Adding Lemon
---------------------
Boiling water
Adding Sugar and Milk
Pouring into cup
Dripping coffee through filter

七、模版方法模式在开源项目中的应用

1）Spring MVC
在SringMVC框架里，体现在HttpServletBean，FrameworkServlet，ResourceServlet这3个类中。这三个类的关系如下：

模版方法模式应用.png
其中HttpServletBean是一个抽象类，继承了HttpServlet类，覆写了init方法，init方法实现里面又定义了一个initServletBean方法，但是未做任何实现。两个子类FrameworkServlet、ResourceServlet分别以不同方式实现了该方法。
1、以下是HttpServletBean定义的init方法：

@Override
public final void init() throws ServletException {
    if (logger.isDebugEnabled()) {
        logger.debug("Initializing servlet '" + getServletName() + "'");
    }
    // Set bean properties from init parameters.
    try {
        PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
        BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
        ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
        bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
        initBeanWrapper(bw);
        bw.setPropertyValues(pvs, true);
    }
    catch (BeansException ex) {
        logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
        throw ex;
    }
    // Let subclasses do whatever initialization they like.
    initServletBean();
    if (logger.isDebugEnabled()) {
        logger.debug("Servlet '" + getServletName() + "' configured successfully");
    }
}

initServletBean方法定义如下：

protected void initBeanWrapper(BeanWrapper bw) throws BeansException {}

2、子类FrameworkServlet实现initServletBean方法如下：

@Override
protected final void initServletBean() throws ServletException {
    getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
    if (this.logger.isInfoEnabled()) {
        this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
    }
    long startTime = System.currentTimeMillis();
    try {
        this.webApplicationContext = initWebApplicationContext();
        initFrameworkServlet();
    }
    catch (ServletException ex) {
        this.logger.error("Context initialization failed", ex);
        throw ex;
    }
    catch (RuntimeException ex) {
        this.logger.error("Context initialization failed", ex);
        throw ex;
    }
    if (this.logger.isInfoEnabled()) {
        long elapsedTime = System.currentTimeMillis() - startTime;
        this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
                elapsedTime + " ms");
    }
}

3、子类ResourceServlet实现initServletBean方法如下：

@Override
protected void initServletBean() {
    this.pathMatcher = getPathMatcher();
    this.startupTime = System.currentTimeMillis();
}

2）Spring集成Hibernate对数据库的操作流程
Spring中对 Hibernate 的支持，将一些已经定好的方法封装起来，比如开启事务、获取 Session、关闭 Session 等，程序员不重复写那些已经规范好的代码，直接丢一个实体就可以保存。