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自定义校验注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Springboot中如何使用过滤器校验PSOT类型请求参数内容

    Springboot中如何使用过滤器校验PSOT类型请求参数内容

    在Springboot中创建过滤器,用来过滤所有POST类型请求并获取body中的参数进行校验内容是否合法,该方法仅适用于POST类型请求,本文给大家介绍Springboot中如何使用过滤器校验PSOT类型请求参数内容,感兴趣的朋友一起看看吧
    2023-08-08
  • idea中MavenWeb项目不能创建Servlet的解决方案

    idea中MavenWeb项目不能创建Servlet的解决方案

    这篇文章主要介绍了idea中MavenWeb项目不能创建Servlet的解决方案,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-02-02
  • 从零开始学springboot整合feign跨服务调用的方法

    从零开始学springboot整合feign跨服务调用的方法

    这篇文章主要介绍了从零开始学springboot整合feign跨服务调用的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • Java for循环Map集合优化实现解析

    Java for循环Map集合优化实现解析

    这篇文章主要介绍了Java for循环Map集合优化实现解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01
  • Java使用OpenCV3.2实现视频读取与播放

    Java使用OpenCV3.2实现视频读取与播放

    这篇文章主要为大家详细介绍了Java使用OpenCV3.2实现视频读取与播放,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • Java8利用Stream实现列表去重的方法详解

    Java8利用Stream实现列表去重的方法详解

    这篇文章主要为大家介绍了Java利用Stream实现列表去重的几种方法详解,文中的示例代码讲解详细,需要的小伙伴可以参考一下
    2022-04-04
  • java实现html转pdf方法步骤

    java实现html转pdf方法步骤

    这篇文章主要给大家介绍了关于java实现html转pdf方法的相关资料,要将HTML转换成PDF,我们需要借助Java中的第三方库,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2023-08-08
  • java HashMap的keyset实例

    java HashMap的keyset实例

    简单地说,在keyset方法返回的set上做修改会改变原来hashmap,这也许不是你想要的,于是形成一个隐藏的bug
    2013-04-04
  • springboot中使用redis并且执行调试lua脚本

    springboot中使用redis并且执行调试lua脚本

    今天有个项目需要使用redis,并且有使用脚本的需求,本文主要介绍了springboot中使用redis并且执行调试lua脚本,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-04-04
  • springboot+vue实现阿里云oss大文件分片上传的示例代码

    springboot+vue实现阿里云oss大文件分片上传的示例代码

    阿里云推出了直传,本文主要介绍了springboot+vue实现阿里云oss大文件分片上传的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-06-06

最新评论