重構聚合支付案例教你如何寫出高擴充套件性易讀的程式碼

日落西風又在吹發表於2022-01-06

前言

人間清醒

聚合支付歷史版本程式碼

以下程式碼邏輯為：按照不同的支付方式呼叫不同支付方式的邏輯流程。
痛點：

增加一種支付方式就要加入一個case，違反了開閉原則
程式碼累計在一個類中日積月累越來越沉重，可讀性極差
增加一種支付方式就需要在原來的程式碼上動刀，擴充套件性極低

 /**
     * 舊的支付
     *
     * @param mode  模式
     * @param payVO 支付簽證官
     * @return {@link String}
     */
    @PostMapping("/old/{mode}")
public String oldPay(@PathVariable("mode") String mode, @RequestBody PayVO payVO) {
    switch (mode) {
        case "ALIPAY":
            // 呼叫支付寶支付流程邏輯方法
            break;
        case "WXPAY":
            // 呼叫微信支付流程邏輯方法
            break;
        case "EBANK":
            // 呼叫E支付流程邏輯方法
            break;
        default:
            return "支付方式未找到!";

    }
    return "支付成功!";
}

看邏輯和你寫的程式碼八九不離十吧？
當時你的想法可能是“能實現這個需求就行，擴充套件性是啥？可維護性是啥？關我鳥事”，於是劈里啪啦一千又一千行造就了一個萬行類誕生，根據需求的變更，需求的迭代慢慢的發現自己都改不動萬行類，這時候咋辦？（-v-，程式和人一個能跑就行-。-）；

重構版本聚合支付程式碼

考慮到大部分專案使用了Spring，那咋們今天就用Spring的特性來實現這次重構的需求。

定義支付統一引數DTO

這裡DTO定義兩個引數：

mode: 支付方式,如：支付寶，微信等等；
T: 泛型,定義為泛型主要考慮到不同第三方平臺的支付介面引數不一樣，保證比較好的適配。

/**
 * 支付dto
 *
 * @author wentao.wu
 * @date 2022/01/05
 */
@Data
public class PayDTO<T> implements Serializable {
    /**
     * 模式
     */
    private String mode;
    /**
     * 資料
     */
    private T data;
}

定義支付行為

這裡定義好一個支付行為需要做的事情,方法作用解讀：

befor: 之前需要執行的操作寫著這裡面，比如需要進行payDTO引數轉換，校驗支付行為是否合法等等。
invoke: 執行具體的支付邏輯，比如呼叫微信支付介面進行支付。
errorAfter：invoke方法執行失敗後呼叫，比如支付失敗記錄失敗日誌等。
okAfter：invoke方法執行成功後呼叫，比如支付成功後傳送訊息通知通知使用者支付成功等。

/**
 * 支付服務
 *
 * @author wentao.wu
 * @date 2022/01/04
 */
public interface PayService {
    /**
     * 支付之前
     *
     * @param payDTO 支付dto
     */
    <T> void befor(PayDTO<T> payDTO);

    /**
     * 執行支付
     *
     * @param payDTO 支付dto
     * @return boolean
     */
    <T> boolean invoke(PayDTO<T> payDTO);

    /**
     * 支付失敗後
     *
     * @param payDTO 支付dto
     */
    <T> void errorAfter(PayDTO<T> payDTO);

    /**
     * 支付成功後
     *
     * @param payDTO 支付dto
     */
    <T> void okAfter(PayDTO<T> payDTO);
}

定義支付方式註解

這裡定義註解主要是宣告PayService實現類對應了什麼方式,用來標註在具體的支付方式實現類中。

/**
 * 支付
 *
 * @author wentao.wu
 * @date 2022/01/05
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Pay {
    /**
     * 模式: WXPAY ,ALIPAY.....
     *
     * @return {@link String}
     */
    String mode();
}

定義支付具體邏輯Bean儲存容器

這裡主要是儲存所有PayService的實現類，後續會通過前端引數傳入的支付方式從容器中尋找系統是否支援該支付方式。

/**
 * 支付bean容器
 *
 * @author wentao.wu
 * @date 2022/01/05
 */
public class PayBeanContainer {
    /**
     * bean管理器
     */
    public Map<String, PayService> CONTAINER = new HashMap<>(16);

