设计模式之--模版模式

模版方法设计模式

在实际开过的过程中，我们常会遇到这中情况，在设计一个业务的时候，我们知道这个业务所需的关键步骤，并且可以确定这些步骤的顺序，但是某些步骤的实现未知，或者具体的实现于环境相关。

举一些实际开发过程中遇到的场景，文件导入，订单审批，银行办理业务的功能。这些都是有一些公共并且必不可少的流程，而且根据业务的不同在某些步骤会有差异

模版方法的定义和特点

模板方法（Template Method）模式的定义如下：定义一个操作中的算法骨架，而将算法的一些步骤延迟到子类中，使得子类可以不改变该算法结构的情况下重定义该算法的某些特定步骤。它是一种类行为型模式。（符合开闭原则）

该模式的主要优点如下：

它封装了不变部分，扩展可变部分。它把认为是不变部分的算法封装到父类中实现，而把可变部分算法由子类继承实现，便于子类继续扩展。
它在父类中提取了公共的部分代码，便于代码复用。
部分方法是由子类实现的，因此子类可以通过扩展方式增加相应的功能，符合开闭原则。

该模式的主要缺点如下：

对每个不同的实现都需要定义一个子类，这会导致类的个数增加，系统更加庞大，设计也更加抽象。
父类中的抽象方法由子类实现，子类执行的结果会影响父类的结果，这导致一种反向的控制结构，它提高了代码阅读的难度。

模版模式的结构和实现

模版方法模式只要是抽象主类和子类之间的协作，它用到了函数的多态性，和“不用调用我，让我来调用你”的反向控制技术（入口为父抽象类）。

1:模版模式结构

抽象类（abstract class）: 负责定义模式的轮廓和结构，由一个抽象方法和若干个基本方法组成
模版方法：定义结构，按照业务结构调用基本方法
基本方法：
抽象方法：在抽象父类中声明，由子类实现
具体方法：在抽象类中实现，在子类可以继承或重写
钩子方法：在抽象类中实现，包括用于判断的逻辑方法和需要子类重写的空方法两种。

2:模版模式代码实现

以文件导入为例。
文件导入有相关以下步骤：

校验文件格式
读取解析文件
校验导入内容
文件内容入库
添加操作日志
其中，1，2，5步骤是每个业务导入必须做的，就是我们所说的关键步骤，3，4是未知步骤（每个业务，每个个文件具体校验，入库不一样），所以，这时我们就可以把1，2，5步骤定义为模版抽象类的基本方法，3，4步骤定义为抽象方法，供子类实现。

大致代码实现：

package com.design.patterns.templatePattern;

public class TemplatePattern {


    public static void main(String[] args) {
        FileInputAbstract fileInputAmerica = new FileInputAmerica();
        fileInputAmerica.templateMethod();
    }
}

package com.design.patterns.templatePattern;

public abstract class FileInputAbstract {
    

    public void templateMethod(){

        checkFile();
        readFile();
        validateFileContect();
        saveFileContent();
        addFileInputLog();

    }

    private void addFileInputLog() {
        System.out.println("5:添加文件导入日志");
    }

    protected abstract void validateFileContect();

    protected abstract void saveFileContent();

    private void readFile() {
        System.out.println("2:读取文件");
    }

    private void checkFile() {
        System.out.println("1:校验文件格式");
    }
}

package com.design.patterns.templatePattern;

public class FileInputAmerica extends FileInputAbstract {

    @Override
    protected void validateFileContect() {
        System.out.println("3:校验导入文件的每一行数据是否符合当前业务规则");
    }

    @Override
    protected void saveFileContent() {
        System.out.println("4:校验过的数据存入特定的表中");
    }
}

运行结果如下：
tomcat-load

模式扩展

当需要控制子类的扩展时，模板方法只在特定点调用钩子操作，这样就只允许在这些点进行扩展。
例如：如果文件导入成功后，需要给特定的人发送通知，这是需要用钩子操作来扩展

package com.design.patterns.templatePattern;

public abstract class FileInputAbstract {
    

    public void templateMethod(){

        checkFile();
        readFile();
        validateFileContect();
        saveFileContent();
        addFileInputLog();
        if(hookMethod()){
            hookMethodImpl();
        };

    }

    protected abstract void hookMethodImpl();

    public boolean hookMethod() {
        //钩子函数默认关闭
        return false;
    }

    private void addFileInputLog() {
        System.out.println("5:添加文件导入日志");
    }

    protected abstract void validateFileContect();

    protected abstract void saveFileContent();

    private void readFile() {
        System.out.println("2:读取文件");
    }

    private void checkFile() {
        System.out.println("1:校验文件格式");
    }
}

package com.design.patterns.templatePattern;

public class FileInputAmerica extends FileInputAbstract {

    //重写父类钩子函数开关
    public boolean hookMethod() {
        System.out.println("开启钩子函数。。。。");
        return true;
    }


    @Override
    protected void hookMethodImpl() {
        System.out.println("6:给客户发送email");
    }

    @Override
    protected void validateFileContect() {
        System.out.println("3:校验导入文件的每一行数据是否符合当前业务规则");
    }

    @Override
    protected void saveFileContent() {
        System.out.println("4:校验过的数据存入特定的表中");
    }
}

运行结果如下：
tomcat-load

如果钩子方法 hookMethod() 和钩子方法 hookMethodImpl() 的代码改变，则程序的运行结果也会改变。