设计模式 -- 模版模式

说明： 在模板模式（Template Pattern）中，一个抽象类公开定义了执行它的方法的方式/模板，它的子类可以按需要重写方法实现，但调用将以抽象类中定义的方式进行（属于行为型模式）

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

主要解决： 一些方法通用，却在每一个子类都重新写了这一方法。

何时使用： 有一些通用的方法。

如何解决： 将这些通用算法抽象出来（关键代码在抽象类实现，其他步骤在子类实现）

应用实例： 1）在造房子的时候，地基、走线、水管都一样，只有在建筑的后期才有加壁橱加栅栏等差异。 2）西游记里面菩萨定好的 81 难，这就是一个顶层的逻辑骨架。 3）Spring 中对 Hibernate 的支持，将一些已经定好的方法封装起来，比如开启事务、获取 Session、关闭 Session 等，程序员不重复写那些已经规范好的代码，直接丢一个实体就可以保存。

优点： 1）封装不变部分，扩展可变部分。 2）提取公共代码，便于维护。 3）行为由父类控制，子类实现。

缺点： 每一个不同的实现都需要一个子类来实现，导致类的个数增加，使得系统更加庞大。

使用场景： 1）有多个子类共有的方法，且逻辑相同。 2）重要的、复杂的方法，可以考虑作为模板方法。

注意事项： 为防止恶意操作，一般模板方法都加上 final 关键词。

1. 简单案例

定义一个简单模版类Game，定义了游戏规则，后续子类继承Game类后，只能在Game定义的规则内去实现自己的逻辑

package com.ssm.user.designPattern.templatePattern.easy;

public abstract class Game {

    abstract void initialize();

    abstract void startPlay();

    abstract void endPlay();

    public final void play() {

        //初始化游戏
        initialize();;

        //开始游戏
        startPlay();

        //结束游戏
        endPlay();
    }
}

继承抽象类后，要实现抽象类的抽象方法，只能在父类的定义好的架构中重写方法

package com.ssm.user.designPattern.templatePattern.easy;

public class FootballGame extends Game{
    @Override
    void initialize() {
        System.out.println("FootBall Game initialize");
    }

    @Override
    void startPlay() {
        System.out.println("FootBall Game startPlay");
    }

    @Override
    void endPlay() {
        System.out.println("FootBall Game endPlay");
    }
}

模版设计模式的简单应用

package com.ssm.user.designPattern.templatePattern.easy;

public class TemplatePatternDemo {

    public static void main(String[] args) {
        Game game = new FootballGame();
        game.play();
    }
}

2. 复杂案例

假如我们要写一个商品模块，将一个商品传过来，先要校验入参是否正确，开始执行相关操作，主要逻辑执行完成后，后续还需要做什么操作！

可以将校验入参、执行操作、后续操作都抽成一个Action类！

package com.ssm.user.designPattern.templatePattern.prod;

public interface Action {

    /**
     * 参数校验，可以自定义异常抛出
     */
    void validate();

    /**
     * 执行
     */
    void execute();

    /**
     * 后续
     */
    void after();

}

说明： ApiTemplate类规定Api模板的执行顺序和执行步骤！(Action接口类中无法定义执行顺序及步骤)。

package com.ssm.user.designPattern.templatePattern.prod;

import com.ssm.bean.Result;
import com.ssm.bean.ResultCode;

public class ApiTemplate {

    public void execute(Result result, final Action action) {
        try {
            action.validate();
            action.execute();
            action.after();
            result.setSuccess(true);
            result.setCode(1024);
        } catch (Exception e) {
            result.setSuccess(false);
            result.setCode(ResultCode.ERROR);
        }
    }
}

说明： ApiTemplateDemo类具体调用ApiTemplate的过程

package com.ssm.user.designPattern.templatePattern.prod;

import com.ssm.bean.Result;

public class ApiTemplateDemo {
    public static void main(String[] args) {
        ApiTemplate apiTemplate = new ApiTemplate();
        Result result = Result.ok();
        apiTemplate.execute(result, new Action() {
            @Override
            public void validate() {
                System.out.println("开始校验参数");
            }

            @Override
            public void execute() {
                System.out.println("执行");
            }

            @Override
            public void after() {
                System.out.println("后续执行");
            }
        });

        System.out.println(result);
    }
}