    /**
     * 新增bean
     *
     * @param mode 支付方式
     * @param bean Bean
     */
    public void addBean(String mode, PayService bean) {
        if (checkBean(mode)) {
            throw new RuntimeException("已存在該業務規則!");
        }
        CONTAINER.put(mode, bean);
    }

    /**
     * 獲取Bean
     *
     * @param mode 支付方式
     * @return {@link PayService}
     */
    public PayService getBean(String mode) {
        if (!checkBean(mode)) {
            throw new RuntimeException("不存在該Bean!");
        }
        return CONTAINER.get(mode);
    }

    /**
     * 檢查Bean是否存在
     *
     * @param mode 支付方式
     * @return boolean
     */
    public boolean checkBean(String mode) {
        return CONTAINER.containsKey(mode);
    }

}

PayService實現註冊PayBeanContainer容器中

這裡通過Spring初始化Bean後將所有PayService的實現類註冊到支付容器中，支付方式則對應Pay註解中的mode。

/**
 * 支付bean登錄檔
 *
 * @author wentao.wu
 * @date 2022/01/04
 */
@Slf4j
@Component
public class PayServiceInstantiationAwareBeanPostProcessor implements InstantiationAwareBeanPostProcessor {

    @Autowired
    private PayBeanContainer payBeanContainer;

    /**
     * 釋出過程例項化後
     *
     * @param bean     豆
     * @param beanName bean的名字
     * @return boolean
     * @throws BeansException 豆子例外
     */
    @Override
    public boolean postProcessAfterInstantiation(Object bean, String beanName) throws BeansException {
        if (bean instanceof PayService) {
            Pay annotation = bean.getClass().getAnnotation(Pay.class);
            payBeanContainer.addBean(annotation.mode(), (PayService) bean);
            log.info(" PayBeanContainer.addBean:{}", bean.getClass().getName());
        }
        return true;
    }
}

定義支付模板方法

統一支付流程的規範，並且實現呼叫的流程，具體子流程由開發自己實現。
當前模板方法主要統一了支付呼叫流程：

判斷支付方式是否存在，存在則向下走。
從容器獲取該支付方式的具體邏輯實現類。
呼叫支付前置方法。
執行支付。
支付成功，呼叫支付成功回撥方法。
支付失敗，呼叫支付失敗回撥方法。

這裡定義了大概流程，具體微信支付，支付前，支付，支付後回撥需要處理什麼邏輯由開發自行實現。

/**
 * 支付模板
 *
 * @author wentao.wu
 * @date 2022/01/04
 */
@Component
public class PayTemplate {

    @Autowired
    private PayBeanContainer payBeanContainer;

    /**
     * 支付
     *
     * @param payDTO 支付dto
     * @return boolean
     */
    public <T> boolean pay(PayDTO<T> payDTO) {
        if (!payBeanContainer.checkBean(payDTO.getMode())) {
            throw new RuntimeException("平臺不支援該支付方式，非法呼叫!");
        }
        PayService server = payBeanContainer.getBean(payDTO.getMode());
        server.befor(payDTO);
        boolean result = server.invoke(payDTO);
        if (result) {
            server.okAfter(payDTO);
        } else {
            server.errorAfter(payDTO);
        }
        return result;
    }

}

開發微信支付

經過我們上面的鋪墊開發實現微信支付只需要統一實現PayService並且宣告這個子類為微信支付的具體呼叫邏輯（@Pay(mode = "WXPAY")）

/**
 * wxpay impl
 *
 * @author wentao.wu
 * @date 2022/01/06
 */
@Component
@Slf4j
@Pay(mode = "WXPAY")
public class WXPayImpl implements PayService {
    @Override
    public <T> void befor(PayDTO<T> payDTO) {
        log.info("微信支付前，準備引數等....");
    }

    @Override
    public <T> boolean invoke(PayDTO<T> payDTO) {
        log.info("呼叫微信支付介面提交支付....");
        return true;
    }

    @Override
    public <T> void errorAfter(PayDTO<T> payDTO) {
        log.info("微信支付失敗記錄日誌....");
    }


