【代码优化】商城: 满减送活动优惠券相关

puhui999
1 parent d60374d6
Showing 16 changed files with 136 additions and 89 deletions
yudao-module-mall/yudao-module-promotion-api/src/main/java/cn/iocoder/yudao/module/promotion/api/coupon/CouponApi.java
yudao-module-mall/yudao-module-promotion-api/src/main/java/cn/iocoder/yudao/module/promotion/api/reward/dto/RewardActivityMatchRespDTO.java
yudao-module-mall/yudao-module-promotion-api/src/main/java/cn/iocoder/yudao/module/promotion/enums/coupon/CouponStatusEnum.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/api/coupon/CouponApiImpl.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityBaseVO.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/dal/dataobject/coupon/CouponDO.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/dal/dataobject/reward/RewardActivityDO.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/dal/mysql/coupon/CouponMapper.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/service/coupon/CouponService.java
yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/service/coupon/CouponServiceImpl.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/dal/dataobject/order/TradeOrderDO.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/service/order/TradeOrderUpdateServiceImpl.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/service/order/handler/TradeCouponOrderHandler.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/service/price/bo/TradePriceCalculateRespBO.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/service/price/calculator/TradePriceCalculatorHelper.java
yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/service/price/calculator/TradeRewardActivityPriceCalculator.java
@@ -5,7 +5,7 @@ import cn.iocoder.yudao.module.promotion.api.coupon.dto.CouponUseReqDTO;
 import cn.iocoder.yudao.module.promotion.api.coupon.dto.CouponValidReqDTO;
 import jakarta.validation.Valid;
-import java.util.List;
+import java.util.Map;
 /**
  * 优惠劵 API 接口
@@ -36,14 +36,20 @@ public interface CouponApi {
      */
     CouponRespDTO validateCoupon(@Valid CouponValidReqDTO validReqDTO);
-    // TODO @puhui999：Map<Long, Integer> 优惠劵 会不会好点。
     /**
      * 【管理员】给指定用户批量发送优惠券
      *
-     * @param templateIds 优惠劵编号的数组
-     * @param counts      优惠券数量的数组
+     * @param giveCouponsMap  key: 优惠劵编号，value：对应的优惠券数量
      * @param userId      用户编号
      */
-    void takeCouponsByAdmin(List<Long> templateIds, List<Integer> counts, Long userId);
+    void takeCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId);
+
+    /**
+     * 【管理员】收回给指定用户批量发送优惠券
+     *
+     * @param giveCouponsMap key: 优惠劵编号，value：对应的优惠券数量
+     * @param userId         用户编号
+     */
+    void takeBackCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId);
 }
@@ -8,6 +8,7 @@ import lombok.Data;
 import java.io.Serializable;
 import java.time.LocalDateTime;
 import java.util.List;
+import java.util.Map;
 /**
  * 满减送活动的匹配 Response DTO
@@ -98,13 +99,11 @@ public class RewardActivityMatchRespDTO {
          */
         private Boolean giveCoupon;
         /**
-         * 赠送的优惠劵编号的数组
-         */
-        private List<Long> couponIds;
-        /**
-         * 赠送的优惠券数量的数组
+         * 赠送的优惠劵
+         *
+         *  key: 优惠劵编号，value：对应的优惠券数量
          */
-        private List<Integer> couponCounts;
+        private Map<Long, Integer> giveCouponsMap;
     }
