设计模式(三)之模板方法模式

模板模式

概念

1. 在模板模式（Template Pattern）中，一个抽象类公开定义了执行它的方法的方式/模板。它的子类可以按照需求重写方法实现，但调用将以抽象类中定义的方式进行。这种类型的设计模式同策略模式和责任链模式一样，都数据行为型模式。
2. 模板模式相当于根据业务模型为程序定义了一个操作中的算法骨架，而将部分步骤的实现在子类中完成。模板方法模式使得子类可以不改变一个算法的结构即可重新定义该算法的某些特定步骤。

特点

1. 关键代码在抽象类实现，其他步骤在子类实现。
2. AbstractClass：抽象类，定义并实现一个模板方法。这个模板方法定义了算法的骨架，而逻辑的组成步骤在相应的抽象操作中，推迟到子类实现。
3. 子类：可实现父类一个或者多个抽象方法。

使用场景

最常见的就是聚合支付，支付平台类型不同，回调接口不同，但是处理的大致流程相同，因此可以在父类(抽象类)中定义一个大致的算法骨架，特定的事情交给子类去实现。

优缺点

• 优点：

1. 封装不变部分，扩展可变部分。
2. 提取公共代码，易于维护。
3. 行为由父类控制，子类实现。

• 缺点：
  每一个把不同的实现都需要子类来实现，导致细粒度对象增加，使得系统更加庞大。

模式的结构

本文介绍支付宝和微信回调时使用的场景。
请参照该类图(图片来自网络)：

开发步骤

• 创建一个抽象类，主要负责定义算法骨架，负责整个流程的走向，提供抽象的方法由子类根据自身的业务特点去具体实现。

package com.lee.template.service;

import java.util.Map;

/**
 * @author zfl_a
 * @Desc 描述各个支付平台回调处理大致流程。验证签名(不同)，日志收集(相同)，验证签名状态(相同)，根据不同支付结果更新状态(不同)
 * @date 2020/8/12
 * @project springboot_design_pattern
 */
public abstract class AbstractPayCallbackTemplate {

    /**
     * 定义算法骨架。按照此流程执行相关操作
     * @return
     */
    public String asynCallBack() {

        // 验证签名(不同)
        Map<String,String> verifySignature = verifySignature();
        // 日志收集(相同)
        payLog(verifySignature);
        // 验证签名状态(相同)
        String code = verifySignature.get("code");
        if(!"200".equals(code)) {
            return fail();
        }
        // 根据不同支付结果更新状态(不同)
        return asyncPayResult(verifySignature);
    }

    /**
     * 失败结果
     * @return
     */
    protected abstract String fail();

    /**
     * 成功结果
     * @return
     */
    protected abstract String success();

    /**
     * 根据不同状态同步支付状态到数据库
     * @param verifySignature
     * @return
     */
    protected abstract String asyncPayResult(Map<String, String> verifySignature);

    /**
     * 日志收集
     * @param verifySignature
     */
    protected abstract void payLog(Map<String, String> verifySignature);

    /**
     * 获取并验证签名
     * @return
     */
    protected abstract Map<String, String> verifySignature() ;
}

• 创建具体实现类，实现父类抽象出的方法。

  支付宝支付

package com.lee.template.service.impl;

import com.lee.template.service.AbstractPayCallbackTemplate;
import org.springframework.stereotype.Service;

import java.util.HashMap;
import java.util.Map;

/**
 * @author zfl_a
 * @date 2020/8/12
 * @project springboot_design_pattern
 */
@Service
public class AliPayCallbackTemplate extends AbstractPayCallbackTemplate {
    @Override
    protected String fail() {
        return "支付宝支付失败";
    }

    @Override
    protected String success() {
        return "支付宝支付成功";
    }

    @Override
    protected String asyncPayResult(Map<String, String> verifySignature) {

        System.out.println("【支付宝支付】根据支付状态结果同步至数据库");
        //支付状态 1代表支付成功
        String payStatus = verifySignature.get("payStatus");
        if("1".equals(payStatus)) {
            //订单编号
            String orderNumber = verifySignature.get("orderNumber");
            System.out.println("【支付宝支付】支付成功，状态已修改，订单编号为："+orderNumber);
        }
        return success();
    }