    @Override
    public <T> void okAfter(PayDTO<T> payDTO) {
        log.info("微信支付成功給使用者傳送訊息通知使用者支付成功了....");
    }
}

提供統一支付介面給前端呼叫

建立前端引數VO：

/**
 * 支付VO
 *
 * @author wentao.wu
 * @date 2022/01/05
 */
@Data
public class PayVO implements Serializable {
    private String param1;// xx支付需要的引數
}

提供介面給前端呼叫：

@RestController
@RequestMapping("/pay")
public class PayController {

    @Autowired
    private PayTemplate payTemplate;

    /**
     * 支付
     *
     * @param mode  模式
     * @param payVO 支付簽證官
     * @return {@link String}
     */
    @PostMapping("/{mode}")
    public String pay(@PathVariable("mode") String mode, @RequestBody PayVO payVO) {
        PayDTO<PayVO> payDTO = new PayDTO<>();
        payDTO.setMode(mode);
        boolean reslult = payTemplate.pay(payDTO);
        if (reslult) {
            return "支付成功!";
        }
        return "支付失敗!";
    }


    /**
     * 舊的支付
     *
     * @param mode  模式
     * @param payVO 支付簽證官
     * @return {@link String}
     */
    @PostMapping("/old/{mode}")
    public String oldPay(@PathVariable("mode") String mode, @RequestBody PayVO payVO) {
        switch (mode) {
            case "ALIPAY":
                // 呼叫支付寶支付流程邏輯方法
                break;
            case "WXPAY":
                // 呼叫微信支付流程邏輯方法
                break;
            case "EBANK":
                // 呼叫E支付流程邏輯方法
                break;
            default:
                return "支付方式未找到!";

        }
        return "支付成功!";
    }

}

呼叫統一支付介面測試微信支付

Postman呼叫：http://localhost:7776/pay/WXPAY
RequestBody引數為:{"param1":"引數1"}
呼叫結果：支付成功!
控制檯列印日誌：

2022-01-06 12:45:37.441  INFO 15276 --- [nio-7776-exec-3] c.g.b.g.service.impl.WXPayImpl           : 微信支付前，準備引數等....
2022-01-06 12:45:37.441  INFO 15276 --- [nio-7776-exec-3] c.g.b.g.service.impl.WXPayImpl           : 呼叫微信支付介面提交支付....
2022-01-06 12:45:37.442  INFO 15276 --- [nio-7776-exec-3] c.g.b.g.service.impl.WXPayImpl           : 微信支付成功給使用者傳送訊息通知使用者支付成功了....

擴充套件支付寶支付

這裡我們需要擴充套件一種新的支付方式不需要改動任何程式碼，遵守開閉原則，每個類單一職責。

/**
 * 支付寶impl
 *
 * @author wentao.wu
 * @date 2022/01/06
 */
@Component
@Slf4j
@Pay(mode = "ALIPAY")
public class AlipayImpl implements PayService {
    @Override
    public <T> void befor(PayDTO<T> payDTO) {
        log.info("支付寶支付前，準備引數等....");
    }

    @Override
    public <T> boolean invoke(PayDTO<T> payDTO) {
        log.info("呼叫支付寶支付介面提交支付....");
        return true;
    }

    @Override
    public <T> void errorAfter(PayDTO<T> payDTO) {
        log.info("支付寶支付失敗記錄日誌....");
    }


    @Override
    public <T> void okAfter(PayDTO<T> payDTO) {
        log.info("支付寶支付成功給使用者傳送訊息通知使用者支付成功了....");
    }
}

呼叫統一支付介面測試支付寶支付

Postman呼叫：http://localhost:7776/pay/ALIPAY
RequestBody引數為:{"param1":"引數1"}
呼叫結果：支付成功!
控制檯列印日誌：

2022-01-06 13:49:50.141  INFO 13656 --- [nio-7776-exec-2] c.g.b.g.service.impl.AlipayImpl          : 支付寶支付前，準備引數等....
2022-01-06 13:49:50.141  INFO 13656 --- [nio-7776-exec-2] c.g.b.g.service.impl.AlipayImpl          : 呼叫支付寶支付介面提交支付....
2022-01-06 13:49:50.141  INFO 13656 --- [nio-7776-exec-2] c.g.b.g.service.impl.AlipayImpl          : 支付寶支付成功給使用者傳送訊息通知使用者支付成功了....

