欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

@NotNull 等验证注解使用

程序员文章站 2022-07-10 20:55:41
之前我们验证参数使用的是 if - else 配置工具类中的 Xxxx.isNull() 等方法。这样使得代码冗余,影响美观。现在可以优雅的使用注解进行参数验证,示例分为两种:①在形参上使用注解验证;②对形参对象中的属性进行验证一、Maven 依赖⚠有坑:必须导入 “hibernate-validator” 依赖,否则验证不起作用 javax.validation

之前我们验证参数使用的是 if - else 配置工具类中的 Xxxx.isNull() 等方法。这样使得代码冗余,影响美观。

现在可以优雅的使用注解进行参数验证,示例分为两种:①在形参上使用注解验证;②对形参对象中的属性进行验证

一、Maven 依赖

⚠有坑:必须导入 “hibernate-validator” 依赖,否则验证不起作用

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
</dependency>

二、在形参上使用注解验证

@RestController
@Slf4j
@Validated
public class AnnotationController {
    @RequestMapping("/find")
    public String findById(
            @RequestParam(name = "id", required = false)
            @NotNull(message = "查询 ID 为空!") String id) {

        log.info("需要查询的 id ==> " + id);
        return "success ==> id:" + id;
    }
}

⚠注意点:若使用形参验证,需要在类上添加 @Validated 注解,否则验证不起作用

【测试】
1、前台未传入参数,即 id = null,此时前台出现 500 异常
@NotNull 等验证注解使用
2、后台异常

javax.validation.ConstraintViolationException: findById.id: 查询 ID 为空!
	at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:116) ~[spring-context-5.2.7.RELEASE.jar:5.2.7.RELEASE]
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186) ~[spring-aop-5.2.7.RELEASE.jar:5.2.7.RELEASE]
.....

三、对形参对象中的属性进行验证

1、【PersonDTO.java】

@Data
public class PersonDTO implements Serializable {
    private static final long serialVersionUID = -3565776723852112655L;

    @NotNull(message = "人员 ID 不能为空!")
    private String id;
    @NotBlank(message = "人员 name 不能为空!")
    private String name;
    private Integer age;
    /**
     * 0 ——> 男   1 ——> 女   其他 ——> 未知
     */
    private String gender;
}

2、【AnnotationController.java】

@RestController
@Slf4j
public class AnnotationController {
    @RequestMapping("/find/person")
    public String find(@Valid PersonDTO personDTO) {
        log.info("形参中的 PersonDTO ==> " + personDTO);
        return personDTO.toString();
    }
}

⚠注意点:若使用对象封装参数验证,需要在对象形参前使用 @Valid 注解,否则验证不起作用

【测试】
① 前台未传入参数,即 person 中各个属性均为 null,此时前台出现 400 异常
@NotNull 等验证注解使用
② 后台异常

Field error in object 'personDTO' on field 'name': rejected value [null]; codes 
[NotBlank.personDTO.name,NotBlank.name,NotBlank.java.lang.String,NotBlank]; arguments 
[org.springframework.context.support.DefaultMessageSourceResolvable: codes [personDTO.name,name]; 
arguments []; default message [name]]; default message [人员 name 不能为空!]

Field error in object 'personDTO' on field 'id': rejected value [null]; codes 
[NotNull.personDTO.id,NotNull.id,NotNull.java.lang.String,NotNull]; arguments 
[org.springframework.context.support.DefaultMessageSourceResolvable: codes [personDTO.id,id]; 
arguments []; default message [id]]; default message [人员 ID 不能为空!]]

四、常用验证注解

空检查
@Null			验证对象是否为null
@NotNull		验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank		检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty		检查约束元素是否为NULL或者是EMPTY. 

Booelan检查
@AssertTrue		验证 Boolean 对象是否为 true  
@AssertFalse	验证 Boolean 对象是否为 false  

长度检查
@Size(min=, max=)		验证对象(Array,Collection,Map,String)长度是否在给定的范围之内  
@Length(min=, max=)		验证注解的元素值长度在min和max区间内

日期检查
@Past		验证 Date 和 Calendar 对象是否在当前时间之前  
@Future		验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern	验证 String 对象是否符合正则表达式的规则

数值检查,建议使用在Stirng,Integer类型,不建议使用在int类型上,因为表单值为“”时无法转换为int,但可以转换为Stirng为"",Integer为null
@Min			验证 Number 和 String 对象是否大等于指定的值  
@Max			验证 Number 和 String 对象是否小等于指定的值  
@DecimalMax		被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin		被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits			验证 Number 和 String 的构成是否合法  
@Digits(integer=,fraction=)		验证字符串是否是符合指定格式的数字,interger指定整数精度,fraction指定小数精度。

@Range(min=, max=)	验证注解的元素值在最小值和最大值之间
@Range(min=10000,max=50000,message="range.bean.wage")
private BigDecimal wage;

@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email  验证是否是邮件地址,如果为null,不进行验证,算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)

本文地址:https://blog.csdn.net/yage124/article/details/107482837

相关标签: 学习总结