SpringBoot数据校验

步骤

1. 导入校验包
2. JavaBean 编写校验注解
3. 使用 @Valid 告诉 SpringMVC 进行校验,效果:如果校验不通过，目标方法不执行
4. 编写一个全局异常处理器，处理 MethodArgumentNotValidException(),封装校验结果

案例

pom.xml

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<optional>true</optional>
</dependency>

User类

@Data
public class User {

    private Integer id;

    @NotBlank(message = "姓名不能为空")
    private String name;

    @NotNull(message = "年龄不能为空")
    @Max(value = 150, message = "年龄不能超过150岁")
    @Min(value = 0, message = "年龄不能小于0岁")
    private Integer age;

    @Email(message = "邮箱格式不正确")
    private String email;
}

UserController

@RestController
public class UserController {

    @PostMapping("/user")
    public R add(@RequestBody @Valid User user){
        System.out.println("进行保存操作。。。");
        return R.ok();
    }
}

GlobalExceptionHandler

// 全局异常处理器
@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * 进行前端数据校验异常处理，给前端返回统一格式
     *
     *   {
     *       "code": 500,
     *       "msg": "校验失败",
     *       "data": {
     *           "name": "姓名不能为空",
     *           "age": "年龄不能超过150"
     *       }
     *   }
     */

    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R methodArgumentNotValidException(MethodArgumentNotValidException ex) {
        //1、result 中封装了所有错误信息
        BindingResult result = ex.getBindingResult();

        List<FieldError> errors = result.getFieldErrors();
        Map<String, String> map = new HashMap<>();
        for (FieldError error : errors) {
            String field = error.getField();
            String message = error.getDefaultMessage();
            map.put(field, message);
        }

        return R.failed(map, "参数错误");
    }

    // 最终的兜底
    @ExceptionHandler(Throwable.class)
    public R error(Throwable e) {
        System.out.println("【全局】 - Exception处理" + e.getClass());
        return R.failed(e.getMessage());
    }

}