    @Override
    protected void payLog(Map<String, String> verifySignature) {
        System.out.println("【支付宝支付】记录操作日志....."+verifySignature);
    }

    @Override
    protected Map<String, String> verifySignature() {

        Map<String,String> verifySignature = new HashMap<>();
        verifySignature.put("code","200");
        //1表示成功
        verifySignature.put("payStatus","1");
        verifySignature.put("orderNumber","202008120002");
        verifySignature.put("price","3999");
        verifySignature.put("desc","一加 8");
        return verifySignature;
    }
}

      微信支付

package com.lee.template.service.impl;

import com.lee.template.service.AbstractPayCallbackTemplate;
import org.springframework.stereotype.Service;

import java.util.HashMap;
import java.util.Map;

/**
 * @author zfl_a
 * @date 2020/8/12
 * @project springboot_design_pattern
 */
@Service
public class WxPayCallbackTemplate extends AbstractPayCallbackTemplate {
    @Override
    protected String fail() {
        return "微信支付失败";
    }

    @Override
    protected String success() {
        return "微信支付成功";
    }

    @Override
    protected String asyncPayResult(Map<String, String> verifySignature) {

        System.out.println("【微信支付】根据支付状态结果同步至数据库");
        //支付状态 1代表支付成功
        String payStatus = verifySignature.get("payStatus");
        if("1".equals(payStatus)) {
            //订单编号
            String orderNumber = verifySignature.get("orderNumber");
            System.out.println("【微信支付】支付成功，状态已修改，订单编号为："+orderNumber);
        }
        return success();
    }

    @Override
    protected void payLog(Map<String, String> verifySignature) {
        System.out.println("【微信支付】记录操作日志...."+verifySignature);
    }

    @Override
    protected Map<String, String> verifySignature() {

        Map<String,String> verifySignature = new HashMap<>();
        verifySignature.put("code","200");
        //1表示成功
        verifySignature.put("payStatus","1");
        verifySignature.put("orderNumber","202008120001");
        verifySignature.put("price","3699");
        verifySignature.put("desc","华为 Nova7 Pro");
        return verifySignature;
    }
}

• 创建模板工厂，使得调用方根据不同的模板id，执行不同的流程。

package com.lee.template.factory;

import com.lee.template.service.AbstractPayCallbackTemplate;
import com.lee.utils.SpringUtils;

/**
 * @author zfl_a
 * @date 2020/8/12
 * @project springboot_design_pattern
 */
public class TemplateFactory {

    public static AbstractPayCallbackTemplate findCallBackTemplate(String templateId){

        AbstractPayCallbackTemplate abstractPayCallbackTemplate = (AbstractPayCallbackTemplate) SpringUtils.getBean(templateId);
        return abstractPayCallbackTemplate ;
    }
}

• 创建测试类

package com.lee.template.controller;

import com.lee.template.factory.TemplateFactory;
import com.lee.template.service.AbstractPayCallbackTemplate;
import org.apache.commons.lang.StringUtils;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author zfl_a
 * @date 2020/8/12
 * @project springboot_design_pattern
 */
@RestController
@RequestMapping("/template")
public class TemplateController {

    /**
     * 回调
     * @param templateId
     * @return
     */
    @GetMapping("/aysnCallBack")
    public String aysnCallBack(String templateId){

        if(StringUtils.isBlank(templateId)) {
            return "请传递支付模板id";
        }
        //从工厂中根据模板ID取出对应的模板
        AbstractPayCallbackTemplate callBackTemplate = TemplateFactory.findCallBackTemplate(templateId);
        return callBackTemplate.asynCallBack();
    }
}

测试结果如下：

• 传递支付宝支付模板id，?templateId=aliPayCallbackTemplate
  

• 传递微信支付模板id，?templateId=wxPayCallbackTemplate
  

所有关于设计模式的代码，都会托管到：设计模式代码，欢迎关注。希望和大家一起共同成长！