@@ -18,7 +18,7 @@ public enum CouponStatusEnum implements IntArrayValuable {
     UNUSED(1, "未使用"),
     USED(2, "已使用"),
     EXPIRE(3, "已过期"),
-    ;
+    INVALID(4, "已作废");
     public static final int[] ARRAYS = Arrays.stream(values()).mapToInt(CouponStatusEnum::getStatus).toArray();
@@ -11,7 +11,7 @@ import jakarta.annotation.Resource;
 import org.springframework.stereotype.Service;
 import org.springframework.validation.annotation.Validated;
-import java.util.List;
+import java.util.Map;
 /**
  * 优惠劵 API 实现类
@@ -43,8 +43,13 @@ public class CouponApiImpl implements CouponApi {
     }
     @Override
-    public void takeCouponsByAdmin(List<Long> templateIds, List<Integer> counts, Long userId) {
-        couponService.takeCouponsByAdmin(templateIds, counts, userId);
+    public void takeCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId) {
+        couponService.takeCouponsByAdmin(giveCouponsMap, userId);
+    }
+
+    @Override
+    public void takeBackCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId) {
+        couponService.takeBackCouponsByAdmin(giveCouponsMap, userId);
     }
 }
@@ -16,6 +16,7 @@ import lombok.Data;
 import java.time.LocalDateTime;
 import java.util.List;
+import java.util.Map;
 import java.util.Objects;
 /**
@@ -88,16 +89,7 @@ public class RewardActivityBaseVO {
         private Boolean giveCoupon;
         @Schema(description = "赠送的优惠劵编号的数组", example = "1,2,3")
-        private List<Long> couponIds;
-
-        @Schema(description = "赠送的优惠券数量的数组", example = "1,2,3")
-        private List<Integer> couponCounts;
-
-        @AssertTrue(message = "优惠劵和数量必须一一对应")
-        @JsonIgnore
-        public boolean isCouponCountsValid() {
-            return BooleanUtil.isFalse(giveCoupon) || CollUtil.size(couponIds) == CollUtil.size(couponCounts);
-        }
+        private Map<Long, Integer> giveCouponsMap;
         @AssertTrue(message = "赠送的积分不能小于 1")
         @JsonIgnore
@@ -50,7 +50,6 @@ public class CouponDO extends BaseDO {
      *
      * 枚举 {@link CouponStatusEnum}
      */
-    // TODO 芋艿：已作废？
     private Integer status;
     // TODO 芋艿：发放 adminid？
@@ -16,6 +16,7 @@ import lombok.EqualsAndHashCode;
 import java.io.Serializable;
 import java.time.LocalDateTime;
 import java.util.List;
+import java.util.Map;
 /**
  * 满减送活动 DO
@@ -114,13 +115,11 @@ public class RewardActivityDO extends BaseDO {
          */
         private Boolean giveCoupon;
         /**
-         * 赠送的优惠劵编号的数组
-         */
-        private List<Long> couponIds;
-        /**
-         * 赠送的优惠券数量的数组
+         * 赠送的优惠劵
+         *
+         *  key: 优惠劵编号，value：对应的优惠券数量
          */
-        private List<Integer> couponCounts;
+        private Map<Long, Integer> giveCouponsMap;
     }
@@ -72,6 +72,15 @@ public interface CouponMapper extends BaseMapperX&lt;CouponDO&gt; {
         );
     }
