SpringBoot入门-数据校验

对于数据校验是前端做还是后端做，相信前后端的小伙伴们会为此扯皮很久。其实数据校验前后端都需要做，只是侧重点不一样。前端数据校验主要是提升用户体验，所以需要注重界面展示和提示信息，后端数据校验主要是防止恶意攻击和插入脏数据，同时还有些业务层面的限制只能后端来校验。

本章不讲解业务层面的校验，只讲解通用的数据校验。SpringBoot通用数据校验一般使用hibernate validator.

第一步引入依赖

<!-- 数据校验 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

第二步在实体类或者dto属性上加校验注解

@NotEmpty
private String username;

第三步在controller上加@Validated注解

@ApiOperation(value = "保存用户")
@PostMapping
public Result save(@RequestBody@Validated User user) {
    return resultOk();
}

第四步统一处理校验失败后的返回,由于校验失败会抛异常，直接统一处理下异常就行了

@ResponseBody
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public Result methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException ex) {
    logger.error("数据验证异常: {}", ex);
    BindingResult bindingResult = ex.getBindingResult();
    StringBuilder sb = new StringBuilder();
    sb.append("数据验证异常: ");
    for (ObjectError error : bindingResult.getAllErrors()) {
        if (error instanceof FieldError) {
            FieldError fieldError = (FieldError) error;
            sb.append("[").append(fieldError.getField()).append(fieldError.getDefaultMessage()).append("] ");
        } else {
            sb.append("[").append(error).append("] ");
        }
    }
    return resultFail(sb.toString().trim());
}

看下结果

 常用hibernate validator注解
@Null    必须为null
@NotNull    不能为null
@AssertTrue    必须为true
@AssertFalse    必须为false
@Min    必须为数字，其值大于或等于指定的最小值
@Max    必须为数字，其值小于或等于指定的最大值
@DecimalMin    必须为数字，其值大于或等于指定的最小值
@DecimalMax    必须为数字，其值小于或等于指定的最大值
@Size    集合的长度
@Digits    必须为数字，其值必须再可接受的范围内
@Past    必须是过去的日期
@Future    必须是将来的日期
@Pattern    必须符合正则表达式
@Email    必须是邮箱格式
@Length    长度范围
@NotEmpty    不能为null，长度大于0
@Range    元素的大小范围
@NotBlank    不能为null，字符串长度去前后空格后大于0(限字符串)

 参考项目(模块: SpringBoot-HelloWorld): https://gitee.com/huatin/java-test