美文网首页Android开发
@NotNull和@NonNull区别和使用

@NotNull和@NonNull区别和使用

作者: 陈大吼 | 来源:发表于2019-05-22 09:54 被阅读0次

    @NotNull使用在Bean的字段注解中。它是 JSR303(Bean的校验框架)的注解,在controller的方法中验证时(运行时检查一个属性是否为空)使用,如果不合法(为空),注解中的提示信息会保存在result中。

    @NonNull 在方法或构造函数的参数上使用,生成一个空值检查语句。用于指明所修饰的参数,字段或方法的值不可以为null。它是JSR 305(缺陷检查框架)的注解,是告诉编译器这个域不可能为空,当代码检查(静态检查)有空值时会给出一个风险警告。运行时不报任何警告,根据实际值得情况运行时可能出现空指针异常。 目前这个注解只有IDEA支持。实际好多静态扫描工具中有此注解符号

    例如:

    public class User implements Serializable {
    //主键
    @NotNull(message = "primary is not null",groups = {GroupInterface1.class})
    private Long id;
    
    @Pattern(regexp = "[0123456789]",groups = {GroupInterface1.class,GroupInterface2.class},message = "hava a error Date")
    private Long maxDiscountAmount;
    
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date createTime;
    
    @Future(message = "expireTime is not less than now",groups = {GroupInterface1.class,GroupInterface2.class})
    @NotNull(message = "expireTime is not null",groups = {GroupInterface1.class,GroupInterface2.class})
    private Date expireTime;
    }
    
    import java.util.Date;
    import javax.validation.constraints.DecimalMax;
    import javax.validation.constraints.DecimalMin;
    import javax.validation.constraints.Email;
    import javax.validation.constraints.Future;
    import javax.validation.constraints.Max;
    import javax.validation.constraints.Min;
    import javax.validation.constraints.NotNull;
    import javax.validation.constraints.Size;
    import org.hibernate.validator.constraints.Range;
    import org.springframework.format.annotation.DateTimeFormat;
    
    /**** imports ****/
    public class ValidatorPojo {
    // 非空判断
    @NotNull(message = "id不能为空")
    private Long id;
    
    @Future(message = "需要一个将来日期") // 只能是将来的日期
    // @Past //只能去过去的日期
    @DateTimeFormat(pattern = "yyyy-MM-dd") // 日期格式化转换
    @NotNull // 不能为空
    private Date date;
    
    @NotNull // 不能为空
    @DecimalMin(value = "0.1") // 最小值0.1元
    @DecimalMax(value = "10000.00") // 最大值10000元
    private Double doubleValue = null;
    
    @Min(value = 1, message = "最小值为1") // 最小值为1
    @Max(value = 88, message = "最大值为88") // 最大值88
    @NotNull // 不能为空
    private Integer integer;
    
    @Range(min = 1, max = 888, message = "范围为1至888") // 限定范围
    private Long range;
    
    // 邮箱验证
    @Email(message = "邮箱格式错误")
    private String email;
    
    @Size(min = 20, max = 30, message = "字符串长度要求20到30之间。")
    private String size;
    
    public Long getId() {
        return id;
    }
    
    public void setId(Long id) {
        this.id = id;
    }
    
    public Date getDate() {
        return date;
    }
    
    public void setDate(Date date) {
        this.date = date;
    }
    
    public Double getDoubleValue() {
        return doubleValue;
    }
    
    public void setDoubleValue(Double doubleValue) {
        this.doubleValue = doubleValue;
    }
    
    public Integer getInteger() {
        return integer;
    }
    
    public void setInteger(Integer integer) {
        this.integer = integer;
    }
    
    public Long getRange() {
        return range;
    }
    
    public void setRange(Long range) {
        this.range = range;
    }
    
    public String getEmail() {
        return email;
    }
    
    public void setEmail(String email) {
        this.email = email;
    }
    
    public String getSize() {
        return size;
    }
    
    public void setSize(String size) {
        this.size = size;
    }
    
    /**** setter and getter ****/
    
    }
    

    此时controller应该要加上@Valid ,否则不会验证!

    /***
    * 解析验证参数错误
    * @param vp —— 需要验证的POJO,使用注解@Valid 表示验证
    * @param errors  错误信息,它由Spring MVC通过验证POJO后自动填充
    * @return 错误信息Map
    */
    
    @RequestMapping(value = "/valid/validate")
    @ResponseBody
    public Map<String, Object> validate(
            @Valid @RequestBody ValidatorPojo vp, Errors errors) {
        Map<String, Object> errMap = new HashMap<>();
        // 获取错误列表
        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();
            errMap.put(key, msg);
        }
        return errMap;
    }
    

    除了@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


    在构造器使用

    public User(@NonNull String name) {
        this.name=name;
    }
    

    new User(null);//静态检查会报警告,运行时若使用了name的方法,会报异常

    相关文章

      网友评论

        本文标题:@NotNull和@NonNull区别和使用

        本文链接:https://www.haomeiwen.com/subject/qixyzqtx.html