解讀@NotNull和@NonNull的區(qū)別及使用

更新時(shí)間：2023年01月06日 11:07:52 作者：一瓶橄欖菜

這篇文章主要介紹了解讀@NotNull和@NonNull的區(qū)別及使用，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。

@NotNull和@NonNull區(qū)別及使用

區(qū)別

@NotNull在類(lèi)字段中使用，表示該字段不能為空。它是 JSR303（Bean的校驗(yàn)框架）的注解。

在調(diào)用controller的方法中加入@Valid就可以驗(yàn)證該方法參數(shù)中該類(lèi)的對(duì)應(yīng)屬性是否為空，如果為空，注解中的提示信息會(huì)保存在result中。

@NonNull在方法或構(gòu)造函數(shù)的參數(shù)上使用，表示該參數(shù)不能為空。

@NotNull使用

/**
?* user類(lèi)
?*/
@Data
public class User {

? ? private int id;
? ? @NotNull(message = "babyId不能為空")
? ? private String babyId;
}
/**
?* controller的方法
?* controller方法要加上@Valid ,表示需要驗(yàn)證!
?*/
?@PostMapping("getMyUser")
?@ResponseBody
?public Baby getBaby(@Valid @RequestBody User user){
??? ?return babyService.getBabyById(user.getBabyId());
?}

此時(shí)調(diào)用controller的getBaby方法時(shí)如果user中babyId為空，那么程序會(huì)報(bào)MethodArgumentNotValidException

獲取錯(cuò)誤信息

將上面的getBaby改為下面的例子：

@PostMapping("getMyUser")
@ResponseBody
public Baby getBaby(@Valid @RequestBody User user,Errors errors){
? ? List<ObjectError> oes = errors.getAllErrors();
? ? for (ObjectError oe : oes) {
? ? ? ? String key = null;
? ? ? ? String msg = null;
? ? ? ? // 字段錯(cuò)誤
? ? ? ? if (oe instanceof FieldError) {
? ? ? ? ? ? FieldError fe = (FieldError) oe;
? ? ? ? ? ? key = fe.getField();// 獲取錯(cuò)誤驗(yàn)證字段名
? ? ? ? } else {
? ? ? ? ? ? // 非字段錯(cuò)誤
? ? ? ? ? ? key = oe.getObjectName();// 獲取驗(yàn)證對(duì)象名稱
? ? ? ? }

? ? ? ? // 錯(cuò)誤信息
? ? ? ? msg = oe.getDefaultMessage();
? ? ? ? System.out.println("key:"+key+";msg="+msg);
? ? }
? ? return babyService.getBabyById(user.getBabyId());
}

此時(shí)程序不會(huì)報(bào)錯(cuò)，但是可以獲取錯(cuò)誤信息:

key:babyId;msg=babyId不能為空

其他注解及解釋

除了@NotNull，還有其他類(lèi)似的注解，都是在類(lèi)字段上使用

@Null 被注釋的元素必須為null
@NotNull 被注釋的元素不能為null，可以為空字符串

*@AssertTrue 被注釋的元素必須為true

*@AssertFalse 被注釋的元素必須為false

*@Min(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值

*@Max(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值

*@DecimalMin(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須大于等于指定的最小值

*@DecimalMax(value) 被注釋的元素必須是一個(gè)數(shù)字，其值必須小于等于指定的最大值

*@Size(max,min) 被注釋的元素的大小必須在指定的范圍內(nèi)。

*@Digits(integer,fraction) 被注釋的元素必須是一個(gè)數(shù)字，其值必須在可接受的范圍內(nèi)

*@Past 被注釋的元素必須是一個(gè)過(guò)去的日期

*@Future 被注釋的元素必須是一個(gè)將來(lái)的日期

*@Pattern(value) 被注釋的元素必須符合指定的正則表達(dá)式。

*@Email 被注釋的元素必須是電子郵件地址

*@Length 被注釋的字符串的大小必須在指定的范圍內(nèi)

*@Range 被注釋的元素必須在合適的范圍內(nèi)

*@NotEmpty：用在集合類(lèi)上，不能為null，并且長(zhǎng)度必須大于0

*@NotBlank：只能作用在String上，不能為null，而且調(diào)用trim()后，長(zhǎng)度必須大于0

@NonNull使用

@Override
@Transactional
public Baby getBabyById(@NonNull String babyId) {
? ? return babyMapper.getBabyById(babyId);
}

如果 babyId 為空getBabyById會(huì)報(bào)NullPointerException

Java中容易混淆的一些知識(shí)

@NotNull、@NotEmpty、@NotBlank、@NonNull、@Nollable區(qū)分

注解	解釋
@NotNull	只能用在基本類(lèi)型之上，不能為空，但可以是空字符串
@NotEmpty	只能作用在集合上，可以為空，但是不可以為空字符串
@NotBlank	只能作用在String類(lèi)型上，而且調(diào)用trim()之后，長(zhǎng)度必須大于零
@NonNull	作用在方法參數(shù)上，為空的話，會(huì)生成一個(gè)控制檢查語(yǔ)句（檢查語(yǔ)句可以自定義）
@Nollable	作用在參數(shù)上，表示可以為空

@GetMapping、@PostMapping、@RequestMapping，如果不清楚用哪個(gè)，就用@RequestMapping，一般公司所用就是@PostMapping