数据校验

数据校验的作用：不仅防止用户误输入，还能防止用户恶意的非法输入。
数据校验分类：

1. 客户端校验：主要是 编写 JS代码完成数据校验
2. 服务端校验：

Spring 自带的 Validation 校验框架
JSR303 (Java 验证规范) 本章重点讲解（推荐使用）
JSR303 是一个标准， Hibernate Validator 是对这个标准的实现

引入依赖

在 ruoyi-api-system 模块中引入依赖。为什么在这个模块中引入依赖？
因为本次要校验的 bean 对象是 SysUser 类，该类就在这个模块中。
后面我们会针对整个项目的依赖会合理规划一次，会将 spring-boot-starter-validation 依赖在 ruoyi-common-core 模块中引入（ruoyi-common-core作为最基础的模块，我们别写的模块都会直接或间接引入ruoyi-common-core）

            <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

编写Controller层代码

在代码中对前端传过来的 SysUser 对象进行数据校验，使用 @Validated 注解标注

@RestController
@RequestMapping("/user")
@Slf4j
public class SysUserController {
    @PostMapping
    public AjaxResult add(@Validated @RequestBody SysUser user) {
        if("admin".equals(user.getUserName())) {
            log.info("系统用户无法创建");
            return AjaxResult.error("系统用户无法创建");
        }
        log.info("调用了 add 方法添加用户");
        return AjaxResult.success("创建用户成功");
    }
}

编写校验规则

对需要校验的 java bean 对象，在其 java bean 的属性上标注注解作为校验规则

@Data
public class SysUser implements Serializable {
    private static final long serialVersionUID = 1L;
    private Long userId;
    private String userName;
    @Size(min = 0, max = 5, message = "用户昵称长度不能超过5个字符")
    private String nickName;
    @Email
    private String email;
}

测试

使用 postman 工具发送 post 请求

前台相应结果：

后台打印的日志：

优化

我们虽然使用了 Hibernate Validation 对 java bean 进行了数据校验，但当数据输入错误的时候，会抛出MethodArgumentNotValidException 异常，如果我们不捕获处理这个异常，那么就会出现上边的问题（报400错误）。结合我们全局异常处理器，我们可以针对 MethodArgumentNotValidException 异常进行捕获处理，给前台返回个友好提示。

在 GlobalExceptionHandler 类中添加 MethodArgumentNotValidException 异常的处理

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    /**
     * 自定义验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object validExceptionHandler(MethodArgumentNotValidException e) {
        log.error(e.getMessage(), e);
        String message = e.getBindingResult().getFieldError().getDefaultMessage();
        return AjaxResult.error(message);
    }
}

日志输出：

JSR 303 注解

Hibernate Validator 扩展的注解