✅P67-68_品牌管理-统一异常处理-JSR303分组校验

错误状态码枚举

cfmall-common/src/main/java/com/gyz/common/exception/BizCodeEnum.java

package com.gyz.common.exception;

/**
 * @Description
 *
 *  错误码和错误信息定义类
 *   1. 错误码定义规则为5为数字
 *   2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
 *   3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
 *   错误码列表：
 *    10: 通用
 *        001：参数格式校验
 *    11: 商品
 *    12: 订单
 *    13: 购物车
 *    14: 物流
 *
 * @Author GongYuZhuo
 * @Version 1.0.0
 */
public enum BizCodeEnum {

    /**
     * 系统未知异常
     */
    UNKNOWN_EXCEPTION(10000, "系统未知异常"),
    /**
     * 参数校验错误
     */
    VALID_EXCEPTION(10001, "参数格式校验失败");

    private final int code;
    private final String msg;

    BizCodeEnum(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

---

统一异常类

采用ControllerAdvice的方式进行统一处理异常！

1. 编写异常处理类，使用@ControllerAdvice。
2. 使用@ExceptionHandler标注方法可以处理的异常。

代码：CfMallExceptionControllerAdvice.java

package com.gyz.cfmall.product.exception;

import com.gyz.common.exception.BizCodeEnum;
import com.gyz.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

/**
 * @Description
 * @Author GongYuZhuo
 * @Version 1.0.0
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.gyz.cfmall.product.controller")
public class CfMallExceptionControllerAdvice {

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("数据校验出现问题{}，异常类型：{}", e.getMessage(), e.getClass());
        BindingResult bindingResult = e.getBindingResult();

        Map<String, String> errorMap = new HashMap<>();
        bindingResult.getFieldErrors().forEach((fieldError) -> {
            errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
        });
        return R.error(BizCodeEnum.VALID_EXCEPTION.getCode(), BizCodeEnum.VALID_EXCEPTION.getMsg()).put("data", errorMap);
    }

    /**
     * @Description 使用@ExceptionHandler标注方法可以处理的异常。
     *
     */
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable) {

        log.error("错误：", throwable);
        return R.error(BizCodeEnum.UNKNOWN_EXCEPTION.getCode(), BizCodeEnum.UNKNOWN_EXCEPTION.getMsg());
    }
}

---

分组校验

分组校验的作用：

• 在不同场景下校验的规则肯定是不同的，例如brandId在新增场景下必须为null,由于主键自增
• 而在修改情况下必须携带，分组属性的作用就是区分不同情况下的校验规则

cfmall-common 模块加入三个接口标识

package com.gyz.common.valid;

/**
 * @Description 添加分组标识
 */
public interface AddGroup {
}

package com.gyz.common.valid;

/**
 * @Description 修改分组标识
 */
public interface UpdateGroup {
}

package com.gyz.common.valid;

public interface UpdateStatusGroup {
}

实体类加分组校验

cfmall-product/src/main/java/com/gyz/cfmall/product/entity/BrandEntity.java

注意：品牌logo在新增时必须传值，而修改则可为空！

1. @NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})

• 注意groups标注情形，在新增和修改都会进行不为空校验！

2. @Validated({AddGroup.class})

• 默认没有指定分组的校验注解@NotBlank，在分组校验情况@Validated({AddGroup.class})下不生效，只@Validated生效；

package com.gyz.cfmall.product.entity;

import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

import java.io.Serializable;
import java.util.Date;

import com.gyz.common.valid.AddGroup;
import com.gyz.common.valid.UpdateGroup;
import com.gyz.common.valid.UpdateStatusGroup;
import lombok.Data;
import org.hibernate.validator.constraints.URL;

import javax.validation.constraints.*;

/**
 * 品牌
 * 
 * @author gong_yuzhuo
 * @email gongyuzhcho@163.com
 * @date 2021-10-17 10:17:22
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌id", groups = {UpdateGroup.class})
	@Null(message = "新增不能指定id", groups = {AddGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交", groups = {AddGroup.class, UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(groups = {AddGroup.class})
	@URL(message = "logo必须是一个合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	//@Pattern()
	@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(groups = {AddGroup.class})
	@Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(groups = {AddGroup.class})
	@Min(value = 0, message = "排序必须大于等于0", groups = {AddGroup.class, UpdateGroup.class})
	private Integer sort;

}

接口加@Validated注解

cfmall-product/src/main/java/com/gyz/cfmall/product/controller/BrandController.java

/**
     * 保存
     *
     * 开启校验功能@Valid. 效果：校验错误以后会有默认的响应；
     * 给校验的参数bean后紧跟一个BindingResult，就可以获取到校验的结果
     */
    @RequestMapping("/save")
    public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand) {

        brandService.save(brand);
        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    public R update(@Validated(UpdateGroup.class) @RequestBody BrandEntity brand) {

        brandService.updateById(brand);

        return R.ok();
    }

---

测试

POST http://localhost:8200/product/brand/save