Springboot使用@validation参数校验

前言

 

  你还在用这种方式一个个的去校验参数是否正确吗？是不是很累？无用代码很多？

有了这个@Validation就再也不用这样去校验参数了，可以让我们在项目中不用浪费很多时间在参数校验这里，从而更专注于业务逻辑

 

正文

首先引入依赖

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

这里创建一个用户的DTO对象

@Data
@ApiModel("用户-表单对象")
public class SportsUserCreatForm{

  @ApiModelProperty(value="用户唯一标识",example = "0")
  @NotNull(groups = {Update.class})
  private long id;
  
  @ApiModelProperty(value = "所属机构唯一标识(冗余字段)", example = "0")
  private long organizationId;
  
  @ApiModelProperty("登录用户名")
  @NotBlank(message = "用户名不能为空")
  @Length(max = 10, message = "用户名最长为10位")
  private String loginName;
  
  @ApiModelProperty("密码")
  private String password;
  
  @ApiModelProperty("手机号")
  private String phone;
  
  @ApiModelProperty("邮箱")
  private String email;

  @ApiModelProperty("性别( 'MALE', 'FEMALE' )")
  @NotNull(message = "用户性别不能为空")
  private SportsUserEnumGender gander;
  
  @ApiModelProperty(value = "出生日期-13位时间戳",example = "0")
  private long birthday;
  
  @ApiModelProperty("身份证号")
  private String idNumber;
  
  @ApiModelProperty("用户昵称")
  private String nickname;
  
}

在controller层添加@Validated注解，添加注解之后spring就会逐个校验DTO中加了校验注解的字段，完全通过才可以进入业务处理，否则就会抛出MethodArgumentNotValidException异常

  @PostMapping("user/add")
  @RequiresAuthentication
  @ApiOperation("添加用户")
  public SportsUser addUser(@Validated @RequestBody SportsUserCreatForm user) throws Exception{
    return userBiz.addUser(user);
  }

一般项目来说抛出异常都会有约定好的JSON格式返回错误码和错误信息，如果不处理就无法按照约定格式返回。这里我们可以通过声明全局异常处理类来拦截异常并将异常处理成前端能操作的JSON数据。（这里只需要关注MethodArgumentNotValidException异常）

@Slf4j
@Order(Ordered.HIGHEST_PRECEDENCE)
@RestControllerAdvice
public class GlobalExceptionAdvice{
  
  @ExceptionHandler(MethodArgumentNotValidException.class)
  @ResponseBody
  public ResponseEntity<Object> handleBeanValidation(HttpServletResponse res, MethodArgumentNotValidException e) throws Exception{
    res.setStatus(HttpStatus.OK.value());
    List<ObjectError> errors = e.getBindingResult().getAllErrors();
    ObjectError error = errors.get(0);// 如果有多个异常,这里只取第一个异常。没有必要把所有异常都抛出（错就是错，第一个校验都没通过，自然也轮不到第二个校验。）
    String json = JSONObject.toJSONString(error);
    //  转换成map对象方便取值
    Map<String, Object> map = JSONObject.parseObject(json);
    // 自己构造返回的外层数据结构
    OkMessage result = new OkMessage();
    // 这里的map中的key是model中加了校验注解的字段名（例如：@NotNull）
    // map中的defaultMessage是默认提示的错误信息，如果在校验注解中传message参数（例：@NotNull(message=”哈哈哈“)），就会变成你自定义的错误提示。
    result.setMsg("请求参数错误：[" + map.get("field") + "]" + map.get("defaultMessage"));
    result.setCode("PARAM-000001");
    return new ResponseEntity<>(result, HttpStatus.OK);
  }
}

 错误拦截示例：

分组校验

  有的人就要发问了，"啊，你这校验不行啊，我在添加的时候id是自动生成的不需要校验，编辑的时候就需要校验id了，我是不是要建两个一模一样的DTO，这样岂不是显得我很憨？！这不是增加无用代码吗？差评！" 

 其实不然，在此我们可以用到 groups 属性来解决此场景下的问题。

声明分组

注意:在声明分组的时候尽量继承 extend javax.validation.groups.Default。 否则，在你声明@Validated(Update.class)的时候,就会出现你在默认没添加groups = {}的时候的校验组@Email(message = "邮箱格式不对")不会自动校验，因为默认的校验组是groups = {Default.class}。

 

import javax.validation.groups.Default;

/**
 * 数据新增分组
 */
public interface Create extends Default {
 
}

 
import javax.validation.groups.Default;
 
/**
 * 数据更新分组
 */
public interface Update extends Default {
 
}

修改Controller中的@Validated注解，声明校验分组(下面用的是Create.class所以并不会校验id)

  @PostMapping("user/add")
  @RequiresAuthentication
  @ApiOperation("添加用户")
  public SportsUser addUser(@Validated(Create.class) @RequestBody SportsUserCreatForm user) throws Exception{
    return userBiz.addUser(user);
  }

下面附上注解说明

验证注解	验证的数据类型	说明
@AssertFalse	Boolean,boolean	验证注解的元素值是false
@AssertTrue	Boolean,boolean	验证注解的元素值是true
@NotNull	任意类型	验证注解的元素值不是null
@Null	任意类型	验证注解的元素值是null
@Min(value=值)	BigDecimal，BigInteger, byte,short, int, long，等任何Number或CharSequence（存储的是数字）子类型	验证注解的元素值大于等于@Min指定的value值
@Max（value=值）	和@Min要求一样	验证注解的元素值小于等于@Max指定的value值
@DecimalMin(value=值)	和@Min要求一样	验证注解的元素值大于等于@ DecimalMin指定的value值
@DecimalMax(value=值)	和@Min要求一样	验证注解的元素值小于等于@ DecimalMax指定的value值
@Digits(integer=整数位数, fraction=小数位数)	和@Min要求一样	验证注解的元素值的整数位数和小数位数上限
@Size(min=下限, max=上限)	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	java.util.Date,java.util.Calendar;Joda Time类库的日期类型	验证注解的元素值（日期类型）比当前时间早
@Future	与@Past要求一样	验证注解的元素值（日期类型）比当前时间晚
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@Length(min=下限, max=上限)	CharSequence子类型	验证注解的元素值长度在min和max区间内
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Range(min=最小值, max=最大值)	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型（如String）	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	String，任何CharSequence的子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可

此处只列出Hibernate Validator提供的大部分验证约束注解，请参考hibernate validator官方文档了解其他验证约束注解和进行自定义的验证约束注解定义。 

常用的几个:
1.@NotNull：不能为null，但可以为empty(""," ","   ")
2.@NotEmpty：不能为null，而且长度必须大于0 (" ","  ")
3.@NotBlank：只能作用在String上，不能为null，而且调用trim()后，长度必须大于0("test")    即：必须有实际字符