DeleteCommunitySettingKeyCmd.java 4.61 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.community.cmd.communitySettingKey;

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.community.ICommunitySettingKeyV1InnerServiceSMO;
import com.java110.po.community.CommunitySettingKeyPo;
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.slf4j.Logger;
import com.java110.core.log.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * 类表述:删除
 * 服务编码:communitySettingKey.deleteCommunitySettingKey
 * 请求路劲:/app/communitySettingKey.DeleteCommunitySettingKey
 * add by 吴学文 at 2021-10-10 10:56:18 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行
 */

/**
 * 删除项目设置键命令类
 * 负责处理删除项目设置键相关配置信息的业务逻辑
 * 通过注解标识服务编码,与前端请求路径对应
 * 
 * @author 吴学文
 * @version 1.0
 * @since 2021-10-10
 */
@Java110Cmd(serviceCode = "communitySettingKey.deleteCommunitySettingKey")
public class DeleteCommunitySettingKeyCmd extends Cmd {
    
    /**
     * 日志记录器
     */
    private static Logger logger = LoggerFactory.getLogger(DeleteCommunitySettingKeyCmd.class);

    /**
     * 项目设置键服务接口,用于操作项目设置键数据
     */
    @Autowired
    private ICommunitySettingKeyV1InnerServiceSMO communitySettingKeyV1InnerServiceSMOImpl;

    /**
     * 参数校验方法
     * 验证请求参数是否完整和有效
     * 
     * @param event 命令事件对象,包含请求相关信息
     * @param cmdDataFlowContext 命令数据流上下文,用于获取和设置请求响应数据
     * @param reqJson 请求参数的JSON对象
     * @throws CmdException 当参数校验失败时抛出异常
     */
    @Override
    public void validate(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) {
        // 校验请求参数中必须包含keyId字段且不能为空
        Assert.hasKeyAndValue(reqJson, "keyId", "keyId不能为空");
        // 重复校验keyId字段,确保数据完整性
        Assert.hasKeyAndValue(reqJson, "keyId", "keyId不能为空");
    }

    /**
     * 执行删除项目设置键命令
     * 将请求参数转换为实体对象并调用服务层进行删除操作
     * 使用事务注解确保操作的原子性
     * 
     * @param event 命令事件对象
     * @param cmdDataFlowContext 命令数据流上下文
     * @param reqJson 请求参数的JSON对象
     * @throws CmdException 当删除操作失败时抛出异常
     */
    @Override
    @Java110Transactional
    public void doCmd(CmdEvent event, ICmdDataFlowContext cmdDataFlowContext, JSONObject reqJson) throws CmdException {
        // 将JSON请求参数转换为项目设置键实体对象
        CommunitySettingKeyPo communitySettingKeyPo = BeanConvertUtil.covertBean(reqJson, CommunitySettingKeyPo.class);
        
        // 调用服务层接口执行删除操作,返回影响的行数
        int flag = communitySettingKeyV1InnerServiceSMOImpl.deleteCommunitySettingKey(communitySettingKeyPo);

        // 检查删除操作是否成功,如果影响行数小于1则认为删除失败
        if (flag < 1) {
            throw new CmdException("删除数据失败");
        }

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