spring mvc 使用@notNull 注解验证请求参数

水深无声 2022-02-22 15:54 308阅读 0赞

### spring mvc 使用@notNull 注解验证请求参数 ###

*  使用方式
 *   *  @NotNull
     *  @Min
     *  @valid
     *  验证生效
 *  进阶
 *   *  注解接口
     *  校验逻辑实现
     *  自定义注解使用
 *  其他校验注解

> 处理请求时, 有些参数是必传或者必须遵循某些规则的, 如果针对每个请求都写一遍验证的话相当繁琐, 而且代码维护起来也麻烦, 正好框架将参数校验的功能抽象处理啊了, 我们可以利用这个完成80%的校验场景

# 使用方式 #

使用起来很简单, 只需要加上几个注解即可

## @NotNull ##

在需要验证的非空字段前面加上`@NotNull`注解(注解还可设置提示语), 如下  
![@NotNull注解][NotNull]

## @Min ##

有写数值类型的需要限制范围, 例如: 时间需要大于0  
![时间戳应该大于0][0]

## @valid ##

在需要校验的接口的入参前加上`@valid`注解  
![入参前加上][20190409165557191.png]

## 验证生效 ##

这两个地方加上注解就可以了  
![生效图示][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MjA4ODQ0_size_16_color_FFFFFF_t_70]

# 进阶 #

有时候默认的非空或者范围校验不能满足部分定制化的需求  
我们可以通过自定义校验注解来按我们的凡是校验数据

## 注解接口 ##

定义一个自己的注解(检验逻辑入口)

> 注意:  
> `Class<?>[] groups() default {};`  
> `Class<? extends Payload>[] payload() default {};`  
> 这两个是必须的…

@Target(value= { METHOD, FIELD, ANNOTATION_TYPE})
    @Retention(RUNTIME)
    @Constraint(validatedBy = CheckEvaluationKeyValidator.class)
    @Documented
    public @interface CheckEvaluationKey { 
        String message() default "{CheckEvaluationKey}";
    
        Class<?>[] groups() default { };
        
        Class<? extends Payload>[] payload() default { };
    
        String evaluationKey() default "";
    }

## 校验逻辑实现 ##

实现校验逻辑, 需要在自定义注解中指定使用的校验逻辑  
`@Constraint(validatedBy = CheckEvaluationKeyValidator.class)`  
系统就会更具注解自动进入我们的校验逻辑

public class CheckEvaluationKeyValidator implements ConstraintValidator<CheckEvaluationKey, String> { 
    
        private String checkEvaluationKey;
        
        @Override
        public void initialize(CheckEvaluationKey constraintAnnotation) { 
            this.checkEvaluationKey = constraintAnnotation.evaluationKey();
        }
        
        @Override
        public boolean isValid(String value, ConstraintValidatorContext context) { 
            
            if (JudgeUtil.isNull(checkEvaluationKey)) { 
                String evaluationName = EvaluationEnum.getEvaluationNameWithOutAssert(value);
                return JudgeUtil.isPresent(evaluationName);
                
            } else { 
                return JudgeUtil.equals(value, checkEvaluationKey);
            }
        }
    }

## 自定义注解使用 ##

![自定义注解使用][20190409170037774.png]

# 其他校验注解 #

*  `@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`: 被注释的元素必须在合适的范围内

[NotNull]: /images/20220222/3a468a5563bd4ee6b55eb2433b454be8.png
[0]: /images/20220222/e685e733772d4605a4cb18203425d8da.png
[20190409165557191.png]: /images/20220222/0b85122fda52427aad36348df34d0df2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM0MjA4ODQ0_size_16_color_FFFFFF_t_70]: /images/20220222/f56068bc0f9e49f8b066aa706fb932d7.png
[20190409170037774.png]: /images/20220222/c89ea7aaf6794d99a8be8e3396aae0e3.png