模板方法设计模式理论与应用

Posted 2021-09-21 Java鱼仔

本文收录于github和gitee ，里面有我完整的Java系列文章，学习或面试都可以看看

（一）什么是模板方法模式（Template method）

首先了解一下什么是模板，在工厂中指定某一样工具的时候，会先设计一个模子，然后就根据这个模子制造成各种颜色的工具。虽然制造出来的工具可能样式、颜色都不同，但是基本的样子和模子是一模一样。

抽象到编程中，我们设计一个抽象类模板，指定代码的执行流程，后续子类实现各自的代码逻辑，但是执行流程和抽象父类一样，这种设计模式就是模板方法模式。

（二）模板方法模式中的角色

abstractClass:抽象类

抽象类角色就是上面说的模子，该角色中需要定义抽象方法以及方法执行流程，这些抽象方法由concreteClass具体类实现

concreteClass:具体类

具体类需要继承抽象类，并实现抽象类中的抽象方法，这里实现的方法将会在执行流程中被调用。

（三）代码案例

接下来展示Template method的代码案例。在这段代码中，我会先写一个抽象类，内容是打开冰箱放东西的三大步骤；接着写两个具体类，分别是放水果和放大象。

首先是抽象类：AbstractRefrigerator

public abstract class AbstractRefrigerator {
    public abstract void openDoor();
    public abstract void putSomething();
    public abstract void closeDoor();
    public final void execute(){
        openDoor();
        putSomething();
        closeDoor();
    }
}

在抽象类中，定义了三个抽象方法，分别是打开冰箱门、放入一些东西、关上冰箱门。接着定义一个execute模板方法，指定模板的方法执行流程。
创建第一个具体类PutFruit：

public class PutFruit extends AbstractRefrigerator {
    private String fruitName;
    public PutFruit(String fruitName){
        this.fruitName=fruitName;
    }
    @Override
    public void openDoor() {
        System.out.println("打开冰箱门");
    }
    @Override
    public void putSomething() {
        System.out.println("放入"+fruitName);
    }
    @Override
    public void closeDoor() {
        System.out.println("关上冰箱门");
    }
}

在第一个具体类中，继承了统一的抽象类，并实现三个抽象方法。
创建第二个具体类：PutElephant：

public class PutElephant extends AbstractRefrigerator {
    @Override
    public void openDoor() {
        System.out.println("打开冰箱门");
    }
    @Override
    public void putSomething() {
        System.out.println("放入大象");
    }
    @Override
    public void closeDoor() {
        System.out.println("关上冰箱门");
    }
}

最后在main方法中使用两个具体类：

public class Main {
    public static void main(String[] args) {
        AbstractRefrigerator a1=new PutFruit("apple");
        a1.execute();
        AbstractRefrigerator a2=new PutElephant();
        a2.execute();
    }
}

上述每个具体类中都有自己的实现，但是最后执行流程都是按照抽象类中指定的模板规则，这就是模板方法设计模式。

（四）在项目中的应用

我翻了一下目前自己写的项目以及工作中写的项目，发现有一个项目中很巧妙的运用了模板设计模式。因为是工作中的项目，我不会贴代码，讲一下应用场景：

这个项目依赖ES进行数据的查询采集，然后对数据做一些操作加工后返回。这里有一套很规范对模板流程：前置查询参数校验->ES查询->查询后结果处理->封装结果返回。

这里的一套流程就被做成了一个抽象类赋予了默认对实现，并提供了一个模板方法按顺序执行上述步骤。后续有新的接口需求就直接按照这套模板流程来。

（五）模板方法模式在源码中的应用

javax.servlet.http.HttpServlet类的实现就使用了模板方法模式。HttpServlet中定义了doGet、doHead、doPost、doPut、doDelete、doOptions、doTrace等方法，并定义了service这个模板方法：

public abstract class HttpServlet extends GenericServlet {

    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doHead(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doPut(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doDelete(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doOptions(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void doTrace(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //...
    }

    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String method = req.getMethod();
        long lastModified;
        if (method.equals("GET")) {
            lastModified = this.getLastModified(req);
            if (lastModified == -1L) {
                this.doGet(req, resp);
            } else {
                long ifModifiedSince;
                try {
                    ifModifiedSince = req.getDateHeader("If-Modified-Since");
                } catch (IllegalArgumentException var9) {
                    ifModifiedSince = -1L;
                }

                if (ifModifiedSince < lastModified / 1000L * 1000L) {
                    this.maybeSetLastModified(resp, lastModified);
                    this.doGet(req, resp);
                } else {
                    resp.setStatus(304);
                }
            }
        } else if (method.equals("HEAD")) {
            lastModified = this.getLastModified(req);
            this.maybeSetLastModified(resp, lastModified);
            this.doHead(req, resp);
        } else if (method.equals("POST")) {
            this.doPost(req, resp);
        } else if (method.equals("PUT")) {
            this.doPut(req, resp);
        } else if (method.equals("DELETE")) {
            this.doDelete(req, resp);
        } else if (method.equals("OPTIONS")) {
            this.doOptions(req, resp);
        } else if (method.equals("TRACE")) {
            this.doTrace(req, resp);
        } else {
            String errMsg = lStrings.getString("http.method_not_implemented");
            Object[] errArgs = new Object[]{method};
            errMsg = MessageFormat.format(errMsg, errArgs);
            resp.sendError(501, errMsg);
        }

    }
   
}

（六）总结

模板方法设计模式有助于让我们理解抽象类在编程中的含义，其实对很多人而言知道抽象类是什么，但是不理解为什么要使用抽象类。模板方法设计模型就是很好的案例。