JAVA設計模式之模板方法設計模式

模板模式：在模板模式（Template Pattern）中，一個抽象類公開定義了執行它的方法的方式/模板。它的子類能夠按須要重寫方法實現，但調用將以抽象類中定義的方式進行。這種類型的設計模式屬於行爲型模式。

主要解決：一些方法通用，卻在每個子類都從新寫了這一方法。

什麼時候使用：有一些通用的方法。

如何解決：將這些通用算法抽象出來。

關鍵代碼：在抽象類實現，其餘步驟在子類實現。

應用實例： 一、在造房子的時候，地基、走線、水管都同樣，只有在建築的後期纔有加壁櫥加柵欄等差別。 二、西遊記裏面菩薩定好的 81 難，這就是一個頂層的邏輯骨架。 三、spring 中對 Hibernate 的支持，將一些已經定好的方法封裝起來，好比開啓事務、獲取 Session、關閉 Session 等，程序員不重複寫那些已經規範好的代碼，直接丟一個實體就能夠保存。

優勢： 一、封裝不變部分，擴展可變部分。 二、提取公共代碼，便於維護。 三、行爲由父類控制，子類實現。

缺點：每個不一樣的實現都須要一個子類來實現，致使類的個數增長，使得系統更加龐大。

使用場景： 一、有多個子類共有的方法，且邏輯相同。 二、重要的、複雜的方法，能夠考慮做爲模板方法。

注意事項：爲防止惡意操做，通常模板方法都加上 final 關鍵詞。

核心點：
一、AbstractClass：抽象類，定義並實現一個模板方法。定義了算法的骨架，邏輯組成步驟在相應的抽象操做中，在子類中實現。
二、ConcreteClass：實現父類所定義的一個或多個抽象方法。

廢話很少說，直接上手：
項目背景：聚合支付平臺，涉及到多種支付方式選擇，不一樣的支付會有不一樣的支付回調， 在這裏，各個支付的回調就是咱們共同的行爲！
環境準備：JDK八、springboot2.0.x、idea工具、mysql數據庫...

異步回調流程：
一、報文解析：簽名驗證
二、共同的記錄操做：如日誌記錄
三、根據解析報文，修改支付狀態，返回支付結果

先定義AbstractClass抽象類：

/**
 * 支付回調抽象類
 *
 * @author zhoumin
 * @create 2020-03-18 22:16
 */
public abstract class AbstractPayCallbackTemplate {

    /**
     * 異步回調共同核心骨架
     * @return
     */
    public String asynCallBack(){
        //報文解析：簽名驗證
        Map<String,String> verifySignature = verifySignature();
        //日誌記錄
        addPayLog(verifySignature);
        //判斷是否成功
        String result = verifySignature.get("resultCode");
        //根據解析報文，修改支付狀態，返回支付結果
        return asyncService(verifySignature);

    }

    /**
     * 支付回調驗證參數
     *
     * @return
     */
    protected abstract Map<String, String> verifySignature();


    /**
     * 寫入日誌：共同行爲，不須要定義爲 abstract
     *
     */
    private void addPayLog(Map<String, String> verifySignatureMap) {
        //將記錄添加至日誌表....
        //addLogInfo();
        System.out.println("我把本身寫入日誌.....");
    }

    /**
     * 每一個子類各自實現，處理各自任務
     *
     * @return
     */
    protected abstract String asyncService(Map<String, String> verifySignatureMap);


    /**
     * 子類各自實現成功結果
     *
     * @return
     */
    protected abstract String resultSuccess();

    /**
     * 子類各自實現失敗結果
     *
     * @return
     */
    protected abstract String resultFail();

假設如今有一個阿里支付回調的應用：

/**
 * 支付寶回調實現
 *
 * @author zhoumin
 * @create 2020-03-18 22:45
 */
@Component
public class AliPayCallbackTemplate extends AbstractPayCallbackTemplate {


