深入理解 Java 中的模板模式（Template Pattern）

简介

在软件开发过程中，我们常常会遇到一些相似的业务逻辑，这些逻辑在不同的场景下可能只有部分步骤有所差异。模板模式作为一种行为设计模式，它提供了一种在父类中定义算法框架，而将某些特定步骤的实现延迟到子类中的机制。通过这种方式，我们可以极大地提高代码的复用性，降低代码冗余，使代码结构更加清晰、易于维护。本文将详细介绍 Java 中模板模式的基础概念、使用方法、常见实践以及最佳实践，帮助读者更好地掌握这一设计模式。

模板模式基础概念

模板模式定义了一个操作中的算法骨架，而将一些步骤延迟到子类中。抽象类（模板类）负责定义算法的框架，它包含一系列的方法，其中有些方法是抽象的，需要子类去实现；有些方法可能有默认的实现。具体子类继承抽象模板类，并实现抽象方法，从而完成特定的业务逻辑。

模板模式涉及到以下几个角色： - 抽象模板类（Abstract Template Class）：定义了算法的骨架，包含抽象方法和具体方法。抽象方法需要子类实现，具体方法提供默认实现。 - 具体实现类（Concrete Implementing Class）：继承抽象模板类，实现抽象方法，完成特定的业务逻辑。

使用方法

定义抽象模板类

下面我们通过一个简单的示例来展示如何使用模板模式。假设我们要创建一个制作饮品的程序，不同的饮品制作过程有一些共同的步骤，也有一些特定的步骤。首先定义抽象模板类 DrinkTemplate：

public abstract class DrinkTemplate {

    // 定义制作饮品的算法骨架
    public final void prepareDrink() {
        boilWater();
        brew();
        pourInCup();
        addCondiments();
    }

    // 具体方法，提供默认实现
    protected void boilWater() {
        System.out.println("Boiling water");
    }

    // 抽象方法，需要子类实现
    protected abstract void brew();

    // 具体方法，提供默认实现
    protected void pourInCup() {
        System.out.println("Pouring into cup");
    }

    // 抽象方法，需要子类实现
    protected abstract void addCondiments();
}

在这个抽象模板类中，prepareDrink 方法定义了制作饮品的整体流程，其中 boilWater 和 pourInCup 方法有默认实现，而 brew 和 addCondiments 方法是抽象的，需要子类去实现。

定义具体实现类

接下来定义两个具体的饮品实现类，Coffee 和 Tea：

public class Coffee extends DrinkTemplate {

    @Override
    protected void brew() {
        System.out.println("Brewing coffee");
    }

    @Override
    protected void addCondiments() {
        System.out.println("Adding sugar and milk");
    }
}

public class Tea extends DrinkTemplate {

    @Override
    protected void brew() {
        System.out.println("Steeping tea");
    }

    @Override
    protected void addCondiments() {
        System.out.println("Adding lemon");
    }
}

使用模板模式

最后，我们在客户端代码中使用模板模式：

public class Main {
    public static void main(String[] args) {
        DrinkTemplate coffee = new Coffee();
        coffee.prepareDrink();

        System.out.println();

        DrinkTemplate tea = new Tea();
        tea.prepareDrink();
    }
}

运行上述代码，输出结果如下：

Boiling water
Brewing coffee
Pouring into cup
Adding sugar and milk

Boiling water
Steeping tea
Pouring into cup
Adding lemon

通过这个示例，我们可以看到模板模式如何通过抽象模板类定义算法框架，具体子类实现特定步骤，从而实现代码的复用和扩展。

常见实践

日志记录

在许多应用程序中，日志记录是一个常见的需求。不同的模块可能有不同的日志记录格式和详细程度，但都包含一些基本的步骤，如获取当前时间、记录日志信息等。我们可以使用模板模式来实现日志记录功能。

public abstract class LoggerTemplate {

    public final void log(String message) {
        String timestamp = getTimestamp();
        String formattedMessage = formatMessage(message, timestamp);
        writeToLog(formattedMessage);
    }

    protected abstract String getTimestamp();

    protected abstract String formatMessage(String message, String timestamp);

    protected abstract void writeToLog(String message);
}

public class ConsoleLogger extends LoggerTemplate {

    @Override
    protected String getTimestamp() {
        return java.time.LocalDateTime.now().toString();
    }

    @Override
    protected String formatMessage(String message, String timestamp) {
        return "[" + timestamp + "] " + message;
    }

    @Override
    protected void writeToLog(String message) {
        System.out.println(message);
    }
}

public class FileLogger extends LoggerTemplate {

    @Override
    protected String getTimestamp() {
        return java.time.LocalDateTime.now().toString();
    }

    @Override
    protected String formatMessage(String message, String timestamp) {
        return "[" + timestamp + "] " + message;
    }

    @Override
    protected void writeToLog(String message) {
        // 这里省略文件写入的具体实现
        System.out.println("Writing to file: " + message);
    }
}

数据处理流程

在数据处理的场景中，不同类型的数据可能有不同的处理逻辑，但整体的数据处理流程可能是相似的，如数据读取、数据转换、数据存储等。我们可以使用模板模式来实现数据处理流程。

public abstract class DataProcessorTemplate {

    public final void processData() {
        String data = readData();
        String processedData = transformData(data);
        storeData(processedData);
    }

    protected abstract String readData();

    protected abstract String transformData(String data);

    protected abstract void storeData(String data);
}

public class CSVDataProcessor extends DataProcessorTemplate {

    @Override
    protected String readData() {
        // 这里省略 CSV 数据读取的具体实现
        return "CSV data";
    }

    @Override
    protected String transformData(String data) {
        return data.toUpperCase();
    }

    @Override
    protected void storeData(String data) {
        // 这里省略数据存储的具体实现
        System.out.println("Storing CSV data: " + data);
    }
}

public class JSONDataProcessor extends DataProcessorTemplate {

    @Override
    protected String readData() {
        // 这里省略 JSON 数据读取的具体实现
        return "JSON data";
    }

    @Override
    protected String transformData(String data) {
        return data.toLowerCase();
    }

    @Override
    protected void storeData(String data) {
        // 这里省略数据存储的具体实现
        System.out.println("Storing JSON data: " + data);
    }
}

最佳实践

合理设计抽象模板类

抽象模板类应该定义一个清晰、通用的算法骨架，确保抽象方法和具体方法的职责明确。抽象方法应该尽量少，只包含那些必须由子类实现的特定步骤。具体方法应该提供合理的默认实现，以减少子类的重复代码。

避免过度使用

虽然模板模式可以提高代码复用性，但过度使用可能会导致代码结构复杂，难以理解和维护。在使用模板模式之前，需要仔细评估是否真的有必要使用，确保它能带来显著的好处。

与其他设计模式结合

模板模式可以与其他设计模式结合使用，以发挥更大的作用。例如，与策略模式结合，可以在模板模式的基础上进一步提高算法的灵活性；与工厂模式结合，可以更方便地创建具体实现类。

小结

模板模式是一种强大的行为设计模式，它通过在抽象类中定义算法骨架，将特定步骤的实现延迟到子类，从而提高代码的复用性和可维护性。在实际开发中，我们可以在许多场景下使用模板模式，如日志记录、数据处理流程等。遵循最佳实践，合理设计抽象模板类，避免过度使用，并与其他设计模式结合，可以更好地发挥模板模式的优势，提升软件的质量和开发效率。

参考资料

《设计模式 - 可复用的面向对象软件元素》（Design Patterns - Elements of Reusable Object-Oriented Software）
Oracle Java 官方文档
各种开源项目中的模板模式应用案例