wuye / MicroCommunit

/*
 * Copyright 2017-2020 吴学文 and java110 team.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.java110.acct.cmd.couponDetail;

import com.alibaba.fastjson.JSONObject;
import com.java110.core.annotation.Java110Cmd;
import com.java110.core.annotation.Java110Transactional;
import com.java110.core.context.ICmdDataFlowContext;
import com.java110.core.event.cmd.Cmd;
import com.java110.core.event.cmd.CmdEvent;
import com.java110.intf.acct.ICouponDetailV1InnerServiceSMO;
import com.java110.po.coupon.CouponDetailPo;
import com.java110.utils.exception.CmdException;
import com.java110.utils.util.Assert;
import com.java110.utils.util.BeanConvertUtil;
import com.java110.vo.ResultVo;
import org.springframework.beans.factory.annotation.Autowired;
import org.slf4j.Logger;
import com.java110.core.log.LoggerFactory;


/**
 * 类表述：更新
 * 服务编码：couponDetail.updateCouponDetail
 * 请求路劲：/app/couponDetail.UpdateCouponDetail
 * add by 吴学文 at 2021-11-24 00:02:31 mail: 928255095@qq.com
 * open source address: https://gitee.com/wuxw7/MicroCommunity
 * 官网：http://www.homecommunity.cn
 * 温馨提示：如果您对此文件进行修改 请不要删除原有作者及注释信息，请补充您的 修改的原因以及联系邮箱如下
 * // modify by 张三 at 2021-09-12 第10行在某种场景下存在某种bug 需要修复，注释10至20行 加入 20行至30行
 */

/**
 * 优惠券详情更新命令类
 * 
 * 该类负责处理优惠券详情的更新操作，继承自Cmd基类，通过注解标识服务编码，
 * 提供参数验证和业务执行功能，确保优惠券详情数据的正确更新
 * 
 * @author 吴学文
 * @version 1.0
 * @since 2021-11-24
 */
@Java110Cmd(serviceCode = "couponDetail.updateCouponDetail")
public class UpdateCouponDetailCmd extends Cmd {

    /**
     * 日志记录器，用于记录类运行时的日志信息
     */
    private static Logger logger = LoggerFactory.getLogger(UpdateCouponDetailCmd.class);

    /**
     * 优惠券详情服务接口，用于执行优惠券详情的数据库操作
     * 通过Spring自动注入实现类
     */
    @Autowired
    private ICouponDetailV1InnerServiceSMO couponDetailV1InnerServiceSMOImpl;

    /**
     * 参数验证方法
     * 
     * 验证请求参数是否完整和有效，确保更新操作的必要字段都存在。
     * 该方法会检查所有必填字段，如果缺少任何必填字段将抛出CmdException异常
     * 
     * @param event 命令事件对象，包含请求相关信息
     * @param cmdDataFlowContext 命令数据流上下文，用于获取和设置请求响应数据
     * @param reqJson 请求参数的JSON对象，包含需要更新的优惠券详情数据
     * @throws CmdException 当参数验证失败时抛出异常，提示缺少必要的参数
     */
    @Override
    public void validate(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) {
        // 验证必填字段是否存在
        Assert.hasKeyAndValue(reqJson, "detailId", "detailId不能为空"); // 优惠券详情ID，唯一标识
        Assert.hasKeyAndValue(reqJson, "poolId", "请求报文中未包含poolId"); // 优惠券池ID
        Assert.hasKeyAndValue(reqJson, "shopId", "请求报文中未包含shopId"); // 店铺ID
        Assert.hasKeyAndValue(reqJson, "couponName", "请求报文中未包含couponName"); // 优惠券名称
        Assert.hasKeyAndValue(reqJson, "actualPrice", "请求报文中未包含actualPrice"); // 实际价格
        Assert.hasKeyAndValue(reqJson, "buyPrice", "请求报文中未包含buyPrice"); // 购买价格
        Assert.hasKeyAndValue(reqJson, "amount", "请求报文中未包含amount"); // 优惠券金额
        Assert.hasKeyAndValue(reqJson, "buyCount", "请求报文中未包含buyCount"); // 购买数量
        Assert.hasKeyAndValue(reqJson, "validityDay", "请求报文中未包含validityDay"); // 有效期天数
    }

    /**
     * 执行优惠券详情更新命令
     * 
     * 将请求参数转换为优惠券详情对象，调用服务层进行数据更新，
     * 并处理更新结果，返回操作响应。该方法使用事务注解确保数据一致性
     * 
     * @param event 命令事件对象，包含请求相关信息
     * @param cmdDataFlowContext 命令数据流上下文，用于获取和设置请求响应数据
     * @param reqJson 请求参数的JSON对象，包含需要更新的优惠券详情数据
     * @throws CmdException 当更新操作失败时抛出异常，提示更新数据失败
     */
    @Override
    @Java110Transactional
    public void doCmd(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) throws CmdException {
        // 将JSON请求参数转换为优惠券详情POJO对象
        // 使用BeanConvertUtil工具类进行对象转换，将JSON数据映射到CouponDetailPo对象
        CouponDetailPo couponDetailPo = BeanConvertUtil.covertBean(reqJson, CouponDetailPo.class);
        
        // 调用服务层接口执行更新操作，返回影响的行数
        // 通过优惠券详情服务接口更新数据库中的优惠券详情记录
        int flag = couponDetailV1InnerServiceSMOImpl.updateCouponDetail(couponDetailPo);

        // 检查更新操作是否成功，影响行数小于1表示更新失败
        // flag为0表示没有记录被更新，可能是记录不存在或其他原因导致更新失败
        if (flag < 1) {
            throw new CmdException("更新数据失败");
        }

        // 设置成功响应结果
        // 更新成功后，返回标准的成功响应给调用方
        cmdDataFlowContext.setResponseEntity(ResultVo.success());
    }
}