设计模式-模板方法模式

模板方法模式

将一些固定流程创建一个模板，比如word模板、ppt模板、简历模板等。
确定大致行为流程，具体行为内容交给实现类来实现。还可以通过钩子方法，在实现类中决定抽象类的执行行为！！！

模板方法模式介绍

定义

定义一个操作中的算法骨架，而将算法的一些步骤延迟到子类中，使得子类可以不改变该算法结构的情况下重定义该算法的某些特定步骤。 它是一种类行为型模式。

优点

• 模板模式定义好了执行顺序，具体的实现交给子类负责，子类无需关心执行顺序
• 套用模板，代码复用
• 反向控制，通过父类调用子类操作，扩展子类添加新的行为！符合开闭原则

应用场景

• 一次性实现一个算法的不变部分，将可变部分交给子类实现
• 各子类中公共的行为需要被提取出来，代码复用
• 控制子类的扩展

模板方法模式结构与实现

顶层抽象模板类中已经决定了方法的执行顺序，但是具体的方法内容可以由子类实现！

结构

抽象类/抽象模板（Abstract Class）:
抽象模板类，负责给出一个算法的轮廓和骨架。它由一个模板方法和若干个基本方法构成。

1. 模板方法：定义了算法的骨架，按某种顺序调用其包含的基本方法。
2. 基本方法：是整个算法中的一个步骤，包含以下几种类型。
   抽象方法：在抽象类中声明，由具体子类实现。
   具体方法：在抽象类中已经实现，在具体子类中可以继承或重写它。
   钩子方法：在抽象类中已经实现，包括用于判断的逻辑方法和需要子类重写的空方法两种。

具体子类/具体实现（Concrete Class） :
具体实现类，实现抽象类中所定义的抽象方法和钩子方法，它们是一个顶级逻辑的一个组成步骤。

模板实现

/**
 * 抽象类
 */
abstract class AbstractClass {
    /**
     * 模板方法
     */
    public void TemplateMethod() {
        specificMethod();
        if (hookMethod()) {
            return;
        }
        abstractMethod1();
        abstractMethod2();
    }

    /**
     * 钩子方法
     * @return 通过钩子方法返回的布尔值决定父类的行为
     */
    protected abstract boolean hookMethod();

    /**
     * 具体方法
     */
    public void specificMethod() {
        System.out.println("抽象类中的具体方法被调用...");
    }

    /**
     * 抽象方法1
     */
    public abstract void abstractMethod1();

    /**
     * 抽象方法2
     */
    public abstract void abstractMethod2();
}

/**
 * 具体子类
 */
class ConcreteClass extends AbstractClass {
    @Override
    protected boolean hookMethod() {
        System.out.println("钩子方法的实现被调用...");
        return false;
    }

    @Override
    public void abstractMethod1() {
        System.out.println("抽象方法1的实现被调用...");
    }

    @Override
    public void abstractMethod2() {
        System.out.println("抽象方法2的实现被调用...");
    }
}

public class TemplateClient {
    public static void main(String[] args) {
        AbstractClass tm = new ConcreteClass();
        tm.TemplateMethod();
    }
}

运行结果

抽象类中的具体方法被调用...
钩子方法的实现被调用...
抽象方法1的实现被调用...
抽象方法2的实现被调用...

示例 力扣题 三数之和

整个题目已经被分工安排，用户只需要实现抽象类完成指定方法的实现即可！

题目

给你一个包含 n 个整数的数组 nums，
判断 nums 中是否存在三个元素 a，b，c ，
使得 a + b + c = 0 ？
请你找出所有和为 0 且不重复的三元组。

	注意：答案中不可以包含重复的三元组。

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * 抽象类
 */
abstract class ThreeNumberAbstract {
    protected List<List<Integer>> res;

    /**
     * 抽象模板方法
     * @param nums
     * @return
     */
    public List<List<Integer>> solution(int[] nums) {
        //特判是否存为无效输入，是则直接返回空的列表
        if (IsInvalidInput(nums)) {
            return new ArrayList<>();
        }
        // 初始化 res
        res = new ArrayList<>();
        //排序数组 res
        sort(nums);
        //最外层进行遍历 O(n^2)
        final int lenI = nums.length - 2;
        for (int i = 0; i < lenI; i++) {
            //去重，避免使用遍历过的数
            if (isUsedNumber(i,nums)) {
                continue;
            }
            //如果当前最外层的数大于0，则不可能三数和为0，直接返回答案即可
            if (hasNoAnyRes(nums[i])) {
                return res;
            }
            //寻找所有两数之和为 -nums[i] 的情况(记得去重)
            int target = -nums[i];
            int l = i + 1, r = nums.length - 1;
            List<List<Integer>> twoNumberList = twoNumber(target, l, r,nums);
            //将两数之和答案拼接 nums[i] 放入res中
            add(twoNumberList,nums[i]);
        }
        return res;
    }

