@NotNull @NotEmpty @NotBlank java校验注解 validation

心已赠人 2024-03-23 14:14 83阅读 0赞

> **1.@NotNull**  
> 不能为 null，但可以为 empty，一般用于判空 Integer 类型等基本数据类型，而且被其标注的字段可以使用 @size、@Max、@Min 对数值进行大小的控制
> 
>   
> **2.@NotEmpty**  
> 不能为 null，且长度必须大于 0，一般用于集合类或者数组上，也有人用于String(不推荐)
> 
>   
> **3.@NotBlank**  
> 只能作用在接收的 String 类型上，不能为 null，而且调用 trim() 后，长度必须大于 0。即：必须有实际字符  
>

### 代码示例 ###

@NotBlank(message = "商品名称不能为空")
        private String title;
    
        @Digits(integer = 9, fraction=2, message = "价格格式不正确")
        @DecimalMin(value = "0.00", message = "价格格式不正确")
        @NotNull(message = "价格不为空")
        private BigDecimal price;
    //digit是数位的意思，这里的integer意思整数最多有几位，fraction意思小数最多有几位，
    //decimal的最小值，传入参数必须大于等于value里面的值；
    
        @NotNull(message = "库存不能为空")
        @Min(value = 0,message = "库存不能小于0")
        private Integer stock;
    
        @NotEmpty(message = "图片链接不能为空")
        private List<String> picLink;

### 校验注解 ###

javax.validation.constraints.xxx

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Null</td> 
   <td>被注释的元素必须为null</td> 
  </tr> 
  <tr> 
   <td>@NotNull</td> 
   <td>被注释的元素不能为null</td> 
  </tr> 
  <tr> 
   <td>@AssertTrue</td> 
   <td>被注释的元素必须为true</td> 
  </tr> 
  <tr> 
   <td>@AssertFalse</td> 
   <td>被注释的元素必须为false</td> 
  </tr> 
  <tr> 
   <td>@Min(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@Max(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMin(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须大于等于指定的最小值</td> 
  </tr> 
  <tr> 
   <td>@DecimalMax(value)</td> 
   <td>被注释的元素必须是一个数字，其值必须小于等于指定的最大值</td> 
  </tr> 
  <tr> 
   <td>@Size(max,min)</td> 
   <td>被注释的元素的大小必须在指定的范围内。</td> 
  </tr> 
  <tr> 
   <td>@Digits(integer,fraction)</td> 
   <td>被注释的元素必须是一个数字，其值必须在可接受的范围内</td> 
  </tr> 
  <tr> 
   <td>@Past</td> 
   <td>被注释的元素必须是一个过去的日期</td> 
  </tr> 
  <tr> 
   <td>@Future</td> 
   <td>被注释的元素必须是一个将来的日期</td> 
  </tr> 
  <tr> 
   <td>@Pattern(value)</td> 
   <td>被注释的元素必须符合指定的正则表达式。</td> 
  </tr> 
  <tr> 
   <td>@Email</td> 
   <td>被注释的元素必须是电子邮件地址</td> 
  </tr> 
  <tr> 
   <td>@Length</td> 
   <td>被注释的字符串的大小必须在指定的范围内</td> 
  </tr> 
  <tr> 
   <td>@NotEmpty</td> 
   <td>被注释的字符串必须非空</td> 
  </tr> 
  <tr> 
   <td>@Range</td> 
   <td>被注释的元素必须在合适的范围内</td> 
  </tr> 
 </tbody> 
</table>

### 异常捕获 ###

@ControllerAdvice
    @ResponseBody
    public class MyExceptionHandler {
    
        @ExceptionHandler(value = MethodArgumentNotValidException.class)
        public String methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
            return e.getBindingResult().getFieldError().getDefaultMessage();
        }
    }
    
    //这里只是简单的返回注解中的字符串信息，
    //在具体的业务中可以把这里的getDefaultMessage()获取的信息放到具体的包装中返回。

官方文档(中文)

[Hibernate Validator (jboss.org)][Hibernate Validator _jboss.org]

官方文档(英文)

[Hibernate Validator 8.0.0.Final - Jakarta Bean Validation Reference Implementation: Reference Guide (jboss.org)][Hibernate Validator 8.0.0.Final - Jakarta Bean Validation Reference Implementation_ Reference Guide _jboss.org]

[validation参数检验 - 注解介绍\_validation 默认值][validation_ - _validation]

源码

[Spring中 的 @NotNull ,@NotEmpty 验证原理简析\_notnull注解原理][Spring_ _ _NotNull _NotEmpty _notnull]

=====================分割线========================

文章到此已经结束，以下是紫薯布丁

@NotBlank(message = "商品名称不能为空")  
private String title;

@Digits(integer = 9, fraction=2, message = "价格格式不正确")  
@DecimalMin(value = "0.00", message = "价格格式不正确")  
@NotNull(message = "价格不为空")  
private BigDecimal price;  
//digit是数位的意思，这里的integer意思整数最多有几位，fraction意思小数最多有几位，  
//decimal的最小值，传入参数必须大于等于value里面的值；

@NotNull(message = "库存不能为空")  
@Min(value = 0,message = "库存不能小于0")  
private Integer stock;

@NotEmpty(message = "图片链接不能为空")  
private List<String> picLink;

@ControllerAdvice  
@ResponseBody  
public class MyExceptionHandler \{

@ExceptionHandler(value = MethodArgumentNotValidException.class)  
public String methodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) \{  
return e.getBindingResult().getFieldError().getDefaultMessage();  
\}  
\}

//这里只是简单的返回注解中的字符串信息，  
//在具体的业务中可以把这里的getDefaultMessage()获取的信息放到具体的包装中返回。

@Null 被注释的元素必须为null  
@NotNull 被注释的元素不能为null  
@AssertTrue 被注释的元素必须为true  
@AssertFalse 被注释的元素必须为false  
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值  
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值  
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值  
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值  
@Size(max,min) 被注释的元素的大小必须在指定的范围内。  
@Digits(integer,fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内  
@Past 被注释的元素必须是一个过去的日期  
@Future 被注释的元素必须是一个将来的日期  
@Pattern(value) 被注释的元素必须符合指定的正则表达式。  
@Email 被注释的元素必须是电子邮件地址  
@Length 被注释的字符串的大小必须在指定的范围内  
@NotEmpty 被注释的字符串必须非空  
@Range 被注释的元素必须在合适的范围内

[Hibernate Validator _jboss.org]: https://docs.jboss.org/hibernate/validator/4.2/reference/zh-CN/html/index.html
[Hibernate Validator 8.0.0.Final - Jakarta Bean Validation Reference Implementation_ Reference Guide _jboss.org]: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/pdf/hibernate_validator_reference.pdf
[validation_ - _validation]: https://blog.csdn.net/qq_20919883/article/details/106297523
[Spring_ _ _NotNull _NotEmpty _notnull]: https://blog.csdn.net/qq_19922839/article/details/113948659