天天看點

政策模式與模闆方法模式

1.  政策模式

政策模式是一種行為設計模式,它能讓你定義一系列算法,并将每種算法分别放入獨立的類中,以使算法的對象能夠互相替換。

當你有許多僅在執行某些行為時略有不同的相似類時,可使用政策模式。使用該模式能将類的業務邏輯與其算法實作細節隔離開來。

說白了,其實還是解耦

政策模式與模闆方法模式
政策模式的結構如上圖所示,主要包含三個角色:

  • 抽象角色:通常是一個接口
  • 具體角色:接口的具體實作
  • 環境角色:調用接口的上下文環境,通常是一段業務邏輯方法

舉個常見的例子:支付

先定義一個接口 PayStrategy.java

package com.example.service;

import com.example.domain.dto.PayDTO;
import com.example.domain.dto.PayDetailDTO;

/**
 * @author ChengJianSheng
 * @date 2021/1/11
 */
public interface PayStrategy {

    /**
     * 下單
     */
    PayDTO prepay();

    /**
     * 查詢
     */
    PayDetailDTO query();

    /**
     * 撤銷
     */
    void cancel();

    /**
     * 退款
     */
    void refund();

}       

然後是具體實作

AlipayStrategy.java 

package com.example.service.impl;

import com.alipay.api.AlipayClient;
import com.alipay.api.request.AlipayTradePrecreateRequest;
import com.alipay.api.response.AlipayTradeCancelResponse;
import com.example.domain.dto.PayDTO;
import com.example.domain.dto.PayDetailDTO;
import com.example.service.PayStrategy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * https://opendocs.alipay.com/open/common/abilitymap
 * https://opendocs.alipay.com/open/194/106078
 * 掃碼支付
 */
@Component
public class AlipayStrategy implements PayStrategy {

    @Autowired
    private AlipayClient alipayClient;

    @Override
    public PayDTO prepay() {
        AlipayTradePrecreateRequest request = new AlipayTradePrecreateRequest();
        AlipayTradeCancelResponse response = alipayClient.execute(request);
        return null;
    }

    @Override
    public PayDetailDTO query() {
        return null;
    }

    @Override
    public void cancel() {

    }

    @Override
    public void refund() {

    }

    public void payNotify(String data) {

    }

    public void refundNotify() {

    }
}
      

WeixinPayStrategy.java

package com.example.service.impl;

import com.example.domain.dto.PayDTO;
import com.example.domain.dto.PayDetailDTO;
import com.example.service.PayStrategy;
import com.github.binarywang.wxpay.bean.notify.WxPayOrderNotifyResult;
import com.github.binarywang.wxpay.bean.request.WxPayOrderQueryRequest;
import com.github.binarywang.wxpay.bean.request.WxPayUnifiedOrderRequest;
import com.github.binarywang.wxpay.service.WxPayService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

/**
 * https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/pages/index.shtml
 * https://github.com/Wechat-Group/WxJava/wiki/%E5%BE%AE%E4%BF%A1%E6%94%AF%E4%BB%98
 * @author ChengJianSheng
 * @date 2021/1/11
 */
@Component
public class WeixinPayStrategy implements PayStrategy {

    @Autowired
    private WxPayService wxPayService;

    @Override
    public PayDTO prepay() {
        WxPayUnifiedOrderRequest request = new WxPayUnifiedOrderRequest();
        wxPayService.createOrder(request);
        return null;
    }

    @Override
    public PayDetailDTO query() {
        WxPayOrderQueryRequest request = new WxPayOrderQueryRequest();
        wxPayService.queryOrder(request);
        return null;
    }

    @Override
    public void cancel() {

    }

    @Override
    public void refund() {

    }

    public void payNotify(String data) {
        WxPayOrderNotifyResult result = wxPayService.parseOrderNotifyResult(data);
    }

    public void refundNotify(String data) {
        WxPayOrderNotifyResult result = wxPayService.parseRefundNotifyResult(data);
    }
}       

上下文

package com.example.service.impl;

import com.example.domain.dto.PayDTO;
import com.example.service.PayService;
import com.example.service.PayStrategy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

/**
 * @author ChengJianSheng
 * @date 2021/1/11
 */
@Service
public class PayServiceImpl implements PayService {
    @Autowired
    private AlipayStrategy alipayStrategy;
    @Autowired
    private WeixinPayStrategy weixinPayStrategy;

    @Override
    public void prePay(PayDTO payDTO) {
        //  建立支付訂單
        //  組裝參數
        PayStrategy payStrategy = null;
        if (payDTO.getChannel() == 1) {
            payStrategy = alipayStrategy;
        } else {
            payStrategy = weixinPayStrategy;
        }

        payStrategy.prepay();

    }
}       

