设计模式 - 模板方法模式

模板方法模式(Template Method Pattern)

一. 概念

超类中定义一个算法框架流程，允许子类在不修改流程结构的情况下，重写算法的特定步骤

二. 使用场合

1. 扩展某个特定算法步骤，而不是整个算法或者其结构（ 模板方法将整个算法转换为一系列独立的步骤， 以便子类能对其进行扩展， 同时还可让超类中所定义的结构保持完整。）
2. 多个算法类的流程步骤一样，而各个算法实现不同

ps：java使用场合

java.util.AbstractList，java.util.AbstractSet，java.util.AbstractMap中所有非抽象方法

java.io.InputStream，java.io.OutputStream，java.io.Reader，java.io.Writer中所有非抽象方法

三. 优点及缺点

• 优点：
  1. 模板流程规定好，只需实现各自的特定部分
  2. 重复代码可提取到超类
• 缺点：
  1. 由于模板流程规定好，导致个别需求会受限制
  2. 模板方法越多，拓展类时流程复杂，维护困难
  3. 若模板方法允许衍生类重写，可能会破环里氏替换原则

四. 结构图

五. 小试牛刀

5.1 问题

忙碌的一天到了晚上，一顿美味的晚饭是必不可少的，但对于晚饭的菜肴做法步骤都是大致相同，无非买菜，洗菜，做菜

问题抛出：

根据指定的3个步骤中，规范统一步骤方法后，并封装吃晚饭模板方法，并根据不同的饭菜实现不同的做法

5.2 uml

本模板方法UML中，采用了策略模式来进行切换和筛选
策略模式文章：https://blog.youkuaiyun.com/zhangHP_123/article/details/126626492?spm=1001.2014.3001.5501

5.3 代码

⭐️ 依赖

		<dependency>
            <groupId>org.junit.vintage</groupId>
            <artifactId>junit-vintage-engine</artifactId>
            <version>5.7.1</version>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.20</version>
            <scope>provided</scope>
        </dependency>
        <!-- https://mvnrepository.com/artifact/ch.qos.logback/logback-classic -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
        </dependency>

⭐️ DinnerTemplate

晚饭统一模板类：定义做菜步骤，及统一吃晚饭前做菜步骤模板

package com.zhanghp;

import lombok.extern.slf4j.Slf4j;

/**
 * @author zhanghp
 * @date 2022-08-30 10:22
 */
@Slf4j
public abstract class DinnerTemplate {

    /**
     * 菜肴名称
     */
    protected String cuisineName;

    protected abstract boolean shopping();

    protected abstract void wash();

    protected abstract void cook();

    /**
     * 添加final原因:防止衍生类重写该方法，从而破坏里氏替换原则
     */
    public final void eat() {
        if (shopping()) {
            wash();
            cook();
            log.info("今天的晚饭 {} 已做好，准备吃晚饭", this.cuisineName);
        } else {
            log.info(this.cuisineName + "相关食材已卖完！");
        }
    }
}

⭐️ DinnerStrategy

晚饭策略类：便于选择/切换晚饭的菜肴

package com.zhanghp;

/**
 * @author zhanghp
 * @date 2022-08-30 10:49
 */
public class DinnerStrategy {
    private DinnerTemplate dinner;

    public DinnerStrategy(DinnerTemplate dinner) {
        this.dinner = dinner;
    }

    public void eat() {
        dinner.eat();
    }

    public void changeDinner(DinnerTemplate dinner) {
        this.dinner = dinner;
    }
}

⭐️ Dumpling And SpringPancake

菜肴：实现各自的做菜

@Slf4j
public class Dumpling extends DinnerTemplate {

    public Dumpling() {
        this.cuisineName = "饺子";
    }

    @Override
    protected boolean shopping() {
        log.info("<---- shopping start ---->");
        log.info("购买饺子皮...");
        log.info("购买肉...");
        return true;
    }

    @Override
    protected void wash() {
        log.info("<---- washing start ---->");
        log.info("对肉清洗");
    }

    @Override
    protected void cook() {
        log.info("<---- cooking start ---->");
        log.info("剁肉馅");
        log.info("包饺子");
        log.info("蒸饺子");
        log.info("出锅");
    }
}

@Slf4j
public class SpringPancake extends DinnerTemplate {
    public SpringPancake() {
        this.cuisineName = "春饼";
    }

    @Override
    protected boolean shopping() {
        log.info("<---- shopping start ---->");
        log.info("购买春饼");
        log.info("购买相关蔬菜及肉类");
        return true;
    }

    @Override
    protected void wash() {
        log.info("<---- washing start ---->");
        log.info("洗菜，洗肉");
    }

    @Override
    protected void cook() {
        log.info("<---- cooking start ---->");
        log.info("做春饼");
    }
}

5.4 UT测试用例

• 代码

  @Slf4j
  public class App {
      public static void main(String[] args) {
          DinnerStrategy dinner = new DinnerStrategy(new Dumpling());
          dinner.eat();
          log.info("《----- 换菜 -----》");
          dinner.changeDinner(new SpringPancake());
          dinner.eat();
      }
  }
  
  public class DinnerTest {
      @Test
      void dinner(){
          Assertions.assertDoesNotThrow(() -> {App.main(new String[]{});});
      }
  }
  

• 结果输出

  - <---- shopping start ---->
  - 购买饺子皮...
  - 购买肉...
  - <---- washing start ---->
  - 对肉清洗
  - <---- cooking start ---->
  - 剁肉馅
  - 包饺子
  - 蒸饺子
  - 出锅
  - 今天的晚饭 饺子 已做好，准备吃晚饭
  
  - 《----- 换菜 -----》
  
  - <---- shopping start ---->
  - 购买春饼
  - 购买相关蔬菜及肉类
  - <---- washing start ---->
  - 洗菜，洗肉
  - <---- cooking start ---->
  - 做春饼
  - 今天的晚饭 春饼 已做好，准备吃晚饭
  

六. 参考资料及源码地址

1. Refactoring GURU：https://refactoring.guru/design-patterns/template-method
2. iluwater：https://github.com/iluwatar/java-design-patterns/blob/master/template-method/README.md

---

⛵️源码：https://gitee.com/zhp1221/design_pattern/tree/master/lab_05_template_method

---