百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

SpringBoot如何实现优雅的参数校验

ztj100 2025-05-11 19:46 31 浏览 0 评论

平常业务中肯定少不了校验,如果我们把大量的校验代码夹杂到业务中,肯定是不优雅的,对于一些简单的校验,我们可以使用java为我们提供的api进行处理,同时对于一些较为复杂的关联校验,spring也为我们提供了一些处理方式。更加复杂校验的话,只能进行代码逻辑处理了。

@Valid

Java定义的一套基于注解的数据校验规范,比如@Null、@NotNull、@Pattern等,它们位于
javax.validation.constraints这个包下,
它是JSR 303规范的一部分,主要用于Hibernate Validation等场景

@Valid注解是支持嵌套验证,同时可以配合BindingResult可以直接提供参数验证结果。

@Valid注解可以用在方法、构造函数、方法参数和成员属性上(方法, 构造器, 参数,字段, 泛型)

@Validated

Spring框架特有的注解,属于Spring的一部分,也是JSR 303的一个变种。在JSR 303基础上增加了一些其他校验注解,如 @NotBlank、@NotEmpty、@Length等,它们位于
org.hibernate.validator.constraints这个包下。

@Validated注解在
org.springframework.validation.annotation包下。

@Validated注解对@Valid进行了二次封装,在使用上并没有区别。支持分组校验,不支持嵌套验证。

@Validated注解可以用在类型、方法和方法参数上(类, 方法, 参数)。但不能用于成员属性。

依赖

hibernate validator框架已经集成在 spring-boot-starter-web中,所以无需再添加其他依赖。如果不是Spring Boot项目,需要添加如下依赖。

<dependency>
  <groupId>org.hibernate.validator</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>6.0.9.Final</version>
</dependency>

BindingResult

BindingResult用在实体类校验信息返回结果绑定。

该类作为方法入参,要写在实体对象后面。

@PostMapping(value = "/test")
public String test(@RequestBody @Validated ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
    if (bindingResult.hasErrors()) {
        List<ObjectError> allErrors = bindingResult.getAllErrors();
        for (ObjectError allError : allErrors) {
            return allError.getDefaultMessage();
        }
    }
    return "成功";
}

@Valid中的常用注解

注解

说明

@AssertFalse

只能用在boolean类型的字段上,验证 boolean类型值是否为 false

@AssertTrue

只能用在boolean类型的字段上,验证 boolean 类型值是否为 true

@DecimalMax(value)

支持字符串和任意数字类型,验证数字的大小是否小于等于指定的值,小数存在精度,22=22.00

@DecimalMin(value)

支持字符串和任意数字类型,验证数字的大小是否大于等于指定的值,小数存在精度

@Digits(integer, fraction)

验证数字是否符合指定格式。integer代表整数位置的最大位数;fraction代表小数位置的最大数位

@Email

验证字符串是否符合电子邮件地址的格式

@Future

验证一个日期或时间是否在当前时间之后,支持Date、Calendar、Instant、LocalDate、LocalDateTime、LocalTime、MonthDay、OffsetDateTime、

OffsetTime、Year、YearMonth、ZonedDateTime、HijrahDate、JapaneseDate、MinguoDate、

ThaiBuddhistDate

@past

支持Date、Calendar、Instant、LocalDate、LocalDateTime、LocalTime、MonthDay、OffsetDateTime、OffsetTime、Year、YearMonth、ZonedDateTime、HijrahDate、JapaneseDate、MinguoDate、ThaiBuddhistDate

@PastOrPresent

验证一个日期或时间是否在当前时间之前或等于当前时间

@FutureOrPresent

验证一个日期或时间是否在当前时间之后或等于当前时间

@Max(value)

验证数字的大小是否小于等于指定的值

@Min(value)

验证数字的大小是否大于等于指定的值

@Negative

验证数字是否是负整数,0无效

@NegativeOrZero

验证数字是否是负整数

@NotBlank

验证字符串不能为空null或"",只能用于字符串验证

@NotEmpty