+    default List<CouponDO> selectListByTemplateIdAndUserIdAndTakeType(Long templateId, Collection<Long> userIds,
+                                                                      Integer takeType) {
+        return selectList(new LambdaQueryWrapperX<CouponDO>()
+                .eq(CouponDO::getTemplateId, templateId)
+                .eq(CouponDO::getTakeType, takeType)
+                .in(CouponDO::getUserId, userIds)
+        );
+    }
+
     default Map<Long, Integer> selectCountByUserIdAndTemplateIdIn(Long userId, Collection<Long> templateIds) {
         String templateIdAlias = "templateId";
         String countAlias = "count";
@@ -108,11 +108,18 @@ public interface CouponService {
     /**
      * 【管理员】给指定用户批量发送优惠券
      *
-     * @param templateIds 优惠劵编号的数组
-     * @param counts      优惠券数量的数组
+     * @param giveCouponsMap key: 优惠劵编号，value：对应的优惠券数量
      * @param userId      用户编号
      */
-    void takeCouponsByAdmin(List<Long> templateIds, List<Integer> counts, Long userId);
+    void takeCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId);
+
+    /**
+     * 【管理员】收回给指定用户批量发送优惠券
+     *
+     * @param giveCouponsMap key: 优惠劵编号，value：对应的优惠券数量
+     * @param userId         用户编号
+     */
+    void takeBackCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId);
     /**
      * 【会员】领取优惠券
@@ -31,7 +31,6 @@ import java.util.stream.Collectors;
 import static cn.iocoder.yudao.framework.common.exception.util.ServiceExceptionUtil.exception;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.*;
-import static cn.iocoder.yudao.framework.common.util.collection.MapUtils.findAndThen;
 import static cn.iocoder.yudao.module.promotion.enums.ErrorCodeConstants.*;
 import static java.util.Arrays.asList;
@@ -165,6 +164,7 @@ public class CouponServiceImpl implements CouponService {
     }
     @Override
+    @Transactional(rollbackFor = Exception.class)
     public void takeCoupon(Long templateId, Set<Long> userIds, CouponTakeTypeEnum takeType) {
         CouponTemplateDO template = couponTemplateService.getCouponTemplate(templateId);
         // 1. 过滤掉达到领取限制的用户
@@ -180,28 +180,66 @@ public class CouponServiceImpl implements CouponService {
     }
     @Override
-    public void takeCouponsByAdmin(List<Long> templateIds, List<Integer> counts, Long userId) {
-        // TODO @puhui999：要不要循环调用上面的 takeCoupon 方法？按道理说，赠送也不会很多张。如果某次发卷失败，可以打个 error log；
-        // 1. 获得优惠券模版
-        List<CouponTemplateDO> templateList = couponTemplateService.getCouponTemplateList(templateIds);
-        if (CollUtil.isEmpty(templateList)) {
+    public void takeCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId) {
+        if (CollUtil.isEmpty(giveCouponsMap)) {
             return;
         }
-        Map<Long, CouponTemplateDO> templateMap = convertMap(templateList, CouponTemplateDO::getId);
-        // 2.1 批量构建优惠券
-        List<CouponDO> couponList = new ArrayList<>();
-        for (int i = 0; i < templateIds.size(); i++) {
-            int finalI = i;
-            findAndThen(templateMap, templateIds.get(i), template -> {
-                for (int j = 0; j < counts.get(finalI); j++) {
-                    couponList.add(CouponConvert.INSTANCE.convert(template, userId)
-                            .setTakeType(CouponTakeTypeEnum.ADMIN.getValue()));
+        // 循环发放
+        for (Map.Entry<Long, Integer> entry : giveCouponsMap.entrySet()) {
+            try {
+                for (int i = 0; i < entry.getValue(); i++) {
+                    getSelf().takeCoupon(entry.getKey(), CollUtil.newHashSet(userId), CouponTakeTypeEnum.ADMIN);
                 }
-            });
+            } catch (Exception e) {
+                log.error("[takeCouponsByAdmin][coupon({}) 优惠券发放失败]", entry, e);
+            }
+        }
+    }
+
+    @Override
+    public void takeBackCouponsByAdmin(Map<Long, Integer> giveCouponsMap, Long userId) {
+        // 循环收回
+        for (Map.Entry<Long, Integer> entry : giveCouponsMap.entrySet()) {
+            try {
+                for (int i = 0; i < entry.getValue(); i++) {
+                    getSelf().takeBackCoupon(entry.getKey(), CollUtil.newHashSet(userId), CouponTakeTypeEnum.ADMIN);
+                }
+            } catch (Exception e) {
+                log.error("[takeBackCouponsByAdmin][coupon({}) 收回优惠券失败]", entry, e);
+            }
+        }
+    }
+
+    /**
+     * 【管理员】收回优惠券
+     *
+     * @param templateId 模版编号
+     * @param userIds 用户编号列表
+     * @param takeType 领取方式
+     */
+    @Transactional(rollbackFor = Exception.class)
+    public void takeBackCoupon(Long templateId, Set<Long> userIds, CouponTakeTypeEnum takeType) {
+        CouponTemplateDO couponTemplate = couponTemplateService.getCouponTemplate(templateId);
+        // 1.1 校验模板
+        if (couponTemplate == null) {
+            throw exception(COUPON_TEMPLATE_NOT_EXISTS);
+        }
+        // 1.2 校验领取方式
+        if (ObjectUtil.notEqual(couponTemplate.getTakeType(), takeType.getValue())) {
+            throw exception(COUPON_TEMPLATE_CANNOT_TAKE);
         }
-        // 2.2 批量保存优惠券
-        couponMapper.insertBatch(couponList);
+
+        // 2.1 过滤出还未使用的赠送的优惠券
+        List<CouponDO> couponList = couponMapper.selectListByTemplateIdAndUserIdAndTakeType(templateId, userIds,
+                takeType.getValue());
+        List<CouponDO> unUsedCouponList = filterList(couponList, item -> !CouponStatusEnum.USED.getStatus().equals(item.getStatus()));
+        // 2.2 减少优惠劵模板的领取数量
+        couponTemplateService.updateCouponTemplateTakeCount(templateId, unUsedCouponList.size() * -1);
+        // 2.3 批量更新优惠劵状态
+        couponMapper.updateById(convertList(unUsedCouponList, item -> new CouponDO().setId(item.getId())
+                .setStatus(CouponStatusEnum.INVALID.getStatus())));
+
     }
     @Override