總結

原始碼地址: https://gitee.com/SimpleWu/blogs-examples/tree/master/grace-pay-case

經過重構後程式碼可讀性變得強了起來，需要修改微信支付看WXPayImpl，需要修改支付寶支付看AlipayImpl，讓程式碼變得清晰。
經過重構後程式碼擴充套件性變得強了起來，需要擴充套件只需要繼承PayService並且宣告@Pay支付方式即可。
使用了模板方法模式，組成了支付流程骨架，將步驟延遲到了依賴類去實現。
使用了策略模式將所有支付方式統一儲存管理了起來，當需要某種策略時則去向策略管理器要。
......

今天你學費了嗎？

-.-

如何構建高擴充套件性網站？
2015-04-17
套件網站
寫擴充套件性好的程式碼：函式
2016-11-06
套件函式
非推倒重來式的讀/寫伸縮擴充套件
2011-06-07
套件
Chrome 擴充套件程式的開發與釋出 — 手把手教你開發擴充套件程式
2017-12-08
Chrome套件
聊聊如何讓你的業務程式碼具有可擴充套件性
2022-04-02
套件
高擴充套件性的學習路線
2015-03-24
套件
如何重構CRM系統，滿足擴充套件的需求
2018-09-13
套件
編寫可擴充套件程式
2019-03-11
套件
教你 4 步搭建彈性可擴充套件的 WebAPI
2021-09-09
套件WebAPI
bgo: 具備擴充套件性的 go 程式構建工具
2022-02-06
Go套件
kotlin 擴充套件（擴充套件函式和擴充套件屬性）
2019-02-26
Kotlin套件函式
Deco 編輯器高擴充套件性技術架構解析
2021-12-17
套件架構
重構 - 設計API的擴充套件機制
2018-05-07
API套件
ajax 原始碼解讀之如何擴充套件 ajax 的功能
2016-04-06
原始碼套件
重讀 ES6 — 陣列、物件的擴充套件
2017-09-03
陣列物件套件
可擴充套件性
2020-12-10
套件
【Kotlin】擴充套件屬性、擴充套件函式
2024-04-08
Kotlin套件函式
服務的擴充套件性
2016-01-06
套件
構建高可用性、高效能和可擴充套件的Zabbix Server架構
2024-07-01
套件Server架構
探索低程式碼高擴充性背後的奧祕
2021-12-14
COLA的擴充套件性使用和原始碼研究
2020-05-25
套件原始碼
使用Kotlin擴充套件函式擴充套件Spring Data案例
2021-11-11
Kotlin套件函式Spring
如何開發Chrome擴充套件程式
2013-08-27
Chrome套件
CheckBoxList擴充套件方法程式碼
2009-05-05
套件
YouTube的架構擴充套件
2010-07-15
架構套件
[擴充套件]laravel-xlswriter 一款基於xlswriter的laravel擴充套件包 excel極速讀寫
2021-04-30
套件LaravelExcel
bash的特有擴充套件屬性
2024-10-07
套件
如何利用容器與中介軟體實現微服務架構下的高可用性和彈性擴充套件
2024-01-19
微服務架構套件
如何編寫一個獨立的 PHP 擴充套件
2016-01-05
PHP套件
Apollo 釋出 GraphQL 平臺和 VS 程式碼擴充套件
2018-11-20
套件
寫了個 Laravel 高效樹結構生成的擴充套件
2019-06-08
Laravel套件
activiti通過擴充套件點重寫節點行為
2018-03-18
套件
[譯] 如何使用原生 JavaScript 構建簡單的 Chrome 擴充套件程式
2018-09-12
JavaScriptChrome套件
編寫易讀的程式碼 (轉)
2007-12-12
ARM裸機全集擴充套件--SRAM內部重定位程式碼示例
2020-12-09
套件
如何構建一個優雅擴充套件
2020-09-11
套件
✍ 寫一個擴充套件性較強的搜尋主頁
2020-06-12
套件
Swift 擴充套件 Storyboard 屬性
2018-04-23
Swift套件