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

全栈程序员站长

发布于 2022-06-27 09:01:29

1.3K0

发布于 2022-06-27 09:01:29

文章被收录于专栏：全栈程序员必看

大家好，又见面了，我是你们的朋友全栈君。

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

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

使用方式

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

@NotNull

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

@Min

有写数值类型的需要限制范围, 例如: 时间需要大于0

@valid

在需要校验的接口的入参前加上@valid注解

验证生效

这两个地方加上注解就可以了

进阶

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

注解接口

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

注意: 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);
        }
    }
}