Java 设计模式——模板方法模式

1.概述

（1）在面向对象程序设计过程中，程序员常常会遇到这种情况：设计一个系统时知道了算法所需的关键步骤，而且确定了这些步骤的执行顺序，但某些步骤的具体实现还未知，或者说某些步骤的实现与具体的环境相关。例如，去银行办理业务一般要经过以下 4 个流程：取号、排队、办理具体业务、对银行工作人员进行评分等，其中取号、排队和对银行工作人员进行评分的业务对每个客户是一样的，可以在父类中实现，但是办理具体业务却因人而异，它可能是存款、取款或者转账等，可以延迟到子类中实现。

（2）模板方法模式：定义一个操作中的算法骨架，而将算法的一些步骤延迟到子类中，使得子类可以不改变该算法结构的情况下重定义该算法的某些特定步骤。

2.结构

模板方法 (Template Method) 模式包含以下主要角色：

• 抽象类 (Abstract Class)：负责给出一个算法的轮廓和骨架。它由一个模板方法和若干个基本方法构成。
  • 模板方法： 定义了算法的骨架，按某种顺序调用其包含的基本方法。
  • 基本方法： 是实现算法各个步骤的方法，是模板方法的组成部分。基本方法又可以分为三种：
    - 抽象方法 (Abstract Method)：一个抽象方法由抽象类声明、由其具体子类实现。
    - 具体方法 (Concrete Method)：一个具体方法由一个抽象类或具体类声明并实现，其子类可以进行覆盖也可以直接继承。
    - 钩子方法 (Hook Method)：在抽象类中已经实现，包括用于判断的逻辑方法和需要子类重写的空方法两种。一般钩子方法是用于判断的逻辑方法，这类方法名一般为 isXxx，返回值类型为 boolean 类型。
• 具体子类 (Concrete Class) ：实现抽象类中所定义的抽象方法和钩子方法，它们是一个顶级逻辑的组成步骤。

3.案例实现

【例】炒菜。炒菜的步骤是固定的，分为倒油、热油、倒蔬菜、倒调料品、翻炒等步骤。现通过模板方法模式来用代码模拟。类图如下：

具体实现代码如下：

3.1.抽象类

//抽象类，定义模板方法和基本方法
public abstract class AbstractClass {
    
    //模板方法: 算法的骨架，按某种顺序调用其包含的基本方法
    public final void cookProcess() {
        pourOil();
        heatOil();
        pourVegetable();
        pourSauce();
        fry();
    }
    
    //第一步: 倒油是一样的，所以直接实现
    public void pourOil() {
        System.out.println("倒油");
    }
    
    //第二步: 热油是一样的，所以直接实现
    public void heatOil() {
        System.out.println("热油");
    }
    
    //第三步: 倒蔬菜是不一样的(一个下包菜，一个是下菜心)
    public abstract void pourVegetable();	//抽象方法
    
    //第四步: 倒调味料是不一样
    public abstract void pourSauce();		//抽象方法
    
    //第五步: 翻炒是一样的，所以直接实现
    public void fry(){
        System.out.println("炒啊炒啊炒到熟啊");
    }
}

3.2.具体子类

ConcreteClass_BaoCai.java

//炒包菜类
public class ConcreteClass_BaoCai extends AbstractClass {
    
    public void pourVegetable() {
        System.out.println("下锅的蔬菜是包菜");
    }
    
    public void pourSauce() {
        System.out.println("下锅的酱料是辣椒");
    }
}

ConcreteClass_CaiXin.java

//炒菜心类
public class ConcreteClass_CaiXin extends AbstractClass {
    
    public void pourVegetable() {
        System.out.println("下锅的蔬菜是菜心");
    }
    
    public void pourSauce() {
        System.out.println("下锅的酱料是蒜蓉");
    }
}

3.3.测试

Client.java

public class Client {
    public static void main(String[] args) {
        //炒包菜
        //创建对象
        ConcreteClass_BaoCai baoCai = new ConcreteClass_BaoCai();
        //调用炒菜的功能
        baoCai.cookProcess();
    	
        System.out.println("=====================");
        
        ConcreteClass_CaiXin caiXin = new ConcreteClass_CaiXin();
        caiXin.cookProcess();
    }
}

注意：为防止恶意操作，一般使用 final 来修饰模板方法。

4.优缺点

（1）优点

• 提供了一种简单的扩展和定制算法的方式，通过子类可以灵活地实现算法中的具体步骤，同时保持了算法的整体结构的稳定性。
• 通过抽象父类和具体子类的分离，提高了代码的可维护性和可复用性，减少了重复代码的编写。
• 通过模板方法的设计，可以很好地提供一个固定的算法框架，从而降低了算法的设计和实现的复杂度。