這樣就将算法的細節與業務邏輯隔離開,開發始終要遵循的原則是:高内聚,低耦合

其餘部分代碼補充如下:

pom.xml

<dependency>
    <groupId>com.alipay.sdk</groupId>
    <artifactId>alipay-sdk-java</artifactId>
    <version>4.11.8.ALL</version>
</dependency>
<dependency>
    <groupId>com.github.binarywang</groupId>
    <artifactId>weixin-java-pay</artifactId>
    <version>4.0.0</version>
</dependency>
      

 AlipayConfig.java

package com.example.config;

import com.alipay.api.AlipayClient;
import com.alipay.api.DefaultAlipayClient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 掃碼支付
 * https://opendocs.alipay.com/open/194/106078
 * https://opendocs.alipay.com/open/common/abilitymap
 *
 * @author ChengJianSheng
 * @date 2021/1/11
 */
@Configuration
public class AlipayConfig {
    @Value("${alipay.appId}")
    private String appId;
    @Value("${alipay.privateKey}")
    private String privateKey;
    @Value("${alipay.publicKey}")
    private String publicKey;

    @Bean
    public AlipayClient alipayClient() {
        AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", appId, privateKey, "json", "UTF-8", publicKey, "RSA2");
        return alipayClient;
    }
}
      

WeixinPayConfig.java 

package com.example.config;

import com.github.binarywang.wxpay.config.WxPayConfig;
import com.github.binarywang.wxpay.service.WxPayService;
import com.github.binarywang.wxpay.service.impl.WxPayServiceImpl;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * https://pay.weixin.qq.com/wiki/doc/apiv3/index.shtml
 * https://github.com/Wechat-Group/WxJava/wiki/%E5%BE%AE%E4%BF%A1%E6%94%AF%E4%BB%98
 * @author ChengJianSheng
 * @date 2021/1/11
 */
@Configuration
public class WeixinPayConfig {
    /**
     * 公衆号appid
     */
    @Value("${weixin.pay.appId}")
    private String appId;
    /**
     * 商戶号.
     */
    @Value("${weixin.pay.mchId}")
    private String mchId;
    /**
     * 商戶密鑰.
     */
    @Value("${weixin.pay.mchKey}")
    private String mchKey;

    @Value("${weixin.pay.notifyUrl}")
    private String notifyUrl;

    @Bean
    public WxPayService wxPayService() {
        WxPayConfig payConfig = new WxPayConfig();
        payConfig.setAppId(appId);
        payConfig.setMchId(mchId);
        payConfig.setMchKey(mchKey);
        payConfig.setNotifyUrl(notifyUrl);

        WxPayService wxPayService = new WxPayServiceImpl();
        wxPayService.setConfig(payConfig);
        return wxPayService;
    }
}
      

2.  模闆方法模式

模闆方法模式是一種行為設計模式,它在超類中定義了一個算法的架構,允許子類在不修改結構的情況下重寫算法的特定步驟。 

當多個類的算法除一些細微不同之外幾乎完全一樣時,可使用該模式。

這裡,“算法”應了解為一個功能,或者一段業務邏輯 

政策模式與模闆方法模式

模闆方法模式的結構如上圖所示,主要實作方式是

  1. 将一些公共的邏輯抽象出來,将功能實作分解為多個步驟
  2. 定義抽象類,将有差異的步驟聲明為抽象方法
  3. 子類繼承抽象基類,實作其中的抽象方法 

模闆方法減少了重複代碼,将公共代碼提到基類中,子類隻需關注各自差異化的邏輯 

上面的支付,也可以用模闆方法模式來實作。

個人覺得,政策模式、工廠方法模式、模闆方法模式,這三個都比較像。能用模闆方法模式的地方,通常也可以用政策模式。

隻是它們的側重點不一樣,政策模式的側重點在于可以動态切換算法,即同樣的參數,用不同的政策執行,可以得到不同的結果。

而模闆方法模式的側重點在于算法結構不變,中間的某些步驟的具體實作可以不同。

如果我們把政策模式中的上下文看成一個算法的話,那政策模式中的具體實作就是特定的步驟,這麼一想,感覺二者太像了。

模闆方法模式有一個活生生的例子是java.io.InputStream。InputStream中定義了一個抽象的read()方法,從流中讀取資料的方法時一樣的,隻是從什麼流中讀取的問題,可以從檔案流中讀,也可以從網絡流中讀。

最後,不要為了用設計模式而用設計模式。

https://refactoringguru.cn/design-patterns