@@ -12,11 +12,13 @@ import cn.iocoder.yudao.module.trade.enums.order.TradeOrderRefundStatusEnum;
 import cn.iocoder.yudao.module.trade.enums.order.TradeOrderStatusEnum;
 import cn.iocoder.yudao.module.trade.enums.order.TradeOrderTypeEnum;
 import com.baomidou.mybatisplus.annotation.KeySequence;
+import com.baomidou.mybatisplus.annotation.TableField;
 import com.baomidou.mybatisplus.annotation.TableName;
+import com.baomidou.mybatisplus.extension.handlers.JacksonTypeHandler;
 import lombok.*;
 import java.time.LocalDateTime;
-import java.util.List;
+import java.util.Map;
 /**
  * 交易订单 DO
@@ -292,19 +294,14 @@ public class TradeOrderDO extends BaseDO {
      */
     private Integer vipPrice;
-    // TODO @puhui999：:1）建议命名要 giveXXX；不然不好理解哈；2）是不是搞成 Map 好点哈。
     /**
-     * 赠送的优惠劵编号的数组
+     * 赠送的优惠劵
      *
+     *  key: 优惠劵编号，value：对应的优惠券数量
      * 目的：用于后续取消或者售后订单时，需要扣减赠送
      */
-    private List<Long> couponIds;
-    /**
-     * 赠送的优惠券数量的数组
-     *
-     * 目的：用于后续取消或者售后订单时，需要扣减赠送
-     */
-    private List<Integer> couponCounts;
+    @TableField(typeHandler = JacksonTypeHandler.class)
+    private Map<Long, Integer> giveCouponsMap;
     /**
      * 秒杀活动编号
@@ -202,7 +202,7 @@ public class TradeOrderUpdateServiceImpl implements TradeOrderUpdateService {
         order.setProductCount(getSumValue(calculateRespBO.getItems(), TradePriceCalculateRespBO.OrderItem::getCount, Integer::sum));
         order.setUserIp(getClientIP()).setTerminal(getTerminal());
         // 使用 + 赠送优惠券
-        order.setCouponIds(calculateRespBO.getCouponIds()).setCouponCounts(calculateRespBO.getCouponCounts());
+        order.setGiveCouponsMap(calculateRespBO.getGiveCouponsMap());
         // 支付 + 退款信息
         order.setAdjustPrice(0).setPayStatus(false);
         order.setRefundStatus(TradeOrderRefundStatusEnum.NONE.getStatus()).setRefundPrice(0);
@@ -33,11 +33,11 @@ public class TradeCouponOrderHandler implements TradeOrderHandler {
     @Override
     public void afterPayOrder(TradeOrderDO order, List<TradeOrderItemDO> orderItems) {
-        if (CollUtil.isEmpty(order.getCouponIds())) {
+        if (CollUtil.isEmpty(order.getGiveCouponsMap())) {
             return;
         }
         // 赠送优惠券
-        couponApi.takeCouponsByAdmin(order.getCouponIds(), order.getCouponCounts(), order.getUserId());
+        couponApi.takeCouponsByAdmin(order.getGiveCouponsMap(), order.getUserId());
     }
     @Override
@@ -48,10 +48,10 @@ public class TradeCouponOrderHandler implements TradeOrderHandler {
             couponApi.returnUsedCoupon(order.getCouponId());
         }
         // 情况二：收回赠送的优惠券
-        if (CollUtil.isEmpty(order.getCouponIds())) {
+        if (CollUtil.isEmpty(order.getGiveCouponsMap())) {
             return;
         }
-        // TODO @puhui999: 收回优惠券再考虑一下，是直接删除券还是改个状态；建议是【已作废】
+        couponApi.takeBackCouponsByAdmin(order.getGiveCouponsMap(), order.getUserId());
     }
 }
@@ -6,6 +6,7 @@ import cn.iocoder.yudao.module.trade.enums.order.TradeOrderTypeEnum;
 import lombok.Data;
 import java.util.List;
+import java.util.Map;
 /**
  * 价格计算 Response BO
@@ -72,15 +73,13 @@ public class TradePriceCalculateRespBO {
      */
     private Boolean freeDelivery;
-    // TODO @puhui999：感觉要不要试着改成 Map<Long, Integer> giveCoupons？貌似整体会更好理解一点。
     /**
-     * 赠送的优惠劵编号的数组
-     */
-    private List<Long> couponIds;
-    /**
-     * 赠送的优惠券数量的数组
+     * 赠送的优惠劵
+     *
+     *  key: 优惠劵编号，value：对应的优惠券数量
+     * 目的：用于后续取消或者售后订单时，需要扣减赠送
      */
