springboot自定义校验注解的实现过程

 更新时间:2023年11月30日 14:44:53   作者:xiaoxust  
这篇文章主要介绍了springboot自定义校验注解的实现过程,本文结合示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧

通过谷粒商城项目学习了自定义校验器的实现

近日在学习雷神的谷粒商城项目,其中有一个自定义校验的实现,记录一下学习的过程。下面是自定义校验实现的三个过程。

提示:以下是本篇文章正文内容,下面案例可供参考

一、编写自定义校验注解

1.假如我们要自定义一个校验注解,该注解是判断该字段是否为0,1。如果不是0或者1,则校验报错。

@ListValue(vals={0,1})
private Integer showStatus;

2.进行自定义注解的创建,注意创建类型为Annotation

在这里插入图片描述

3.查看其它自定义注解,发现都有三个元数据

String message() default "{javax.validation.constraints.NotBlank.message}";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};

将这三条数据编写进入自定义注解里面

4.因为我们自定义注解还包含了vals这个数组,所以我们需要创建一个这样的数据数据。

int[] vals() default {};

5.引入相关的注解,观看其他注解,发现基本上实现了下面的注解

@Documented
@Constraint(
        validatedBy = {ListValueConstraintValidator.class}//使用哪个注解校验器
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})//在那些上面可以使用,方法,字段等
@Retention(RetentionPolicy.RUNTIME)//运行时获取

下面是自定义注解整个代码的实现:

package com.atguigu.common.valid;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
@Documented
@Constraint(
        validatedBy = {ListValueConstraintValidator.class}
)
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
    int[] vals() default {};
}

二、自定义注解的校验器

1.在自定义注解里面,有一个引用哪个校验器的字段validatedBy,点进去看一下,发现实现了这个接口:ConstraintValidator

2.创建一个自定义校验器,实现上面的校验器接口

implements ConstraintValidator<ListValue,Integer>//第一个字段写入自定义注解的名字,第二个我们校验的属性是Integer类型,所以填入Integer

3.ConstraintValidator的实现,有两个方法,一个是初始化,一个是校验

    private Set<Integer> set = new HashSet<>();
    //初始化方法
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();//包含咱们自定义注解中的vals的值[0,1]
        for (int val : vals) {
            set.add(val);
        }
    }
    //判断是否校验成功
    /**
     *
     * @param integer 需要判断的值,比如传入3,是否符合0,1状态
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(integer);
    }

三、关联自定义的校验器和自定义的校验注解

在自定义注解里面引入自定义注解的校验器

validatedBy = {ListValueConstraintValidator.class【可以指定多个校验器,校验不同类型的值】}

总结

自定义校验的实现三个步骤

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

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

 3).关联自定义的校验器和自定义的校验注解validatedBy = {ListValueConstraintValidator.class【可以指定多个校验器,校验不同类型的值】}

到此这篇关于springboot自定义校验注解的实现的文章就介绍到这了,更多相关springboot自定义校验注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 对handlerexecutionchain类的深入理解

    对handlerexecutionchain类的深入理解

    下面小编就为大家带来一篇对handlerexecutionchain类的深入理解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-07-07
  • java中求高精度除法,要求保留N位小数

    java中求高精度除法,要求保留N位小数

    这篇文章主要介绍了java中求高精度除法,要求保留N位小数的实现,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • Java项目NoProviderFoundException报错的解决方案

    Java项目NoProviderFoundException报错的解决方案

    在Java开发中,jakarta.validation.NoProviderFoundException 是一个令人困惑的运行时错误,常因校验框架依赖缺失或版本冲突导致,本文给大家介绍了Java项目NoProviderFoundException报错的解决方案,需要的朋友可以参考下
    2025-06-06
  • Ubuntu快速安装jdk的教程

    Ubuntu快速安装jdk的教程

    这篇文章主要为大家详细介绍了Ubuntu快速安装jdk的教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • 使用Spring实现@Value注入静态字段

    使用Spring实现@Value注入静态字段

    这篇文章主要介绍了使用Spring实现@Value注入静态字段方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-05-05
  • Java设计模式之适配器模式详解

    Java设计模式之适配器模式详解

    这篇文章主要介绍了Java设计模式之适配器模式详解,适配器模式将一个类的接口转换成客户希望的另一个接口,Adapter模式使得原本由于接口不兼容而不能一起工作的哪些类可以一起工作,需要的朋友可以参考下
    2023-09-09
  • java中超过int的最大范围问题

    java中超过int的最大范围问题

    文章讨论了Java中处理超过int最大范围的整数问题,在接收到超过int范围的参数时,直接转换会引发异常,建议使用Long或BigInteger处理,提供了代码示例,包括JSP页面和Servlet处理逻辑
    2026-05-05
  • Java对象数组定义与用法详解

    Java对象数组定义与用法详解

    这篇文章主要介绍了Java对象数组定义与用法,结合实例形式分析了java对象数组的概念、功能、定义与使用方法,需要的朋友可以参考下
    2019-08-08
  • Java使用NIO包实现Socket通信的实例代码

    Java使用NIO包实现Socket通信的实例代码

    本篇文章主要介绍了Java使用NIO包实现Socket通信的实例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • Java精品项目瑞吉外卖之后端登录功能篇

    Java精品项目瑞吉外卖之后端登录功能篇

    这篇文章主要为大家详细介绍了java精品项目-瑞吉外卖订餐系统,此项目过大,分为多章独立讲解,本篇内容为后端登录功能的实现,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05

最新评论