（2）缺点

• 如果模板方法本身需要的改动较多，可能需要修改抽象父类或者大量的子类，导致系统的扩展性变差。
• 如果算法的结构较为复杂，可能会导致父类的设计过于庞大和复杂，难以理解和维护。

5.使用场景

（1）模板方法模式适用于以下场景：

• 算法的结构固定，但是某些具体步骤的实现可能变化：当一个算法的整体结构是固定的，但是其中某些具体步骤的实现可能会有所变化时，可以使用模板方法模式。通过在抽象类中定义算法的骨架，将可变的部分延迟到子类中实现，从而实现算法的灵活扩展和定制。
• 多个类具有相似的行为：当多个类具有相似的行为，但是具体实现又有所不同时，可以使用模板方法模式。通过将这些相似的行为抽象到父类中，子类可以分别实现各自的具体实现，从而提高代码的复用性和可维护性。
• 需要控制算法的执行流程：当需要控制算法的执行流程，确保算法的每个步骤按照特定的顺序进行时，可以使用模板方法模式。通过在抽象类中定义算法的步骤和顺序，确保算法的正确执行，同时允许子类实现具体步骤，以满足特定需求。
• 提供一个框架或工具的扩展点：当提供一个框架或工具，并希望允许用户定制某些行为时，可以使用模板方法模式。通过在框架或工具中定义抽象类和模板方法，用户可以通过继承抽象类并实现具体步骤，来定制框架或工具的行为。

（2）总的来说，模板方法模式适用于具有固定算法结构但可变实现步骤、多个类具有相似行为、需要控制算法执行流程以及需要提供扩展点的场景。该模式可以提高代码的复用性、可维护性和灵活性。

6.JDK 源码解析

6.1.InputStream

InputStream 类就使用了模板方法模式。在 InputStream 类中定义了多个 read() 方法，相关代码如下：

public abstract class InputStream implements Closeable {
	//抽象方法，要求子类必须重写
	public abstract int read() throws IOException;
	
	public int read(byte b[]) throws IOException {
        return read(b, 0, b.length);
    }

	public int read(byte b[], int off, int len) throws IOException {
        if (b == null) {
            throw new NullPointerException();
        } else if (off < 0 || len < 0 || len > b.length - off) {
            throw new IndexOutOfBoundsException();
        } else if (len == 0) {
            return 0;
        }
		//调用了无参的 read() 方法，该方法是每次读取一个字节数据
        int c = read(); 
        if (c == -1) {
            return -1;
        }
        b[off] = (byte)c;

        int i = 1;
        try {
            for (; i < len ; i++) {
                c = read();
                if (c == -1) {
                    break;
                }
                b[off + i] = (byte)c;
            }
        } catch (IOException ee) {
        }
        return i;
    }
}

（1）从上面代码可以看到，无参的 read() 方法是抽象方法，要求子类必须实现。而 read(byte b[]) 方法调用了 read(byte b[], int off, int len) 方法，所以在此处重点看的方法是带三个参数的方法。在该方法中第 18 行、27 行，可以看到调用了无参的抽象的 read() 方法。

（2）总结如下： 在 InputStream 父类中已经定义好了读取一个字节数组数据的方法是每次读取一个字节，并将其存储到数组的第一个索引位置，读取 len 个字节数据。具体如何读取一个字节数据呢？由子类实现。

6.2.AbstractQueuedSynchronizer

同步器 (AbstractQueuedSynchronizer) 的设计是基于模板方法模式的，也就是说，使用者需要继承同步器并重写指定的方法，随后将同步器组合在自定义同步组件的实现中，并调用同步器提供的模板方法，而这些模板方法将会调用使用者重写的方法。举个例子，AQS 中需要重写的方法 tryAcquire：

protected boolean tryAcquire(int arg) {
        throw new UnsupportedOperationException();
}

ReentrantLock 中 NonfairSync（继承自 AQS）会重写该方法为：

protected final boolean tryAcquire(int acquires) {
    return nonfairTryAcquire(acquires);
}

而 AQS 中的模板方法 acquire()：

public final void acquire(int arg) {
    if (!tryAcquire(arg) &&
        acquireQueued(addWaiter(Node.EXCLUSIVE), arg))
        selfInterrupt();
}

会调用 tryAcquire 方法，而此时当继承 AQS 的 NonfairSync 调用模板方法 acquire 时就会调用已经被 NonfairSync 重写的 tryAcquire 方法。具体关系如下图所示：