使用JRS303校验对参数进行提前校验

文章目录

前言

我们在开发过程中前段发过来的请求大部分会携带一些参数，而这些参数大部分不是固定写好的，是变化的、随机的，是我们和前端一起商量好的模版。这样就会带来一些无法避免的问题，比如参数个数不匹配，又或者最最常见的空指针问题
在这里插入图片描述

或者我们限定了某个字段只能输入指定的值（例如只能输入0或者1），但是请求绕过了前端输入过来了其他的值所以后端判断的重要性就不言而喻了，我们很多时候都会在逻辑中进行参数判断，这样确实能够保证我们数据正常参与逻辑，但是每次都重复判断成为了我们代码上的“很大”的，有没有一种方法可以只判断一遍就可以在这个参数下一直使用呢？

有的那就是JRS303校验

JRS303简单使用版本

1.引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.在字段上加入校验注解
在这里插入图片描述

3.在控制层接口上加上注解@Valid
在这里插入图片描述

这样一个简单的校验就可以生效啦

JRS303提供的常用校验注解

@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=) Validates that the annotated string is between min and max included.
日期检查 
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期 
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期 
@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
数值检查 
建议使用在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”) 
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证) 
@CreditCardNumber信用卡验证 
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。 
@ScriptAssert(lang= ,script=, alias=) 
@URL(protocol=,host=, port=,regexp=, flags=)

但是在我们开发过程中并不是所有的都按照提供的注解进行的我们总有一些自己特殊的校验需求

JRS303进阶使用版本

情景一：对于一个主键id字段我想要新增的时候不校验但是更新的时候进行校验

这个时候我们就需要给校验进行一个分组指定什么情况下进行校验

1.在字段上指定校验规则和分组

在这里插入图片描述

2.可以直接写两个接口类不需要进行实现
在这里插入图片描述

3.在控制层上给接口添加分组类型 --此时的注解使用@Validated

在这里插入图片描述

情景二：在实际项目中我们有一些字段只能填入规定的几个值类似于枚举那么就需要我们编写自定义的校验注解了

例如：需要检验字段Status中的值是否为0或者1

    /**
     * 显示状态[0-不显示；1-显示]
     */
    private Integer Status;

1.编写一个自定义的校验注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @description: 自定义校验注解
 * @author: jd
 * @date: 2023-6-13 15:58:48
 */

/**
 * @Target
 * 功能描述：注解可以标记在哪些位置上
 * METHOD  方法
 * FIELD   属性（字段）
 * ANNOTATION_TYPE  注解
 * CONSTRUCTOR  构造器
 * PARAMETER  参数
 * TYPE_USE  使用在任何地方
 */
@Target({
    
     METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
/**
 * @Retention
 * 功能描述：在什么时候能获取到
 * RUNTIME 运行时获取
 */
@Retention(RUNTIME)
@Documented
/**
 * @Constraint
 * 功能描述：校验注解是使用哪个校验器校验的
 * 需要再 validatedBy = { } 中指定
 * 如果不在这里指定 就需要再初始化的时候指定
 */
@Constraint(validatedBy = {
    
    ListValueConstraintValidator.class })
public @interface ListValue {
    
    
    /**
     * message
     * 功能描述 :校验信息显示错误后  错误信息从哪里获取
     * 默认：javax.validation.constraints.NotNull.message 配置文件中获取
     */
    String message() default "{javax.validation.constraints.NotNull.message}";

    /**
     * groups
     * 功能描述：支持分组校验功能
     */
    Class<?>[] groups() default {
    
     };

    /**
     * Payload
     * 功能描述：支持自定义的负载信息
     */
    Class<? extends Payload>[] payload() default {
    
     };


}

2.编写一个自定义的校验器

import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

/**
 * @description: 自定义注解校验器
 * @author: jd
 * @date: 2023-06-13 16:27
 *
 * ConstraintValidator  两个参数  ListValue 校验的注解   Integer校验的类型
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
    
    

    private Set<Integer> set = new HashSet<>();


    //初始化方法  可以获取到注解的信息
    @Override
    public void initialize(ListValue constraintAnnotation) {
    
    

        //最好是加一个非空判断  防止判断的时候出现空指针
        int[] vals = constraintAnnotation.vals();
        for (int val : vals) {
    
    
            set.add(val);
        }

    }

    //判断是否校验成功  value 就是需要校验的值
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
    
    
        //看这个set中是否包含我们想要校验的值 如果包含返回true  不包含 返回false
        return set.contains(value);
    }
}

3.将校验器和校验注解进行关联

/**
 * @Constraint
 * 功能描述：校验注解是使用哪个校验器校验的
 * 需要再 validatedBy = { } 中指定
 * 如果不在这里指定 就需要再初始化的时候指定
 * 这个校验器还可以关联多个校验器，适配不同类型的校验
 */
@Constraint(validatedBy = {
    
    ListValueConstraintValidator.class })

这样我们就可以自己编写属于自己业务的校验注解了，会大大提高我们业务的处理能力和处理效率。