一、添加maven依赖
<!--第一种方式导入校验依赖-->
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
<!--第二种方式导入校验依赖-->
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
二、常用校验
分类 | 注解 | 说明 | 示例 |
---|---|---|---|
值校验 | @Null | 被注解的元素必须为null | @Null(message = "人数必须为null") private Integer num; |
@NotNull | 被注解的元素必须不为null | @NotNull(message = "人数不能为null") private Integer num; | |
@NotBlank | 验证注解的元素值不为空( 不为null、去除首位空格后长度为0),并且类型为String | @NotBlank(message = "姓名不能为空") private String name; | |
@NotEmpty | 验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0) | // 支持的Java类型:String、Collection、Map、Array @NotEmpty(message = "组织部门不能为空") private List<String> userList; | |
@AssertTrue | 被注解的元素必须为true,并且类型为boolean | @AssertTrue(message = "状态必须为true") private boolean status; | |
@AssertFalse | 被注解的元素必须为false,并且类型为boolean | @AssertFalse(message = "状态必须为false") private boolean status; | |
@Positive | 被注解的元素必须为正数 | // 支持的Java类型:BigDecimal、BigInteger、byte、 // Byte、short、Short、int、Integer、long、Long、 // float、Float、double、Double @Negative(message = "金额必须是正数") | |
@PositiveOrZero | 被注解的元素必须为正数或 0 | // 支持的Java类型:BigDecimal、BigInteger、byte、 // Byte、short、Short、int、Integer、long、Long、 // float、Float、double、Double @Negative(message = "金额必须是正数或0") | |
@Negative | 被注解的元素必须为负数 | // 支持的Java类型:BigDecimal、BigInteger、byte、 // Byte、short、Short、int、Integer、long、Long、 // float、Float、double、Double @Negative(message = "金额必须是负数") | |
@NegativeOrZero | 被注解的元素必须为负数或 0 | // 支持的Java类型:BigDecimal、BigInteger、byte、 // Byte、short、Short、int、Integer、long、Long、 // float、Float、double、Double @Negative(message = "金额必须是负数或0") | |
范围校验 | @Min | 被注解的元素其值必须大于等于最小值 | // 支持的Java类型:BigDecimal、BigInteger、byte、Byte、 // short、Short、int、Integer、long、Long、String @Min(value = 18, message = "必须大于等于18岁") |
@Max | 被注解的元素其值必须小于等于最小值 | // 支持的Java类型:BigDecimal、BigInteger、byte、Byte、 // short、Short、int、Integer、long、Long、String @Max(value = 120, message = "必须小于等于120岁") | |
@DecimalMin | 验证注解的元素值大于等于@DecimalMin指定的value值,并且类型为BigDecimal | @DecimalMin(value = "1", message = "必须大于等于1") private BigDecimal money; | |
@DecimalMax | 验证注解的元素值小于等于@DecimalMax指定的value值 ,并且类型为BigDecimal | @DecimalMax(value = "10", message = "必须小于等于10") private BigDecimal money; | |
@Range | 验证注解的元素值在最小值和最大值之间 | // 支持的Java类型:BigDecimal、BigInteger、byte、Byte、 // short、Short、int、Integer、long、Long、String @Range(max = 80, min = 18, message = "必须大于等于 18或小于等于80") | |
@Past | 被注解的元素必须为过去的一个时间 | // 支持的Java类型:Date、Calendar、Instant、LocalDate、 // LocalDateTime、LocalTime等 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") | |
@PastOrPresent | 被注解的元素必须为当前时间或之前的时间 | // 支持的Java类型:Date、Calendar、Instant、LocalDate、 // LocalDateTime、LocalTime等 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") | |
@Future | 被注解的元素必须为未来的一个时间 | // 支持的Java类型:Date、Calendar、Instant、LocalDate、 // LocalDateTime、LocalTime等 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") | |
@FutureOrPresent | 被注解的元素必须为当前或之后的时间 | // 支持的Java类型:Date、Calendar、Instant、LocalDate、 // LocalDateTime、LocalTime等 @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") | |
长度校验 | @Size | 被注解的元素的长度必须在指定范围内 | // 支持的Java类型:String,Array,List,Map @Size(max = 11, min = 7, message = "长度必须大于等于7 或小于等于11") |
@Length | 验证注解的元素值长度在min和max区间内 ,并且类型为String | @Length(max = 11, min = 7, message = "长度必须大于等于7 或小于等于11") | |
格式校验 | @Digits | 验证注解的元素值的整数位数和小数位数上限 | // 支持的Java类型:BigDecimal、 // short、Short、int、Integer、long、Long、String @Digits(integer=3,fraction = 2,message = "整数位上限为3位, 小数位上限为2位") |
@Pattern | 被注解的元素必须符合指定的正则表达式,并且类型为String | @Pattern(regexp = "^1[1-9]\\d{9}$", message = "手机号格式错误") private String mobile; | |
被注解的元素值是Email,也可以通过regexp和flag指定自定义的email格式,类型为String | @Email(message = "必须是邮箱") private String email; | ||
@Valid | 指定递归验证关联的对象;如用户对象中有个地址对象属性,如果想在验证用户对象时一起验证地址对象的话,在地址对象上加@Valid注解即可级联验证 | //需要递归校验的UserDto @Valid private UserDto userDto; | |
@URL | 被注解的元素必须是一个有效的url地址,并且类型为String | @URL(message = "无效的url地址") private String url; |
@Max(value)、@Min(value)、@DecimalMax(value)、@DecimalMin(Value)区别:
1.@Max、@Min接受一个Long类型的值
2.@DecimalMax、@DecimalMin接受一个字符串类型的值(BigDecimal的字符串表示形式,因此可以是小数)
3.数字超过Long.MAX_VALUE或Long.MIN_VALUE以下或者数字是小数,@DecimalMax、@DecimalMin是唯一的选择。
最后在controller层代码中加入@Valid注解
如果这篇文章对您有所帮助,或者有所启发的话,求一键三连:点赞、评论、收藏➕关注,您的支持是我坚持写作最大的动力。