依赖增加
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId></dependency>
一些较老版本的SpringBoot须要增加相干依赖,我应用的2.1.4发行版不必这个操作。
验证应用对象接管参数的状况
public class PointDeductSetRequest { private Long id; @NotBlank(message = "租户id为空") private String tenantId; private Integer status; @NotNull private Integer pointValue; @NotNull private Integer deductValue; @NotBlank(message = "操作员id为空") private String operator;}
首先在须要验证的对象的对应字段上方加上校验注解,以下为一些罕用注解:
@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)public BusinessResponse setPointDeduct(@RequestBody @Valid PointDeductSetRequest request){ pointDeductService.setPointDeductRule(request); return new BusinessResponse(ResponseEnum.OK);}
之后在controller办法的对象参数前加@Valid注解。
校验应用单个参数承受的状况
@RequestMapping(value = "/deduct", method = RequestMethod.GET)public PageResponse<TPointDeduct> getPointDeductList(@RequestParam(value = "page", required = false) Integer page, @RequestParam(value = "pageSize", required = false) Integer pageSize, @RequestParam(value = "tenantId", required = false) @NotBlank(message = "租户id为空") String tenantId, @RequestParam(value = "status", required = false) Integer status){ PageResponse<TPointDeduct> response = pointDeductService.getPointDeductList(page, pageSize, tenantId, status); response.setCodeMsg(ResponseEnum.OK); return response;}
首先须要在controller类上加@Validated
注解,之后在办法中须要校验的参数前加上对应的校验注解进行校验。
对校验产生的异样的捕捉
定义全局异样解决类并用@ControllerAdvice
标注,因为对象和单个参数因校验产生的异样类型不同,因而须要别离解决。
对于对象作为接管前端申请的状况,因校验产生的异样类型为MethodArgumentNotValidException
,示例办法如下:
/** * 捕捉303对于body中的对象字段校验 * @param e * @param request * @return */@ExceptionHandler(MethodArgumentNotValidException.class)@ResponseBodyResponseEntity<Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request){ List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors(); if (fieldErrors != null && !fieldErrors.isEmpty()){ String message = fieldErrors.get(0).getDefaultMessage(); log.error(message, e); } HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR; HttpHeaders headers = new HttpHeaders(); Response response = new Response(); response.setCode(ResponseEnum.FORMAT_ERROR.code()); response.setMessage(ResponseEnum.FORMAT_ERROR.message()); return new ResponseEntity<>(response, headers, httpStatus);}
对于应用单个参数承受前端申请,因校验产生的异样类为ConstraintViolationException
,示例办法如下:
/** * 捕捉303对于request param单个参数的校验 * @param e * @param request * @return */@ExceptionHandler(ConstraintViolationException.class)@ResponseBodyResponseEntity<Object> handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request){ HttpStatus httpStatus = HttpStatus.INTERNAL_SERVER_ERROR; HttpHeaders headers = new HttpHeaders(); Response response = new Response(); response.setCode(ResponseEnum.FORMAT_ERROR.code()); response.setMessage(ResponseEnum.FORMAT_ERROR.message()); return new ResponseEntity<>(response, headers, httpStatus);}