    /**
     * 支付回調驗證參數
     *
     * @return
     */
    @Override
    protected Map<String, String> verifySignature() {
        //>>>>假設如下爲支付寶回調報文處理>>>>>>>>>>>>>>>>
        System.out.println(" >>>>>解析支付寶據報文.....verifySignature()");
        Map<String, String> verifySignature = new HashMap<>();
        verifySignature.put("receiptAmount", "111");
        verifySignature.put("buyerPayAmount", "110");
        verifySignature.put("tradeStatus", "TRADE_SUCCESS");
        verifySignature.put("tradeNo", "202003182245");
        // 根據狀態設置成功或失敗，成功- code=200
        verifySignature.put("resultCode", "200");
        return verifySignature;

    }

    /**
     * 每一個子類各自實現，處理各自任務
     *
     * @param verifySignatureMap
     * @return
     */
    @Override
    protected String asyncService(Map<String, String> verifySignatureMap) {
        System.out.println(">>>>>處理各自任務，asyncService()verifySignatureMap:" + verifySignatureMap);
        String tradeStatus = verifySignatureMap.get("tradeStatus");
        if (tradeStatus.equals("TRADE_SUCCESS")) {
            String tradeNo = verifySignatureMap.get("tradeNo");
            //找到數據庫對應支付數據，修改狀態等信息
            System.out.println(">>>>流水號爲'"+tradeNo+"'訂單，支付成功，修改訂單狀態爲已經支付...");
        }
        return resultSuccess();

    }

    /**
     * 子類各自實現成功結果
     *
     * @return
     */
    @Override
    protected String resultSuccess() {
        System.out.println(">>>>>>>>>>>>>>成功");
        return "success";
    }

    /**
     * 子類各自實現失敗結果
     *
     * @return
     */
    @Override
    protected String resultFail() {
        System.out.println(">>>>>>>>>>>>>>失敗");
        return "fail";
    }
}

注：其餘如微信、銀聯等，可根據須要增減

定義好以後咱們這裏一樣使用工廠啓動：

/**
 * 建立模板方法對應工廠
 *
 * @author zhoumin
 * @create 2020-03-19 21:30
 */
public class TemplateFactory {

    /**
     * 使用工廠模式獲取模板(根據beanId獲取具體事例）
     * @param templateId
     * @return
     */
    public static AbstractPayCallbackTemplate getPayCallbackTemplate(String templateId){
        AbstractPayCallbackTemplate payCallbackTemplate = (AbstractPayCallbackTemplate) SpringUtils.getBean(templateId);
        return payCallbackTemplate;
    }
}

至此，代碼開發完畢，是否是so easy~~
能夠寫個demo試下是否成功

@RestController
public class TemplateController {

    @RequestMapping("/asynCallBack")
    public String asynCallBack(String templateId){
        AbstractPayCallbackTemplate payCallbackTemplate = TemplateFactory.getPayCallbackTemplate(templateId);
        return payCallbackTemplate.asynCallBack();
    }
}

地址欄輸入url：http://localhost:8080/asynCallBack?templateId=aliPayCallbackTemplate
返回結果：

控制打印信息：

在上面代碼中，如日誌記錄等能夠添加異步處理等優化

/**
     * 寫入日誌：共同行爲，不須要定義爲 abstract
     *
     */
    @Async
    public void addPayLog(Map<String, String> verifySignatureMap) {
        //將記錄添加至日誌表....
        //addLogInfo();
        System.out.println("我把本身寫入日誌.....");
    }

與此同時，啓動類上別忘記使用 @EnableAsync 註解，開啓異步開關。

優勢：經過把共同行爲放在超類，減小了代碼冗餘。利用子類實現算法，方便擴展。經過父類調用子類實現操做，經過子類擴展不一樣的行爲，符合「開閉原則」。
缺點：不一樣的實現都須要定義一個子類，增長子類個數。

那麼策略模式和模板模式有什麼區別呢？
答：策略對應的是不一樣的方法，不一樣的骨架，主要解決多重if；而模板對應的是相同骨架，將不一樣實現交給子類。

在經常使用代碼中，Servlet就是這一模型很好的應用實例，感興趣的能夠本身打開源碼查看，在HttpServlet的service方法中，區分不一樣的請求類型，完成不一樣處理！

完~