JSR303数据校验学习笔记

JSR-303 数据校验

常用注解

Annotation	应用位置	作用
@NotNull	field/property	检查该值不为null
@NotBlank	field/property	检查该字符串不为null,并且不是空字符串. 本约束和下面的@NotEmpty的不同之处在于,本约束只能被用在字符串类型上,并且会忽略字符串尾部的空白字符
@NotEmpty	字段或属性. 支持的类型包括String, Collection, Map 和数组	检查该值不为null同时也不为空
@URL	字段或属性, 要求其类型为String	判断该值是否是一个有效的URL, 如果给出了约束中的protocol, host 或 port 参数的话,那个被校验的值需要和其匹配
@Valid	字段或属性. 支持所有的非原始类型	递归的对关联对象进行校验, 如果关联对象是个集合或者数组, 那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验

更多查看注解使用教程

使用方法

1.实体类属性添加注解

import javax.validation.constraints.NotBlank;
import java.io.Serializable;

public class Student implements Serializable {

	@NotNull
    private int age;
    @NotBlank
    private String name;
    
}

2.controller

import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
public class StudentController {


    /**
     * 开启数据校验  @Valid
     * @param student
     * @return
     */
    @RequestMapping(value = "/test",method = RequestMethod.POST)
    public R test(@Valid @RequestBody Student student){
        System.out.println(student.toString());
        return new R(0,"SUCCESS",null);
    }


}

3.效果展示

name不为空请求成功

name为空返回异常信息

4.工具类

/**
 * 封装返回结果
 */
public class R<T> {

    private int code;
    private String msg;
    private T data;
    // 构造方法省略
    // getter setter 省略
}

/**
 * 封装全局异常结果
 */
@RestControllerAdvice(basePackages = "需要扫描的包")
public class ExceptionControllerAdvice {


    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public R handleVaildException(MethodArgumentNotValidException e){
        BindingResult result = e.getBindingResult();

        Map<String,String> map = new HashMap<>();
        result.getFieldErrors().forEach((item) -> {
            // 错误信息 item.getDefaultMessage()
            // 获取错误的属性名 item.getField()
            map.put(item.getField(),item.getDefaultMessage());
        });
        return new R(500,"数据校验错误",map);
    }
}