spring boot项目自定义参数校验规则示例详解

 更新时间:2023年07月07日 08:18:43   作者:酱油何在  
这篇文章主要介绍了spring boot项目如何自定义参数校验规则,自定义校验规则和自带的规则实现方式一样,先自定义一个注解,然后指定校验类,在校验类里实现具体的校验规则,本文结合示例代码给大家介绍的非常详细,需要的朋友可以参考下

spring boot项目对参数进行校验时,比如非空校验,可以直接用validation包里面自带的注解。但是对于一些复杂的参数校验,自带的校验规则无法满足要求,此时需要我们自定义参数校验规则。自定义校验规则和自带的规则实现方式一样,先自定义一个注解,然后指定校验类,在校验类里实现具体的校验规则。

下面以校验手机号为例,来实现自定义参数校验规则。

首先定义一个注解,直接照着NotNull注解定义即可。

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
//这里的class就是实现具体校验规则的类
@Constraint(validatedBy = {MobileNoValidator.class})
public @interface MobileNo {
    String message() default "请输入正确的手机号";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

然后定义实现具体校验规则的类,这个类要实现ConstraintValidator接口。

public class MobileNoValidator implements ConstraintValidator<MobileNo, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if ((value == null)) {
            return false;
        }
        String regex = "^1\\d{10}$";
        Pattern p = Pattern.compile(regex, Pattern.CASE_INSENSITIVE);
        Matcher m = p.matcher(value);
        return m.matches();
    }
}

这样,很简单的两个类,就实现了自定义参数校验规则。当参数中加了MobileNo注解,如果输入的手机号不满足1打头的11位数字的规则,就会抛出异常信息。下面写个controller简单测试一下。

先定义一个vo。

public class UserVo {
    @NotNull
    private Long id;
    @NotNull
    @MobileNo
    private String mobileNo;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getMobileNo() {
        return mobileNo;
    }
    public void setMobileNo(String mobileNo) {
        this.mobileNo = mobileNo;
    }
}

再定一个controller。

@RestController
public class UserController {
    @PostMapping(value = "/test")
    public String test(@Validated @RequestBody UserVo userVo) {
        return "success";
    }
}

启动项目,用postman测试一下。

首先输入符合要求的手机号,这时是能正常返回success。

然后输入一个不符合要求的手机号,会返回400错误码,错误信息如下。当然这里返回的错误信息比较不友好,实际项目中可以对参数校验异常统一拦截,返回需要的数据格式。

到此这篇关于spring boot项目如何自定义参数校验规则的文章就介绍到这了,更多相关spring boot自定义参数校验规则内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Springboot整合xxl-job实现动态传参

    Springboot整合xxl-job实现动态传参

    XXL-JOB是一个分布式任务调度平台,本文主要介绍了Springboot整合xxl-job实现动态传参,具有一定的参考价值,感兴趣的可以了解一下
    2025-03-03
  • 教你用Java Swing做一个定时提醒工具

    教你用Java Swing做一个定时提醒工具

    今天给大家带来的是Java的相关知识,文章围绕着如何用Java做一个定时提醒工具展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • spring boot + quartz集群搭建的完整步骤

    spring boot + quartz集群搭建的完整步骤

    这篇文章主要给大家介绍了关于spring boot + quartz集群搭建的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2018-05-05
  • java 抽象类示例详解

    java 抽象类示例详解

    我们将“只有方法声明,没有方法体”的一类方法统称为抽象方法,抽象方法用关键字abstract修饰,本文介绍java 抽象类示例详解,感兴趣的朋友跟随小编一起看看吧
    2024-12-12
  • Spring中的InitializingBean接口的使用

    Spring中的InitializingBean接口的使用

    这篇文章主要介绍了Spring中的InitializingBean接口的使用,需要的朋友可以参考下
    2018-04-04
  • 解决javac不是内部或外部命令,也不是可运行程序的报错问题

    解决javac不是内部或外部命令,也不是可运行程序的报错问题

    在学着使用Java的命令行来编译java文件的时候,遇到了这个问题,本文主要介绍了解决javac不是内部或外部命令,也不是可运行程序的报错问题,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-04-04
  • Logback MDCAdapter日志跟踪及自定义效果源码解读

    Logback MDCAdapter日志跟踪及自定义效果源码解读

    这篇文章主要为大家介绍了Logback MDCAdapter日志跟踪及自定义效果源码解读,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • java 对象的序列化和反序列化详细介绍

    java 对象的序列化和反序列化详细介绍

    这篇文章主要介绍了java 对象的序列化和反序列化的相关资料,需要的朋友可以参考下
    2016-10-10
  • RabbitMQ排他性队列Exclusive Queue详解

    RabbitMQ排他性队列Exclusive Queue详解

    这篇文章主要介绍了RabbitMQ排他性队列Exclusive Queue详解,如果你想创建一个只有自己可见的队列,即不允许其它用户访问,RabbitMQ允许你将一个Queue声明成为排他性的Exclusive Queue,需要的朋友可以参考下
    2023-08-08
  • Spring 使用注解方式进行事务管理配置方式

    Spring 使用注解方式进行事务管理配置方式

    本篇文章主要介绍了Spring 使用注解方式进行事务管理配置方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-04-04

最新评论