为什么使用:
@Validation是一套帮助我们继续对传输的参数进行数据校验的注解,通过配置Validation可以轻松优雅的完成对数据的约束检验。
引入jar依赖:
<!--属性验证-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
用处\用法:
用于在controller接口中参数检验,(可以在接口处声明错误,并返回给前台提示),这里使用过滤器捕捉,隐式提醒。代码更简洁
1.定义过滤拦截器:
/**
* Valid 属性判断 错误捕捉类
*
* @author byChen
* @date 2022/6/9
*/
@ControllerAdvice
public class ControllerExceptionHandler {
/**
* 处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常
*/
@ResponseBody
@ExceptionHandler(BindException.class)
public R handleValidException(BindException e) {
//将错误信息返回给前台
String message = e.getBindingResult().getAllErrors()
.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.collect(Collectors.joining());
return R.failed(message);
}
/**
* 处理请求参数格式错误
* z @RequestParam上validate失败后抛出的异常是javax.validation.ConstraintViolationException
*
* @param e
*/
@ExceptionHandler(ConstraintViolationException.class)
@ResponseBody
public R ConstraintViolationExceptionHandler(ConstraintViolationException e) {
String message = e.getConstraintViolations()
.stream()
.map(ConstraintViolation::getMessage)
.collect(Collectors.joining());
return R.failed(message);
}
/**
* 处理请求post请求参数格式错误
* z @RequestBody上validate失败后抛出的异常是MethodArgumentNotValidException异常。
*
* @param e
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public R MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
String message = e.getBindingResult().getAllErrors()
.stream()
.map(DefaultMessageSourceResolvable::getDefaultMessage)
.collect(Collectors.joining());
return R.failed(message);
}
}
三个拦截,分别拦截不同的接口请求方式
①路径中参数
②表单中参数
③post请求参数
2.在实体类上添加注解
/**
* <p>
* 选项字典
* </p>
*
* @author ByChen
* @since 2022-06-07
*/
@Data
@EqualsAndHashCode(callSuper = false)
@Accessors(chain = true)
public class ChooseDict implements Serializable {
private static final long serialVersionUID = 1L;
/**
* pk
*/
@TableId(value = "id", type = IdType.AUTO)
private Integer id;
/**
* 类型
*/
@NotNull(message = "type字段不能为空")
private String type;
/**
* 描述
*/
@NotNull(message = "description字段不能为空")
private String description;
/**
* 创建时间
*/
private LocalDateTime createTime;
/**
* 更新时间
*/
private LocalDateTime updateTime;
/**
* 字典选项值
*/
@TableField(exist = false)
private List<ChooseDictValue> dictValueList;
}
属性上加上对应的注解,即可完成参数校验
注解举例:
3.controller层接口处添加 @Validated注解,将校验交与框架处理
@PostMapping("/test333")
@Transactional(rollbackFor = Exception.class)
public void test33(@RequestBody @Validated ChooseDict chooseDict) throws Exception {
System.out.println("进入接口");
}
结果举例:
参数检验失败后,会调用拦截器里面的对应方法进行处理。可以在拦截器中处理要返回给页面的数据 。默认的提示是定义在属性上面的文字提示。