JSR303校验与统一异常处理

/**
 * 1.JSR303
 * 1）、给Bean添加校验注解:javax.validation.constraints，并定义自己的message提示
 * 2)、开启校验功能@Valid
 * 效果：校验错误以后会有默认的响应；
 * 3）、给校验的bean后紧跟一个BindingResult，就可以获取到校验的结果
 * 4）、分组校验（多场景的复杂校验）
 * 1)、	@NotBlank(message = "品牌名必须提交",groups = {AddGroup.class,UpdateGroup.class})
 * 给校验注解标注什么情况需要进行校验
 * 2）、@Validated({AddGroup.class})
 * 3)、默认没有指定分组的校验注解@NotBlank，在分组校验情况@Validated({AddGroup.class})下不生效，只会在@Validated生效；
 * <p>
 * 5）、自定义校验
 * 1）、编写一个自定义的校验注解
 * 2）、编写一个自定义的校验器 ConstraintValidator
 * 3）、关联自定义的校验器和自定义的校验注解
 *
 * @Documented
 * @Constraint(validatedBy = { ListValueConstraintValidator.class【可以指定多个不同的校验器，适配不同类型的校验】 })
 * @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
 * @Retention(RUNTIME) public @interface ListValue {
 * <p>
 * 2、统一的异常处理
 * @ControllerAdvice 1）、编写异常处理类，使用@ControllerAdvice。
 * 2）、使用@ExceptionHandler标注方法可以处理的异常。
 */

JSR303校验

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
            <version>2.3.7.RELEASE</version>
        </dependency>

1.给bean添加校验注解指定检查信息

@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
    private static final long serialVersionUID = 1L;

    /**
     * 品牌id
     */
    @Null(message = "新增时不能指定id", groups = {AddGroup.class})
    @NotNull(message = "修改时必须指定id", groups = {UpdateGroup.class})
    @TableId
    private Long brandId;
    /**
     * 品牌名
     */
    @NotBlank(message = "品牌名称不能为空!", groups = {AddGroup.class, UpdateGroup.class})
    private String name;
    /**
     * 品牌logo地址
     */
    @NotEmpty(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(message = "必须提供指定值", vals = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
    private Integer showStatus;
    /**
     * 检索首字母
     */
    @NotEmpty(message = "新增时不能为空", groups = {AddGroup.class})
    @Pattern(regexp = "^[a-zA-Z]$", message = "首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
    private String firstLetter;
    /**
     * 排序
     */
    @NotNull(message = "新增时不能为空", groups = {AddGroup.class})
    @Min(value = 0, message = "排序必须>=0", groups = UpdateGroup.class)
    private Integer sort;

}

2.接受请求时加上@Valid注解开启属性校验

@RestController
@RequestMapping("product/brand")
public class BrandController {
    @Autowired
    private BrandService brandService;
    @RequestMapping("/save")
    //@RequiresPermissions("member:brand:save")
    public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) {
        if (result.hasErrors()) {
            HashMap<String, String> map = new HashMap<>();
            //获取检验的错误结果
            result.getFieldErrors().forEach((item) -> {
                //获取错误提示
                String message = item.getDefaultMessage();
                //获取错误属性名称
                String field = item.getField();
                map.put(field, message);
            });

            return R.error(400, "提交数据不合法").put("data", map);
        } else {
            brandService.save(brand);
            return R.ok();
        }
}

springmvc的@ControllerAdvice 统一异常处理

1.编写ControllerAdvice 类

@Slf4j
@RestControllerAdvice(basePackages = "com.zdb.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public R handleValidException(MethodArgumentNotValidException e) {
        log.error("数据效验出现问题{},异常类型{}", e.getMessage(), e.getClass());
        BindingResult bindingResult = e.getBindingResult();

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


    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable) {

        log.error("错误异常{}", throwable);

        return R.error(BizCodeEnum.UNKNOW_EXCEPTION.getCode(), BizCodeEnum.UNKNOW_EXCEPTION.getMessage());
    }

}

2.编写Controller并编写接口(专用于操作的分组）（可以自定义校验注解如：@ListValue)

@Documented
@Constraint(validatedBy = {ListValueConstraintValidator.class})
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.zdb.common.valid.ListValue.message}";

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

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

    int[] vals() default {};
}

public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {

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

    /**
     * 初始化方法
     * @param constraintAnnotation 指定值
     */
    @Override
    public void initialize(ListValue constraintAnnotation) {

        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
            set.add(val);
        }
    }

    /**
     * 判断是否校验成功
     * @param value   需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {

        return set.contains(value);
    }
}

@RestController
@RequestMapping("product/brand")
public class BrandController {

    @Autowired
    private BrandService brandService;
    
    /**
     * 保存
     */
    @RequestMapping("/save")
    public R save(@Validated(AddGroup.class) @RequestBody BrandEntity brand/*, BindingResult result*/) {

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

    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    public R update(@Validated(UpdateGroup.class) @RequestBody BrandEntity brand) {
    
        brandService.updateById(brand);
        return R.ok();
    }

    /**
     * 修改状态
     */
    @RequestMapping("/update/status")
    public R updateStatus(@Validated(UpdateStatusGroup.class) @RequestBody BrandEntity brand) {
    
        brandService.updateById(brand);
        return R.ok();
    }

}