7.参数校验

文章介绍了在SpringBoot应用中进行前端参数校验的方法,包括引入validation依赖,使用@Valid和@Validated注解指定校验规则,处理MethodArgumentNotValidException、BindException和ConstraintViolationException等异常,以及如何自定义校验规则和实现分组校验。整个过程确保了存入数据库的数据正确性。
摘要由CSDN通过智能技术生成

在controller和service进行前端传参校验,保证存到数据库的数据是正确的

1.引入依赖

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

这里无需指定版本,因为sprongboot已经引入了对应版本的依赖。
在这里插入图片描述

2.指定校验规则

  • 如果方法的参数是 Bean 类型,则在方法参数上添加 @Valid注解,并在 Bean 类上添加参数校验的注解。(类上的@Validated不加如果需要使用@Valid嵌套校验的话)
    @Valid注解支持嵌套,@Validated支持分组校验
    @Valid是JSR303声明的,@Validated是spring声明的。
    嵌套的意思就是
    beanA中还有一个beanB,两个bean都添加了参数校验的注解,则方法入参只有beanA时,则beanA中的beanB的参数校验也会生效,不加@Valid的话则beanB的参数校验不会生效
    在这里插入图片描述

在这里插入图片描述

  • 如果方法的参数是普通类型,则在方法参数上直接添加参数校验的注解。
    如果是单一参数的校验,必须要在类上面添加@Validated注解
    在这里插入图片描述
    Service 层校验也需要加,Service 可能会被别的 Service 进行调用,也会存在参数不正确的情况,所以必须进行参数校验。

3.拦截异常

拦截异常是为了返回固定数据格式给前端

    /**
     * 处理 SpringMVC 参数校验不正确  post json校验
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public CommonResult<?> methodArgumentNotValidExceptionExceptionHandler(MethodArgumentNotValidException ex) {
        log.warn("[methodArgumentNotValidExceptionExceptionHandler]", ex);
        FieldError fieldError = ex.getBindingResult().getFieldError();
        assert fieldError != null; // 断言,避免告警
        return CommonResult.error(BAD_REQUEST.getCode(), String.format("请求参数不正确:%s", fieldError.getDefaultMessage()));
    }

    /**
     * 处理 SpringMVC 参数绑定不正确,本质上也是通过 Validator 校验 post表单校验
     */
    @ExceptionHandler(BindException.class)
    public CommonResult<?> bindExceptionHandler(BindException ex) {
        log.warn("[handleBindException]", ex);
        FieldError fieldError = ex.getFieldError();
        assert fieldError != null; // 断言,避免告警
        return CommonResult.error(BAD_REQUEST.getCode(), String.format("请求参数不正确:%s", fieldError.getDefaultMessage()));
    }

    /**
     * 处理 Validator 校验不通过产生的异常 单个校验
     */
    @ExceptionHandler(value = ConstraintViolationException.class)
    public CommonResult<?> constraintViolationExceptionHandler(ConstraintViolationException ex) {
        log.warn("[constraintViolationExceptionHandler]", ex);
        ConstraintViolation<?> constraintViolation = ex.getConstraintViolations().iterator().next();
        return CommonResult.error(BAD_REQUEST.getCode(), String.format("请求参数不正确:%s", constraintViolation.getMessage()));
    }
  • 普通参数(非 java bean)校验出错时抛出ConstraintViolationException异常
  • 请求体绑定到java bean上,且校验参数失败时抛出 MethodArgumentNotValidException异常
  • 表单绑定到 java bean 出错时,会抛出 BindException 异常
    post请求的两种方式,一种是通过表单,一种是通过json
    这样,参数校验就完成了。

4.自定义校验规则

1.自定义注解

在这里插入图片描述

2.新增校验器

在这里插入图片描述

3.在需要校验处添加注解

在这里插入图片描述

5.分组校验

1.定义分组


public interface Group {
 
    interface Update{};
 
    interface FindAll{};
}

2.实体类字段指定分组


@Data
public class User implements Serializable {
 
    //用户名 这个校验只在FindAll分组有效
    @NotBlank(message = "请输入用户名不能为空",groups = {Group.FindAll.class})
    @Length(message = "名称不能超过个 {max} 字符", max = 10 ,groups = {Group.FindAll.class})
    private String username;
 
    //年龄
    @NotBlank(message = "请输入年龄不能为空",groups = {Group.Update.class})
    @Range(message = "年龄范围为 {min} 到 {max} 之间", min = 1, max = 100,groups = {Group.Update.class})
    private String age;

}

3.controller

@RestController
public class UserController {
 
    public static final Logger logger = LoggerFactory.getLogger(UserController.class.getName());
 
    @PostMapping("/add")
    @ResponseBody
    //注意@Validated有参数 value中写分组名称 表名这个方法属于Update分组,bean中配置了update分组的校验才会生效
    public String add(@Validated(value = {Group.Update.class}) User user, BindingResult bindingResult){
        if(bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            allErrors.forEach( v ->{
                logger.error(v.getObjectName()+"======"+v.getDefaultMessage());
            });
            return "添加失败";
        }
        return "添加成功";
    }
}

参考连接:参考连接1
参考链接2

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值