验证对象不得为空,可用于Map和数组

@NotNull

验证对象不为 null

@Null

验证对象必须为 null

@Pattern(value)

验证字符串是否符合正则表达式的规则

@Positive

验证数字是否是正整数,0无效

@PositiveOrZero

验证数字是否是正整数

@Size(max, min)

验证对象(字符串、集合、数组)长度是否在指定范围之内

@Digits(integer, fraction)举例:

//最大支持99.99,因为整数位最多两位,小数位最多两位
@Digits(integer = 2,fraction = 2)
private Integer name;

@Validate中的常用注解

注解

说明

@Range

@Max+@Min的范围

@Length

字符串长度在指定范围内

@DecimalMin(value)

支持字符串和任意数字类型,验证数字的大小是否大于等于指定的值,小数存在精度

自定义校验

《自定义validation注解的应用》

分组校验

这一篇文章里写的是我们动态的指定那些校验生效

《使用Hibernate的validator做多字段联合校验》

实际上我们可以在校验入库处指定哪个分组的校验生效,在每一个校验注解中,都有一个Class<?>[] groups() default { }字段,这个字段不写呢默认就是Default分组,但是我们也可以对这些校验指定分组,然后在校验入口处@Validated注解中指定校验的分组。

使用

  • 单参数校验
@RestController
//
@Validated
public class ValidController {
    @GetMapping(value = "/test1")
    public String test(@NotBlank(message = "name字段不能为空") String name){
        return "success";
    }
}
  • 多参数校验

被校验参数实体类

public class ValidTest {
    @Length
    private String name;
  	//注意这里要使用@Valid而不是@Validated
  	//@Validated不支持嵌套校验
    @Valid
    private Inner inner;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
    public static class Inner{
        @NotBlank(message = "地址不能为空!")
        private String address;

        public String getAddress() {
            return address;
        }

        public void setAddress(String address) {
            this.address = address;
        }
    }
}
@RestController
public class ValidController {
    @PostMapping(value = "/test")
  	//这里使用@Validated或者@Valid都可以
    public String test(@RequestBody @Validated ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
        httpServletResponse.setHeader("content-type","application/json;charset=UTF-8");
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                return allError.getDefaultMessage();
            }
        }
        return "success";
    }
}
  • 分组校验
//新建新增分组
public interface Add {
}
//新建变更分组
public interface Update {
}

被校验参数实体类

public class ValidTest {
  	//只有新增分组的时候校验
    @Length(groups = Add.class,max = 3,message = "name length is too long")
    private String name;
  	//只有变更分组的时候校验
    @NotBlank(message = "path is blank!",groups = Update.class)
    private String path;
    @Valid
    private Inner inner;

    public String getPath() {
        return path;
    }

    public void setPath(String path) {
        this.path = path;
    }

    public Inner getInner() {
        return inner;
    }

    public void setInner(Inner inner) {
        this.inner = inner;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
    public static class Inner{
      	//只有变更分组的时候校验
        @NotBlank(message = "address is blank!",groups = Update.class)
        private String address;

        public String getAddress() {
            return address;
        }

        public void setAddress(String address) {
            this.address = address;
        }
    }
}
@RestController
public class ValidController {
    @PostMapping(value = "/group")
  	//增加变更分组
    public String group(@RequestBody @Validated(Update.class) ValidTest validTest, BindingResult bindingResult, HttpServletResponse httpServletResponse){
        httpServletResponse.setHeader("content-type","application/json;charset=UTF-8");
        if (bindingResult.hasErrors()) {
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError allError : allErrors) {
                return allError.getDefaultMessage();
            }
        }
        return "success";
    }
}
  • 统一字段多个校验
public class ValidTest {
  	//大部分注解都是支持这么做的,在同一个字段上使用集合进行多次校验
    @Length.List(value = {
            @Length(min = 1,message = "name length is too short"),
            @Length(max = 4,message = "name length is too long")
    })
    private String name;
    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
   
}
  • 组序列

