统一异常处理

/**
 * 自定义全局统一异常
 * RestControllerAdvice注解：表示要捕获异常，同时返回给前端json
 * 		basePackages表示要拦截异常的包，这里指定拦截com.example.example.example.controller包里的异常
 * @author hcxx
 * @date 2022/07/05
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.example.example.example.controller")
public class ExampleExceptionControllerAdvice {

    // 缩小范围异常，才能拿到其中的异常(才有具体的方法), 如果能够精确匹配这个异常，就匹配，否则就去下面的最大的异常
    // 这里的MethodArgumentNotValidException是入参jsr303校验异常。就是后面说的jsr303验证不同过时
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("数据校验出现异常: {} , 异常类型：{}", e.getMessage(), e.getClass());
        BindingResult bindingResult = e.getBindingResult();

        HashMap<String, String> errorMap = new HashMap<>();
        // 将所有异常信息存储到map中，返回给前端
        bindingResult.getFieldErrors().forEach(fieldError -> {
            errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
        });
        return R.error(BIzCodeEnum.VALID_EXCEPTION.getCode(), BIzCodeEnum.VALID_EXCEPTION.getMsg()).put("data", errorMap);
    }

    /**
     * 最大的异常
     * 注解@ExceptionHandler表示要捕获的异常
     * @param throwable 可抛出的
     */
    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable) {
        log.error("系统异常信息：{}", throwable.getMessage());
        return R.error(BIzCodeEnum.UNKNOWN_EXCEPTION.getCode(), BIzCodeEnum.UNKNOWN_EXCEPTION.getMsg());
    }
}

/**
 * 1. 错误代码定义为5位数字
 * 2. 前两位表示业务场景
 * 3. 错误描述，定义为枚举
 */
public enum BIzCodeEnum {

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

    private Integer code;
    private String msg;

    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

    BIzCodeEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

/**
    * 保存
    * Validated(AddGroup.class) 注解，标识为只校验添加组的规则
    * @Validated 注解表明要进行校验；后面的(AddGroup.class) 表示要进行第3步的分组校验，这里是更新标记类， 
    *            注意，这个类是我们自己创建的一个空类，仅用来标记，我们业务上约定，有这个类的属于更新。
    * AddGroup.class 可以不写，则为不开启分组校验，则实体类上也不要写groups=?。则为校验所有类型，不分组
    * BindingResult result 是在没有开启统一异常前，所有校验异常都会在这里，用于获取异常，统一异常处理后不再需要
    */
   @RequestMapping("/save")
   public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand  /*, BindingResult result*/ ) {
       brandService.save(brand);
       return R.ok();
   }

@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(message = "logo不能为空", groups = {AddGroup.class})
    @URL(message = "logo必须是一个合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
    private String logo;
    /**
     * 介绍
     */
    private String descript;
    /**
     * 显示状态[0-不显示；1-显示]
     */
    @NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
    @ListValue(vals = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
    private Integer showStatus;
    /**
     * 检索首字母， A-Z,a-z，使用正则
     */
    @NotEmpty(message = "检索首字母不能为空", groups = {AddGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
    private String firstLetter;
    /**
     * 排序, 最小为0, Integer不能使用empty约束
     */
    @NotNull(message = "排序不能为空", groups = {AddGroup.class})
    @Min(value = 0, message = "排序必须大于等于0", groups = {AddGroup.class, UpdateGroup.class})
    private Integer sort;

}

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE}) // 注解可以标注的位置
@Retention(RetentionPolicy.RUNTIME) // 校验注解的时机：运行时
@Repeatable(NotNull.List.class)
@Documented
@Constraint(validatedBy = {}) // 指明使用哪个校验器(类) 去校验使用了此标注的元素。不指定则必须在初始化的时候指定，可以指定多个校验器注解，使用时自动适配
public @interface NotNull {
    String message() default "{javax.validation.constraints.NotNull.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    @Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface List {
        NotNull[] value();
    }
}

@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class}) // 指定校验器为ListValueConstraintValidator类，第6点
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {

    String message() default "{com.example.common.valid.ListValue.message}"; // 在resources下的配置文件ValidationMessages.properties中取出该值。第5点

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    /**
     * 自定义的属性
     * vals默认为空
     */
    int[] vals() default {};
}

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

    private Set<Integer> set = new HashSet<>();

    /**
     * 初始化方法，可以用来获取所有校验规则传入的值
     * @date 2022/7/10
     * @param constraintAnnotation:
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {
        // 给的的值必须是vals, 注解上的val。（获取注解上的vals自定义的属性的值）
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    /**
     * 上一个方法获取所有的值后，可以用来判断是否校验成功
     * @date 2022/7/10
     * @param value: 前端提交过来的值
     * @param constraintValidatorContext: 校验的上下文环境信息
     * @return boolean
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
       return set.contains(value);
    }
}

/**
 * 显示状态[0-不显示；1-显示]
 */
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;