    /**
     * 钩子方法
     *  剪枝，判断是否还需要继续遍历
     * @param num   当前遍历的数
     * @return  确定后续是否一定无解
     */
    protected abstract boolean hasNoAnyRes(int num);

    /**
     * 钩子方法
     *  判断当前遍历的数是否与前一个数相同，注意不能为第一个数！
     * @param i     当下数下标
     * @param nums  排序后的数组
     * @return      是否与前一个数相同
     */
    protected abstract boolean isUsedNumber(int i, int[] nums);

    /**
     * 钩子方法
     *  判断输入的数组是否为非法输入
     *      合法要求：大于等于3个int型整数
     * @param nums  输入的数组
     * @return  输入的数组是否合法
     */
    protected abstract boolean IsInvalidInput(int[] nums);

    /**
     * 具体方法
     * 将两数之和答案拼接 nums[i] 放入res中
     * @param twoNumberList     两数之和集合
     * @param theThreeNumber    需要拼接的第三个数
     */
    private void add(List<List<Integer>>twoNumberList, int theThreeNumber) {
        for (List<Integer> twoNumber : twoNumberList) {
            res.add(Arrays.asList(theThreeNumber,twoNumber.get(0),twoNumber.get(1)));
        }
    }

    /**
     * 具体方法
     *  重写的toString方法
     * @return 输出答案数组
     */
    @Override
    public String toString() {
        if(res.size() == 0) {
            return "[]";
        }
        StringBuilder sb = new StringBuilder();
        sb.append("[\n");
        for(List<Integer> list : res) {
            sb.append("\t[");
            sb.append(list.get(0));
            sb.append(", ");
            sb.append(list.get(1));
            sb.append(", ");
            sb.append(list.get(2));
            sb.append("]\n");
        }
        sb.append("]");
        return sb.toString();
    }

    /**
     * 抽象方法
     *  两数之和
     * @param target    两数之和目标值
     * @param l         最小下标
     * @param r         最大下标
     * @param nums      从小到大排序的有序数组
     * @return 在有序数组（从小到大）nums中，从[l,r]区间中寻找两数之和为target的集合
     */
    protected abstract List<List<Integer>> twoNumber(int target, int l, int r,int[] nums);

    /**
     * 抽象方法
     *  给数组nums按照从小到大排序
     * @param nums 为排序的数组
     */
    protected abstract void sort(int[] nums);
}

class ThreeNumberConcrete extends ThreeNumberAbstract {

    @Override
    protected boolean hasNoAnyRes(int num) {
        return num > 0;
    }

    @Override
    protected boolean isUsedNumber(int i, int[] nums) {
        return i > 0 && nums[i] == nums[i - 1];
    }

    @Override
    protected boolean IsInvalidInput(int[] nums) {
        return nums.length < 3;
    }

    @Override
    protected List<List<Integer>> twoNumber(int target, int l, int r, int[] nums) {
        List<List<Integer>> twoNumberList = new ArrayList<>();
        while (l < r) {
            int v = nums[l] + nums[r];
            if (v < target) {
                l++;
            } else if (v > target) {
                r--;
            } else {
                twoNumberList.add(Arrays.asList(nums[l], nums[r]));
                l++;
                r--;
                //去重操作，避免同一个位置多次使用同一个值
                while (l < r && nums[l] == nums[l - 1]) {
                    l++;
                }
                while (l < r && nums[r] == nums[r + 1]) {
                    r--;
                }
            }
        }
        return twoNumberList;
    }

    @Override
    protected void sort(int[] nums) {
        Arrays.sort(nums);
    }
}

public class ThreeNumberClient {
    public static void main(String[] args) {
        ThreeNumberAbstract threeNumber = new ThreeNumberConcrete();
        threeNumber.solution(new int[]{1,2,3,4,5,6,7,8,9,0,-1,-2,-3,0,0,1,1,-1,-1,5,-5,-2});
        System.out.println(threeNumber.toString());
    }
}

运行结果

[
	[-5, -3, 8]
	[-5, -2, 7]
	[-5, -1, 6]
	[-5, 0, 5]
	[-5, 1, 4]
	[-5, 2, 3]
	[-3, -2, 5]
	[-3, -1, 4]
	[-3, 0, 3]
	[-3, 1, 2]
	[-2, -2, 4]
	[-2, -1, 3]
	[-2, 0, 2]
	[-2, 1, 1]
	[-1, -1, 2]
	[-1, 0, 1]
	[0, 0, 0]
]