在controller和service进行前端传参校验,保证存到数据库的数据是正确的
1.引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
这里无需指定版本,因为sprongboot已经引入了对应版本的依赖。
2.指定校验规则
- 如果方法的参数是 Bean 类型,则在方法参数上添加 @Valid注解,并在 Bean 类上添加参数校验的注解。
@Valid注解支持嵌套,@Validated支持分组校验
- 如果方法的参数是普通类型,则在方法参数上直接添加参数校验的注解。
如果是单一参数的校验,必须要在类上面添加@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
这样,参数校验就完成了。