好资源导航 » 文章资讯 » SpringBoot使用jsr303校验的实现

SpringBoot使用jsr303校验的实现

2023-07-13 06:55:04 73

依赖添加


org.springframework.boot
spring-boot-starter-validation

一些较老版本的SpringBoot需要添加相关依赖，我使用的2.1.4发行版不用这个操作。

验证使用对象接收参数的情况

publicclassPointDeductSetRequest{
privateLongid;
@NotBlank(message="租户id为空")
privateStringtenantId;
privateIntegerstatus;
@NotNull
privateIntegerpointValue;
@NotNull
privateIntegerdeductValue;
@NotBlank(message="操作员id为空")
privateStringoperator;
}

首先在需要验证的对象的对应字段上方加上校验注解，以下为一些常用注解：

@Null限制只能为null
@NotNull限制必须不为null
@AssertFalse限制必须为false
@AssertTrue限制必须为true
@DecimalMax(value)限制必须为一个不大于指定值的数字
@DecimalMin(value)限制必须为一个不小于指定值的数字
@Digits(integer,fraction)限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future限制必须是一个将来的日期
@Max(value)限制必须为一个不大于指定值的数字
@Min(value)限制必须为一个不小于指定值的数字
@Past限制必须是一个过去的日期
@Pattern(value)限制必须符合指定的正则表达式
@Size(max,min)限制字符长度必须在min到max之间
@Past验证注解的元素值（日期类型）比当前时间早
@NotEmpty验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式

@RequestMapping(value="/deduct",method=RequestMethod.POST)
publicBusinessResponsesetPointDeduct(@RequestBody@ValidPointDeductSetRequestrequest){
pointDeductService.setPointDeductRule(request);
returnnewBusinessResponse(ResponseEnum.OK);
}

之后在controller方法的对象参数前加@Valid注解。

校验使用单个参数接受的情况

@RequestMapping(value="/deduct",method=RequestMethod.GET)
publicPageResponsegetPointDeductList(@RequestParam(value="page",required=false)Integerpage,
@RequestParam(value="pageSize",required=false)IntegerpageSize,
@RequestParam(value="tenantId",required=false)@NotBlank(message="租户id为空")StringtenantId,
@RequestParam(value="status",required=false)Integerstatus){
PageResponseresponse=pointDeductService.getPointDeductList(page,pageSize,tenantId,status);
response.setCodeMsg(ResponseEnum.OK);
returnresponse;
}

首先需要在controller类上加@Validated注解，之后在方法中需要校验的参数前加上对应的校验注解进行校验。

对校验产生的异常的捕获

定义全局异常处理类并用@ControllerAdvice标注，由于对象和单个参数因校验产生的异常类型不同，因此需要分别处理。

对于对象作为接收前端请求的情况，因校验产生的异常类型为MethodArgumentNotValidException，示例方法如下：

/**
*捕获303对于body中的对象字段校验
*@parame
*@paramrequest
*@return
*/@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
ResponseEntity

SpringBoot使用jsr303校验的实现

热门推荐

随机推荐