解读@NotNull和@NonNull的区别及使用
作者:一瓶橄榄菜
@NotNull和@NonNull区别及使用
区别
@NotNull在类字段中使用,表示该字段不能为空。它是 JSR303(Bean的校验框架)的注解。
在调用controller的方法中加入@Valid就可以验证该方法参数中该类的对应属性是否为空,如果为空,注解中的提示信息会保存在result中。
@NonNull在方法或构造函数的参数上使用,表示该参数不能为空。
@NotNull使用
/** * user类 */ @Data public class User { private int id; @NotNull(message = "babyId不能为空") private String babyId; } /** * controller的方法 * controller方法要加上@Valid ,表示需要验证! */ @PostMapping("getMyUser") @ResponseBody public Baby getBaby(@Valid @RequestBody User user){ return babyService.getBabyById(user.getBabyId()); }
此时调用controller的getBaby方法时如果user中babyId为空,那么程序会报MethodArgumentNotValidException
获取错误信息
将上面的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; // 字段错误 if (oe instanceof FieldError) { FieldError fe = (FieldError) oe; key = fe.getField();// 获取错误验证字段名 } else { // 非字段错误 key = oe.getObjectName();// 获取验证对象名称 } // 错误信息 msg = oe.getDefaultMessage(); System.out.println("key:"+key+";msg="+msg); } return babyService.getBabyById(user.getBabyId()); }
此时程序不会报错,但是可以获取错误信息:
key:babyId;msg=babyId不能为空
其他注解及解释
除了@NotNull,还有其他类似的注解,都是在类字段上使用
@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
被注释的字符串的大小必须在指定的范围内
*@Range
被注释的元素必须在合适的范围内
*@NotEmpty
:用在集合类上,不能为null,并且长度必须大于0
*@NotBlank
:只能作用在String上,不能为null,而且调用trim()后,长度必须大于0
@NonNull使用
@Override @Transactional public Baby getBabyById(@NonNull String babyId) { return babyMapper.getBabyById(babyId); }
如果 babyId 为空getBabyById会报NullPointerException
Java中容易混淆的一些知识
@NotNull、@NotEmpty、@NotBlank、@NonNull、@Nollable区分
注解 | 解释 |
---|---|
@NotNull | 只能用在基本类型之上,不能为空,但可以是空字符串 |
@NotEmpty | 只能作用在集合上,可以为空,但是不可以为空字符串 |
@NotBlank | 只能作用在String类型上,而且调用trim()之后,长度必须大于零 |
@NonNull | 作用在方法参数上,为空的话,会生成一个控制检查语句(检查语句可以自定义) |
@Nollable | 作用在参数上,表示可以为空 |
@GetMapping、@PostMapping、@RequestMapping,如果不清楚用哪个,就用@RequestMapping,一般公司所用就是@PostMapping
注解 | 解释 |
---|---|
@GetMapping | 接收的就是Get方法 |
@PostMapping | 接收的Post方法 |
@RequestMapping | 它默认的Get和Set方法都支持的 |
@Valid、@Validated,检测传参是否规范。
注解 | 解释 |
---|---|
@Valid | 作用在方法、字段、参数和构造器上 |
@Validated | 作用在类、方法、参数 |
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。