在springboot后端开发中常需要对前端传参进行校验,如果全部放在Controller或者Service中,会让代码看起来非常的冗余,这个时候直接在传参上加上约束注解就很方便实用,简单总结了一下常用的注解及其实用的场景。
空检查
@Null: 验证对象是否为null
@NotNull: 验证对象是否不为null, 无法查检长度为0的字符串 (用于 Integer、Bigdecimal、LocalDateTime、LocalDate、实体类)
@NotBlank: 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前- 后空格。(用于 String)
--------验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@NotEmpty: 检查约束元素是否为NULL或者是EMPTY. (字符串长度不为0、集合大小不为0用于 List
)Booelan检查
@AssertTrue: 验证 Boolean 对象是否为 true (限制必须为true)
@AssertFalse: 验证 Boolean 对象是否为 false (限制必须为false)长度检查
@Size(min=1, max=10): 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内 限制字符串、数组、集合长度范围必须在min到max之间
@Length(min=1, max=10) 验证注解的元素值长度在min和max区间内,只能用于字符串日期检查
@Past: 验证 Date 和 Calendar 对象是否在当前时间之前 (限制必须是一个过去的日期用于 过去时间,LocalDateTime、LocalDate
)
@Future: 验证 Date 和 Calendar 对象是否在当前时间之后 (限制必须是一个将来的日期用于 未来时间,LocalDateTime、LocalDate
)
@Pattern(regexp="reg"): 验证 String 对象是否符合正则表达式的规则 (限制必须符合指定的正则表达式)数值检查 (建议使用在Stirng,Integer类型)
@Min(value):限制必须为一个不小于指定值的数字
@Max(value):限制必须为一个不大于指定值的数字
@DecimalMin(value):限制必须为一个不小于指定值的数字
@DecimalMax(value):限制必须为一个不大于指定值的数字
@Digits:验证是否为数字
@Digits(integer, fraction):限制必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Range(min=long1,max=long2):检查数字是否在范围min到max之间其他验证
@Vaild:递归验证,用于对象、数组和集合,会对对象的元素、数组的元素进行一一校验
@Email:用于验证一个字符串是否是一个合法的邮箱地址,空字符串或null算验证通过
@URL(protocol=协议,host=主机,port=端口号,regexp=正则表达式,flags=标识):用于校验一个字符串是否是合法URL
- 使用示例:
@NotBlank(message = "新密码不能为空")
@Pattern(regexp = RegularUtilS.REG_PASSWORD, message = "新密码6-15个字符,只能数字、标点符号、字母")
private String newPassword;
@Email(message="邮箱格式错误")
private String email;
@Future(message = "开始时间必须是将来时间")
@NotNull(message = "开始时间不能为空")
private LocalDateTime startTime;
@NotNull(message = "余额升不能为空")
@DecimalMin(value = "0.01", message = "余额升最小为0.01")
@DecimalMax(value = "100", message = "余额升最大为100")
@ApiModelProperty(value = "余额升", example = "10")
private BigDecimal balance;
@NotNull(message = "最大购票数必填")
@Min(value = 0, message = "最小购票数为0")
@Max(value = 100, message = "最大购票数为100")
@ApiModelProperty(value = "最大购票数", example = "48")
private Short maxTickets;
@Size(max = 10, message = "请输入10个字符以内")
@ApiModelProperty(value = "联系人", example = "张三")
private String primaryContact;
@Email(message = "邮箱格式不正确")
@Size(max = 50, message = "邮箱长度不能超过50个字符")
@ApiModelProperty(value = "邮箱", example = "admin@139.com")
private String email;
非文章,spring boot个人笔记 谢谢。