天天看点

JSR303参数校验使用手记快速开始现身说法注解大全

参数校验的必要性千篇一律,就不在多言了。

快速开始

1、引入jar包

springboot项目中引入jar包(有了springboot就是好,jsr303直接成了一个starter,不用再去担心版本,jar包不对什么的了)。

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

2、简单的示例

-->构造一个简单的POJO用于接收参数

public class UserVO implements Serializable {

	private static final long serialVersionUID = 1L;

	@NotBlank(message = "name不能为空")
	private String name;
	
	@NotNull(message = "年龄不能为空")
	@Min(value = 18, message = "未成年人禁止访问")
	private Integer age;

    //省略get/set.....
}
           

-->controller

@Controller
@RequestMapping("/test")
public class TestController {

	/**
	 * <p>jsr303测试
	 * */
	@RequestMapping(value = "/jsr303test")
	@ResponseBody
	public String jsr303Test(@Valid UserVO userVO, BindingResult result) {
		// 参数校验
		if(result.hasErrors()) {
			List<FieldError> errors = result.getFieldErrors();
			Map<String, Object> map = new HashMap<>();
			for(FieldError error : errors) {
				map.put(error.getField(), error.getDefaultMessage());
			}
			return map.toString();
		}
		return "校验通过,处理点其它的业务吧..";
	}

}
           

-->测试及结果

JSR303参数校验使用手记快速开始现身说法注解大全
JSR303参数校验使用手记快速开始现身说法注解大全
JSR303参数校验使用手记快速开始现身说法注解大全

json接收参数同样支持

JSR303参数校验使用手记快速开始现身说法注解大全
JSR303参数校验使用手记快速开始现身说法注解大全

现身说法

1、@Valid只能校验用POJO作为参数接收对象,参数传递方式可以是json;

2、单个参数验证

@NotNull(message = "id不能为空")Long id
           

3、JSR303的校验结果都封装在接口BindingResult中,BindingResult必须紧跟在被@Valid注解的参数后面;

反例:

BindingResult没有紧跟在@Valid注解的参数后面;

JSR303参数校验使用手记快速开始现身说法注解大全

4、需要校验的POJO属性,可以加入多个校验;

JSR303参数校验使用手记快速开始现身说法注解大全

5、建议使用包装类替代基本数据类型,基本数据类型没有注解支持非空判断;

注解大全

注解 说明
@Null 被注解的属性必须为Null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格,适用String
@NotEmpty 检查约束元素是否为NULL或者是EMPTY,适用集合
@AssertTrue 验证 Boolean 对象是否为 true  
@AssertFalse 验证 Boolean 对象是否为 false
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内
@Length 被注解的字符串长度
@Past 验证 Date 和 Calendar 对象是否在当前时间之前
@Future 验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern 验证 String 对象是否符合正则表达式的规则
@Min 验证 Number 和 String(必须是数字类型) 对象是否大等于指定的值
@Max  验证 Number 和 String(必须是数字类型) 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法  ,示例:@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度
@Range 检查数字是否介于min和max之间
@CreditCardNumber 信用卡验证
@Email 验证是否是邮件地址,如果为null,不进行验证,算通过验证
@URL 判断该值是否是一个有效的URL, 如果给出了约束中的protocol, host 或 port 参数的话,那个被校验的值需要和其匹配

继续阅读