开发中常用到的@Valid 注解类型的使用

  • Post author:
  • Post category:其他


一:

前言

搭建springboot项目,采用Restful接口,当前端调用接口或者是其他项目调用时,我们不能单一靠调用方来控制参数的准确性,自己也要对一些非空的值进行判定。

二:

传统解决方案

就是我们自己在代码中对参数一一进行判空操作

Model:

/**
 *  @author: liman
 *  @Date: 2020/7/20 16:27
 *  @Description: 
 */
public class User{
	private Long userID;  
	private Long addressID;
	private String userName;
 }

Controller:


@PostMapping("/createUser")
public String createUser(@RequestBody User dto) {
	if(dto.getUserID==null)
		return "userID不能为空";
	if(dto.getAddressID==null)
		return "addressID不能为空";
	if(dto.getUserName==null)
		return "comment不能为空";
	return "sucess";
}

这种做法能满足我们的要求,但是这样如果model字段过多,判定的就很多,相对维护起来就不是那么方便,其次增加controller层的负担,既然我们来到spring4的时代,就应该适应使用注解的趋势,下面是使用注解后的比变化。


注解式开发:

Model:

public class User{
	@NotNull(message = "用户ID不能为空")
	private Long userID;
  
        @Valid  // 重点在这里,一定要加上@Valid,Demo2中的校验才会生效,否则不会生效
	@NotNull(message = "收货人地址id不能为空")
	private Long addressID;
	  
	@NotBlank(message = "备注不为空")
	private String userName;
}

Controller:

在controller层的方法的要校验的参数上添加@Valid注解

@PostMapping("/createUser")
public String createOrders(@RequestBody @Valid User dto, BindingResult results) { // 重点在这里,需要加上@Valid才会去校验
	if (results.hasErrors()) 
		return results.getFieldError().getDefaultMessage();
	return "success";
}

这样我们就只需要在model字段上加上非空验证和相应提示语就好了。

三:@Valid常用注解如下:

@Null 限制只能为null
@NotNull 限制必须不为null
@AssertFalse 限制必须为false
@AssertTrue 限制必须为true
@DecimalMax(value) 限制必须为一个不大于指定值的数字
@DecimalMin(value) 限制必须为一个不小于指定值的数字
@Digits(integer,fraction) 限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Future 限制必须是一个将来的日期
@Max(value) 限制必须为一个不大于指定值的数字
@Min(value) 限制必须为一个不小于指定值的数字
@Past 限制必须是一个过去的日期
@Pattern(value) 限制必须符合指定的正则表达式
@Size(max,min) 限制字符长度必须在min到max之间
@Past 验证注解的元素值(日期类型)比当前时间早
@NotEmpty 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@NotBlank 验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email 验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
需要注意每个注解对应的数据类型

举例:

//@NotNull:主要用在基本数据类型上(Int,Integer,Double,Date)

@NotNull(message = “年龄不能为空”)
private Integer age;

//@NotBlank:主要用在String字符串上面(String)

@NotBlank(message = “名字不能为空”)
private String name;

//@NotEmpty; 加了@NotEmpty注解的String类 ,Collection集合,Map ,数组,这些是不能为null或者长度为0的;(String ,Collection,Map的isEmpty()方法)



版权声明:本文为LOVE_Me__原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。