Java 设计模式 - 生产中的模板方法模式

什么是模板方法模式

模板方法模式（Template Method Pattern）是一种行为设计模式，它定义了一个操作中的算法骨架，而将某些步骤延迟到子类中实现。模板方法使得子类可以在不改变算法结构的情况下，重新定义某些步骤的内容。

这个模式的主要优点在于它封装了不变部分的代码，提供了一个统一的接口来控制变体部分，从而提高了代码的复用性和灵活性。它也遵循了开闭原则，即对扩展开放（子类可以新增功能），对修改封闭（不需要改动父类就能增加新的行为）。

模板方法模式的基本结构包括以下几个部分：

1. 抽象类（Abstract Class）：它定义了一个或多个模板方法，这些模板方法定义了算法的骨架。模板方法可以调用一个或多个抽象操作，这些抽象操作需要由子类实现。
2. 具体子类（Concrete Class）：实现抽象类所声明的抽象操作，这些操作通常是算法中可变的部分。每个具体子类都代表了算法的一个具体实现版本。

实际案例 - 远程虚拟机备份需求

备份分为四步：认证、生成文件夹路径、执行备份、压缩文件。

而远程虚拟机服务器有华为云、腾讯云、阿里云等等，这些服务器的认证、生成文件夹路径、压缩采用的是相同的操作，执行备份有各自的业务逻辑。

可以采用模板方法模式，定义四个方法模板，提高代码可读性、同时方便其他厂家服务器的扩展。

示例代码

备份模板抽象类

public abstract class BackupTemplate {

    public void backup(String host, String username, String password, String charset) {
        check(username, password);
        String backupPath = getBackupPath();
        String fileName = executeBackup(host, username, password, charset, backupPath);
        generateZip(backupPath, fileName);
    }

    void check(String username, String password) {
        try {
            password = EncryptionUtils.decrypt(password);
        } catch (Exception e) {
            throw new BackupException("密码格式不正确");
        }
        boolean b = checkIfExist(username, password);
        if (!b) {
            throw new BackupException("用户名或密码错误");
        }
    }

    String getBackupPath() {
        return "/backup/2022-2-31/";
    }

    /**
     * 抽象方法 留给子类实现
     * 抽象方法可以不止一个，根据业务中，步骤的不同，可以有多个
     */
    abstract String executeBackup(String host, String username, String password, String charset, String backupPath);

    protected void generateZip(String folder, String name) {
        File file = new File(folder);
        File[] files = file.listFiles();
        if (files != null && files.length > 0) {
            File targetZipFile = new File(folder + File.separator + name);
            ZipUtil.zip(targetZipFile, true, files);
        }
    }

}

腾讯云、阿里云等，继承BackupTemplate，并重写拥有各自逻辑的抽象方法

public class BackupTencentCloud extends BackupTemplate {

    @Override
    String executeBackup(String host, String username, String password, String charset, String backupPath) {
        // 腾讯云备份逻辑
        // 返回备份文件名
        return "fileName";
    }

}

public class BackupAliCloud extends BackupTemplate {

    @Override
    String executeBackup(String host, String username, String password, String charset, String backupPath) {
        // 阿里云备份逻辑
        // 返回备份文件名
        return "fileName";
    }

}

调用端

public class Client {

    public void backupTencentCloud(String host, String username, String password, String charset) {
        BackupTemplate backupTemplate = new BackupTencentCloud();
        backupTemplate.backup(host, username, password, charset);
    }

    public void backupAliCloud(String host, String username, String password, String charset) {
        BackupTemplate backupTemplate = new BackupAliCloud();
        backupTemplate.backup(host, username, password, charset);
    }

}

为什么使用模板方法模式？传统方法需要分别定义腾讯云、阿里云等不同厂家服务器的类，并编写四个方法，其中，认证、生成文件夹路径、压缩文件三个方法代码一模一样，造成代码冗余。

如果其中的文件夹路径需要变动，传统做法需要修改所有的类中的getBackupPath()方法，模板方法模式只需要修改模板类。

方便扩展：如果新增华为云服务器，则同样继承BackupTemplate抽象类，实现华为云自己的备份逻辑即可，而不必关心认证、压缩等过程。