SaveInvoiceEventCmd.java 5.31 KB
/*
 * 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.invoiceEvent;

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.core.factory.GenerateCodeFactory;
import com.java110.intf.acct.IInvoiceEventV1InnerServiceSMO;
import com.java110.po.invoice.InvoiceEventPo;
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 org.slf4j.LoggerFactory;

/**
 * 类表述:保存发票事件信息
 * 服务编码:invoiceEvent.saveInvoiceEvent
 * 请求路劲:/app/invoiceEvent.SaveInvoiceEvent
 * add by 吴学文 at 2023-10-08 19:40:59 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行
 */

/**
 * 发票事件保存命令类
 * 
 * 该类负责处理发票事件的保存操作,包括参数验证和业务逻辑处理
 * 通过注解@Java110Cmd标识服务编码,用于路由请求到对应的处理器
 * 
 * @author 吴学文
 * @version 1.0
 * @since 2023-10-08
 */
@Java110Cmd(serviceCode = "invoiceEvent.saveInvoiceEvent")
public class SaveInvoiceEventCmd extends Cmd {

    /**
     * 日志记录器
     */
    private static Logger logger = LoggerFactory.getLogger(SaveInvoiceEventCmd.class);

    /**
     * ID生成前缀,用于生成事件ID
     */
    public static final String CODE_PREFIX_ID = "10";

    /**
     * 发票事件服务接口
     */
    @Autowired
    private IInvoiceEventV1InnerServiceSMO invoiceEventV1InnerServiceSMOImpl;

    /**
     * 参数验证方法
     * 
     * 验证请求参数是否包含必要的字段,如果缺少必要参数会抛出异常
     * 
     * @param event 命令事件对象,包含请求相关信息
     * @param cmdDataFlowContext 命令数据流上下文,用于获取和设置请求响应数据
     * @param reqJson 请求参数的JSON对象
     * @throws CmdException 当参数验证失败时抛出异常
     */
    @Override
    public void validate(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) {
        // 验证请求报文中必须包含applyId字段
        Assert.hasKeyAndValue(reqJson, "applyId", "请求报文中未包含applyId");
        // 验证请求报文中必须包含eventType字段
        Assert.hasKeyAndValue(reqJson, "eventType", "请求报文中未包含eventType");
        // 验证请求报文中必须包含communityId字段
        Assert.hasKeyAndValue(reqJson, "communityId", "请求报文中未包含communityId");
        // 验证请求报文中必须包含createUserId字段
        Assert.hasKeyAndValue(reqJson, "createUserId", "请求报文中未包含createUserId");
        // 验证请求报文中必须包含createUserName字段
        Assert.hasKeyAndValue(reqJson, "createUserName", "请求报文中未包含createUserName");
    }

    /**
     * 执行保存发票事件命令
     * 
     * 将请求参数转换为发票事件PO对象,生成唯一事件ID,并调用服务层保存数据
     * 使用@Java110Transactional注解确保方法在事务中执行
     * 
     * @param event 命令事件对象
     * @param cmdDataFlowContext 命令数据流上下文
     * @param reqJson 请求参数的JSON对象
     * @throws CmdException 当保存数据失败时抛出异常
     */
    @Override
    @Java110Transactional
    public void doCmd(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) throws CmdException {
        // 将请求JSON对象转换为发票事件PO对象
        InvoiceEventPo invoiceEventPo = BeanConvertUtil.covertBean(reqJson, InvoiceEventPo.class);
        
        // 生成唯一的事件ID
        invoiceEventPo.setEventId(GenerateCodeFactory.getGeneratorId(CODE_PREFIX_ID));
        
        // 调用服务层保存发票事件数据
        int flag = invoiceEventV1InnerServiceSMOImpl.saveInvoiceEvent(invoiceEventPo);

        // 检查保存操作是否成功,flag小于1表示保存失败
        if (flag < 1) {
            throw new CmdException("保存数据失败");
        }

        // 设置响应结果为成功
        cmdDataFlowContext.setResponseEntity(ResultVo.success());
    }
}