-    private List<Integer> couponCounts;
+    private Map<Long, Integer> giveCouponsMap;
     /**
      * 订单价格
@@ -11,6 +11,7 @@ import cn.iocoder.yudao.module.trade.service.price.bo.TradePriceCalculateReqBO;
 import cn.iocoder.yudao.module.trade.service.price.bo.TradePriceCalculateRespBO;
 import java.util.ArrayList;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
@@ -31,8 +32,7 @@ public class TradePriceCalculatorHelper {
                                                                List<ProductSpuRespDTO> spuList, List<ProductSkuRespDTO> skuList) {
         // 创建 PriceCalculateRespDTO 对象
         TradePriceCalculateRespBO result = new TradePriceCalculateRespBO();
-        result.setType(getOrderType(param)).setPromotions(new ArrayList<>())
-                .setCouponIds(new ArrayList<>()).setCouponCounts(new ArrayList<>());
+        result.setType(getOrderType(param)).setPromotions(new ArrayList<>()).setGiveCouponsMap(new LinkedHashMap<>());
         // 创建它的 OrderItem 属性
         result.setItems(new ArrayList<>(param.getItems().size()));
@@ -19,13 +19,14 @@ import org.springframework.stereotype.Component;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
-import java.util.Objects;
+import java.util.Map;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.convertSet;
 import static cn.iocoder.yudao.framework.common.util.collection.CollectionUtils.filterList;
 import static cn.iocoder.yudao.module.trade.service.price.calculator.TradePriceCalculatorHelper.formatPrice;
 // TODO @puhui999：相关的单测，建议改一改
+
 /**
  * 满减送活动的 {@link TradePriceCalculator} 实现类
  *
@@ -107,16 +108,12 @@ public class TradeRewardActivityPriceCalculator implements TradePriceCalculator 
         }
         // 4.3 记录赠送的优惠券
         if (rule.getGiveCoupon()) {
-            for (int i = 0; i < rule.getCouponIds().size(); i++) {
-                Long couponId = result.getCouponIds().get(i);
-                Integer couponCount = result.getCouponCounts().get(i);
-                int index = CollUtil.indexOf(result.getCouponIds(), id -> Objects.equals(couponId, id));
-                if (index != -1) { // 情况一：别的满减活动送过同类优惠券，则直接增加数量
-                    List<Integer> couponCounts = result.getCouponCounts();
-                    couponCounts.set(index, couponCounts.get(index) + couponCount);
-                    result.setCouponCounts(couponCounts);
-                } else { // 情况二：还没有赠送的优惠券
-                    result.setCouponIds(rule.getCouponIds()).setCouponCounts(rule.getCouponCounts());
+            for (Map.Entry<Long, Integer> entry : rule.getGiveCouponsMap().entrySet()) {
+                Map<Long, Integer> giveCouponsMap = result.getGiveCouponsMap();
+                if (giveCouponsMap.get(entry.getKey()) == null) { // 情况一：还没有赠送的优惠券
+                    result.setGiveCouponsMap(rule.getGiveCouponsMap());
+                } else { // 情况二：别的满减活动送过同类优惠券，则直接增加数量
+                    giveCouponsMap.put(entry.getKey(), giveCouponsMap.get(entry.getKey()) + entry.getValue());
                 }
             }
         }
@@ -193,7 +190,7 @@ public class TradeRewardActivityPriceCalculator implements TradePriceCalculator 
         // 2. 构建不满足时的提示信息：按最低档规则算
         String meetTip = "满减送：购满 {} {}，可以减 {} 元";
         List<RewardActivityMatchRespDTO.Rule> rules = new ArrayList<>(rewardActivity.getRules());
-        rules.sort(Comparator.comparing(RewardActivityMatchRespDTO.Rule::getLimit)); // 按优惠门槛降序
+        rules.sort(Comparator.comparing(RewardActivityMatchRespDTO.Rule::getLimit)); // 按优惠门槛升序
         RewardActivityMatchRespDTO.Rule rule = rules.get(0);
         if (PromotionConditionTypeEnum.PRICE.getType().equals(rewardActivity.getConditionType())) {
             return StrUtil.format(meetTip, rule.getLimit(), "元", MoneyUtils.fenToYuanStr(rule.getDiscountPrice()));