淺談Spring中@NotEmpty、@NotBlank、@NotNull區(qū)別

更新時間：2023年02月09日 10:33:20 作者：x@lijun

本文主要介紹了淺談Spring中@NotEmpty、@NotBlank、@NotNull區(qū)別，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

1：引入依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <version>2.0.5.RELEASE</version>
        </dependency>

@NotEmpty、@NotBlank、@NotNull 包的位置：

import javax.validation.constraints.*;

2：區(qū)別

@NotNull
適用于基本數據類型(Integer，Long，Double等等)，當 @NotNull 注解被使用在 String 類型的數據上，則表示該數據不能為 Null（但是可以為 Empty）

注：被其標注的字段可以使用 @size、@Max、@Min 對字段數值進行大小的控制

@NotBlank
適用于 String 類型的數據上，加了@NotBlank 注解的參數不能為 Null 且 trim() 之后 size > 0，必須有實際字符

@NotEmpty
適用于 String、Collection集合、Map、數組等等，加了@NotEmpty 注解的參數不能為 Null 或者長度為 0

3:使用方法

@Data
public class BigPeople {
    @ApiModelProperty(value = "id" ,required = true)
    @NotNull(message = "id不能為空")
    @Length(message = "id不能超過{max}個長度",max = 10)
    private Integer id;
 
    @ApiModelProperty(value = "name" ,required = true)
    @NotBlank(message = "name不能為空")
    @Size(message = "名字最長為{max} 個字",max = 10)
    private String name;
 
    @ApiModelProperty(value = "age" ,required = true)
    @NotNull(message = "id不能為空")
    @Range(message = "age的長度范圍為{min}歲到{max}歲之間",min = 5,max = 10)
    private Integer age;
 
    @ApiModelProperty(value = "treeNode" ,required = true)
    @NotEmpty(message = "treeNode不能為空")
    private List<String> treeNode;
    
}

@Valid 包位置：

import javax.validation.Valid;

@Validated 包的位置

import org.springframework.validation.annotation.Validated;
    @ApiOperation(value = "新增或者修改一個人的信息")
    @PostMapping("/updateOrInsert")
    public Result updateOrInsert(@Valid @RequestBody  Person person){
        Boolean updateOrInsert = personService.updateOrInsert(person);
        if (updateOrInsert) {
            return new Result(ResultCode.SUCCESS,updateOrInsert);
        }
       return new Result(ResultCode.ERROR, "新增或者修改一個人的信息失敗");
    }
  
    @ApiOperation(value = "新增或者修改一個人的信息")
    @PostMapping("/updateOrInsert")
    public Result updateOrInsert(@Validated @RequestBody  Person person){
        Boolean updateOrInsert = personService.updateOrInsert(person);
        if (updateOrInsert) {
            return new Result(ResultCode.SUCCESS,updateOrInsert);
        }
       return new Result(ResultCode.ERROR, "新增或者修改一個人的信息失敗");
    }

最上面三個注釋：必須需要搭配@Valid 或者@Validated使用，在檢驗Controller的入參是否符合規(guī)范時

@Valid 和 @Validated 比較

最后我們來對 @Valid 和 @Validated 兩個注解進行總結下：

1：@Valid 和 @Validated 兩者都可以對數據進行校驗，待校驗字段上打的規(guī)則注解（@NotNull, @NotEmpty等）都可以對 @Valid 和 @Validated 生效；

2：@Valid 進行校驗的時候，需要用 BindingResult 來做一個校驗結果接收。當校驗不通過的時候，如果手動不 return ，則并不會阻止程序的執(zhí)行；

3：@Validated 進行校驗的時候，當校驗不通過的時候，程序會拋出400異常，阻止方法中的代碼執(zhí)行，這時需要再寫一個全局校驗異常捕獲處理類，然后返回校驗提示。

4：總體來說，@Validated 使用起來要比 @Valid 方便一些，它可以幫我們節(jié)省一定的代碼，并且使得方法看上去更加的簡潔。

此包下其它常用的校驗注解：

注解	含義
@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	1：元素必須是電子郵箱地址 2：字符串的大小必須在指定的范圍內 3：字符串必須非空 4：元素必須在合理的范圍內