默认情况下 不同级别的约束验证是无序的,但是在一些情况下,顺序验证却是很重要。一个组可以定义为其他组的序列,使用它进行验证的时候必须符合该序列规定的顺序。在使用组序列验证的时候,如果序列前边的组验证失败,则后面的组将不再给予验证。

举个例子,这三个参数校验,我想先校验不能为空,如果再校验正则信息,一般情况下,校验是无序的,可能会先校验格式错误,在校验不能为空,这是不符合规定的,那么我们该怎么办呢?

//使用@GroupSequence定义分组顺序,校验执行顺序先执行Default分组,再执行Order1分组
@GroupSequence({Default.class,Order1.class})
public interface IGroup {
}
@Pattern(regexp = "^[0-9]+(\\.[0-9]{1,2})?#34;,message = "视联网能力收入金额(含税)(万元)格式错误",groups = Order1.class)
@NotBlank(message = "视联网能力收入金额(含税)(万元) 不能为空")
private String videoNetInfoAmount;

@Pattern(regexp = "^[0-9]+(\\.[0-9]{1,2})?#34;,message = "视联网能力收入占比 格式错误",groups = Order1.class)
@NotBlank(message = "视联网能力收入占比 不能为空")
private String incomeRate;

@Pattern(regexp = "^[0-9]{1,12}#34;,message = "连接数 格式错误",groups = Order1.class)
@NotBlank(message = "连接数 不能为空")
private String connectionsNum;

这样的话,会先校验Default分组的,校验通过以后,再校验Order1分组的。

获取校验器

如果我们不想使用注解@Valid或者@Validate进行校验的话,可以使用Validator进行编程式校验。

  • spring
//使用spring注入一个Validator
@Bean
public Validator validator() {
    LocalValidatorFactoryBean factoryBean = new LocalValidatorFactoryBean();
    factoryBean.setProviderClass(HibernateValidator.class);
    factoryBean.afterPropertiesSet();
    return factoryBean.getValidator();
}
@Autowired
private Validator validator;
//然后进行校验,默认分组下可以使用Default.class分组
validator.validate(videoNetInfo, IGroup.class);
  • 自定义
public class ValidationUtils {
		//创建一个校验器
    private final static Validator validator = Validation.buildDefaultValidatorFactory().getValidator();

    public static <T> void validate(T t) {
        validate(t,Default.class);
    }
    public static <T> void validate(T t,Class<?> clazz) {
        if (t != null) {
            Set<ConstraintViolation<T>> validationSet = validator.validate(t, clazz);
            if (validationSet != null && validationSet.size() > 0) {
                ConstraintViolation<T> violation = validationSet.iterator().next();
                String errorMsg = "[" + violation.getPropertyPath() + "]" + violation.getMessage();
                throw new BusinessException(BusiOpportunityEnum.BUSI_OPPORTUNITY_ENUM_99.getCode(), errorMsg);
            }
        }
    }
}

备注:
org.hibernate.validator.internal.metadata.core.ConstraintHelper

相关推荐

sharding-jdbc实现`分库分表`与`读写分离`

一、前言本文将基于以下环境整合...

三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么

在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...

MySQL8行级锁_mysql如何加行级锁

MySQL8行级锁版本:8.0.34基本概念...

mysql使用小技巧_mysql使用入门

1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...

MySQL/MariaDB中如何支持全部的Unicode?

永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...

聊聊 MySQL Server 可执行注释,你懂了吗?

前言MySQLServer当前支持如下3种注释风格:...

MySQL系列-源码编译安装(v5.7.34)

一、系统环境要求...

MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了

对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...

MySQL字符问题_mysql中字符串的位置

中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...

深圳尚学堂:mysql基本sql语句大全(三)

数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...

MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?

大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...

一文讲清怎么利用Python Django实现Excel数据表的导入导出功能

摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...

用DataX实现两个MySQL实例间的数据同步

DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...

MySQL数据库知识_mysql数据库基础知识

MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...

如何为MySQL中的JSON字段设置索引

背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...

取消回复欢迎 发表评论: