责任链和命令模式在订单系统的实战记录

2020-07-29 本文已影响0人程序员爸爸

写在前面

"纸上得来终觉浅,绝知此事要躬行".

读完23种设计模式后,感觉肚子还是空空的,不知道无从下手,今天翻了一下之前的博客,曾经记录过关于Apache Commons Chain的使用,它其实基于责任链,命令模式来写的,它很适合做流程化的逻辑代码,比如订单的下单,支付流程以及退款流程,让代码写的很nice,下面把我应用在订单系统的实战记录下,看下对其他人有没有帮助.

概念

20180701173353203.png

)

Command接口:
       1. 命令模式,实现它来执行责任链中某个节点的业务. 
       2. 主要方法 boolean execute(Context context); return false 会继续执行下一个节点,否则终止.

Filter接口:
       1. extend command.
       2. 比Command接口多了一个方法 boolean postprocess(Context var1, Exception var2);只要Filter的execute方法被调用，不论链的执行过程中是否抛出错误，Commons Chain都将保证Filter的postprocess方法被调用。

ChainBase基类:
    它表示“命令链”，要在其中执行的命令，需要先添加到Chain中

Context接口:
    它表示命令执行的上下文,在命令间实现共享信息的传递

订单系统支付流程

直接上代码了,代码里面有注释,代码可以运行测试

1. pom文件引入

<!-- 引入commons-chain即可 -->
<dependency>
  <groupId>commons-chain</groupId>
  <artifactId>commons-chain</artifactId>
  <version>1.2</version>
</dependency>

<!--Lombok 程序员的高效开发利器 -->
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.12</version>
</dependency>

<!-- 引入 logback日志 -->
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>2.0.0-alpha1</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-core</artifactId>
  <version>1.3.0-alpha5</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.3.0-alpha5</version>
</dependency>

2. 订单支付主流程

业务逻辑: 订单下单后,应付金额 = 订单总价, 如果使用了优惠券,我们需要把优惠券的金额从支付金额减去,如果还有商旅卡之类营销类卡余额得扣去,最后才是客户应该支付的现金,计算好应该支付的现金后,需要同步订单的信息到公共订单系统,供app查询,app刷到订单系统给的该笔订单的支付开关是打开的,则跳转到收银台,比如微信或者支付宝开始支付,下面我们看下怎么实现的.

- OrderPayChain  定义支付流程的步骤
- OrderContext   定义订单的信息上下文:订单总价,已支付的价格,使用的商旅卡价格
- PromotionPayCommand  优惠券支付逻辑
- BusinessPayCommand  商旅卡支付逻辑
- CashPayCommand 现金支付逻辑
- SysncOrderInfoCommand 同步订单信息,打开支付开关

3. 实现过程

import org.apache.commons.chain.impl.ChainBase;

import java.math.BigDecimal;

/**
 * 这是变异后的责任链和命令模式
 *
 * 它表示“命令链”，要在其中执行的命令，需要先添加到Chain中
 */
public class OrderPayChain extends ChainBase {

    public void init() {

        //第一步: 扣优惠券
        this.addCommand(new PromotionPayCommand());
        //第二步:优先商旅卡
        this.addCommand(new BusinessPayCommand());
        //第三步: 扣现金
        this.addCommand(new CashPayCommand());
        // 同步订单信息
        this.addCommand(new SysncOrderInfoCommand());
    }


    public static void main(String[] args) throws Exception {
        var refundTicketChain = new OrderPayChain();
        refundTicketChain.init();
        var context = new OrderContext();
        context.setOrderId(1621940242);
        context.setTotalPrice(BigDecimal.valueOf(100));
        refundTicketChain.execute(context);
    }
}

import lombok.Data;
import org.apache.commons.chain.impl.ContextBase;

import java.math.BigDecimal;

/**
 * Context接口。它表示命令执行的上下文,在命令间实现共享信息的传递
 */
@Data
public class OrderContext extends ContextBase {

    /**
     * 订单号
     */
    private Integer orderId;
    /**
     * 订单总价
     */
    private BigDecimal totalPrice = BigDecimal.ZERO;

    /**
     * 该笔订单已经支付的总价
     */
    private BigDecimal payTotalPrice = BigDecimal.ZERO;

    /**
     * 使用商旅卡支付的金额
     */
    private BigDecimal businessCardPayPrice = BigDecimal.ZERO;
}

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.chain.Context;
import org.apache.commons.chain.Filter;

import java.math.BigDecimal;

@Slf4j
public class BusinessPayCommand implements Filter {


    @Override
    public boolean execute(Context context) throws Exception {

        OrderContext orderContext = (OrderContext) context;

        //查询客户账户下的商旅卡余额,比如查询结果是12.5元
//        var bPrice = new BigDecimal(12.5); 禁止这种写法
        var bPrice = BigDecimal.valueOf(12.5);
        //算出还需要支付的价格
        var remainPrice = orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice());
        //该笔订单,优先商旅卡支付全额
        if (bPrice.compareTo(remainPrice) >= 0) {
            orderContext.setPayTotalPrice(orderContext.getPayTotalPrice().add(remainPrice));
            orderContext.setBusinessCardPayPrice(remainPrice);
            if (log.isDebugEnabled()) {
                log.debug("订单orderId:{} ,订单总价:{},使用商旅卡支付了：{},还需要支付:{}",orderContext.getOrderId(),orderContext.getTotalPrice(),orderContext.getBusinessCardPayPrice(),orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice()));
            }
            return true;
        }else {
            // 使用商旅卡支付部分
            orderContext.setPayTotalPrice(orderContext.getPayTotalPrice().add(bPrice));
            orderContext.setBusinessCardPayPrice(bPrice);
            if (log.isDebugEnabled()) {
                log.debug("订单orderId:{} ,订单总价:{},使用商旅卡支付了：{},还需要支付:{}",orderContext.getOrderId(),orderContext.getTotalPrice(),orderContext.getBusinessCardPayPrice(),orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice()));
            }
            return false;
        }
    }

    @Override
    public boolean postprocess(Context context, Exception e) {

        OrderContext orderContext = (OrderContext) context;
        var businessCardPayPrice = orderContext.getBusinessCardPayPrice();
        // 请求扣除账户下商旅卡
        //httpClient.post("/api/businessCard/reduce",businessCardPayPrice);
        return false;
    }

}

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;

import java.math.BigDecimal;


@Slf4j
public class PromotionPayCommand implements Command {
    @Override
    public boolean execute(Context context) throws Exception {
        OrderContext orderContext = (OrderContext) context;

        //查询客户账户下的优惠券余额,比如查询结果是10元
        var bPrice = BigDecimal.valueOf(10);
        //算出还需要支付的价格
        var remainPrice = orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice());
        //该笔订单,优先商旅卡支付全额
        if (bPrice.compareTo(remainPrice) >= 0) {
            orderContext.setPayTotalPrice(orderContext.getPayTotalPrice().add(remainPrice));
            orderContext.setBusinessCardPayPrice(remainPrice);
            if (log.isDebugEnabled()) {
                log.debug("订单orderId:{} ,订单总价:{},使用优惠券支付了：{},还需要支付:{}",orderContext.getOrderId(),orderContext.getTotalPrice(),orderContext.getBusinessCardPayPrice(),orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice()));
            }
            return true;
        }else {
            // 使用商旅卡支付部分
            orderContext.setPayTotalPrice(orderContext.getPayTotalPrice().add(bPrice));
            orderContext.setBusinessCardPayPrice(bPrice);
            if (log.isDebugEnabled()) {
                log.debug("订单orderId:{} ,订单总价:{},使用优惠券支付了：{},还需要支付:{}",orderContext.getOrderId(),orderContext.getTotalPrice(),orderContext.getBusinessCardPayPrice(),orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice()));
            }
            return false;
        }
    }
}

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;
import org.apache.commons.chain.Filter;

import java.math.BigDecimal;

@Slf4j
public class CashPayCommand implements Filter {
    @Override
    public boolean execute(Context context) throws Exception {
        OrderContext orderContext = (OrderContext) context;

        //算出还需要支付的现金
        var remainPrice = orderContext.getTotalPrice().subtract(orderContext.getPayTotalPrice());
        if (log.isDebugEnabled()) {
            log.debug("订单orderId:{} ,订单总价:{},还需要支付现金:{}",orderContext.getOrderId(),orderContext.getTotalPrice(),remainPrice);
        }
        return false;
    }

    @Override
    public boolean postprocess(Context context, Exception e) {
        log.info("打开支付开关,客户端引导跳转收银台去支付");
        return false;
    }
}

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.chain.Command;
import org.apache.commons.chain.Context;

@Slf4j
public class SysncOrderInfoCommand implements Command {
    @Override
    public boolean execute(Context context) throws Exception {
        if (log.isDebugEnabled()) {
            log.debug("同步子系统订单信息到公共订单系统");
        }
        return false;
    }
}

测试

[PromotionPayCommand.java:33]2020-07-29 16:26:45.982 [DEBUG] {main} 订单orderId:1621940242 ,订单总价:100,使用优惠券支付了：10,还需要支付:90
[BusinessPayCommand.java:36]2020-07-29 16:26:45.992 [DEBUG] {main} 订单orderId:1621940242 ,订单总价:100,使用商旅卡支付了：12.5,还需要支付:77.5
[CashPayCommand.java:19]2020-07-29 16:26:45.993 [DEBUG] {main} 订单orderId:1621940242 ,订单总价:100,还需要支付现金:77.5
[SysncOrderInfoCommand.java:12]2020-07-29 16:26:45.994 [DEBUG] {main} 同步子系统订单信息到公共订单系统
[CashPayCommand.java:26]2020-07-29 16:26:45.994 [INFO] {main} 打开支付开关,客户端引导跳转收银台去支付