spring 参数校验Validation示例详解

更新时间：2024年12月30日 11:59:17 作者：初晴~

Spring提供了Validation工具类来实现对客户端传来的请求参数的有效校验,本文给大家介绍spring 参数校验Validation示例详解,感兴趣的朋友一起看看吧

前言

在实际开发中，我们无法保证客户端传来的请求都是合法的。比如一些要求必传的参数没有传递，传来的参数长度不符合要求等，这种时候如果放任不管，继续执行后续业务逻辑，很有可能就会出现意想不到的bug。

有人可能会说，这不是前端的问题吗，让前端校验去。话是这么说，但我们也不能前端校验百分百不会出现问题。并且有些请求可能也不是正规通过客户端发来的，可能是黑客恶意攻击，又或是通过Postman等发来的，这些请求就不一定会“合法”了。

因此，对客户端传来的每个请求都进行必要的参数校验是十分重要的。而很多简单的校验如果都需要程序员自己去写的话，就会导致代码过于冗长、繁琐。为了让校验更加简洁明了，Spring为我们提供了Validation工具类来提供各种校验方法。

一、Validation常见的校验注解

空校验注解：

@Null：被注释的元素必须为null。
@NotNull：被注释的元素必须不为null。
@NotBlank：被注释的字符串去掉前后空格后长度必须非零。
@NotEmpty：被注释的字符串、集合或数组不能为空（字符串长度非零、集合大小非零）。

布尔校验注解：

@AssertTrue：被注释的元素必须为true。
@AssertFalse：被注释的元素必须为false。

日期校验注解：

@Past：被注释的元素必须是一个过去的日期。
@Future：被注释的元素必须是一个将来的日期。

数字校验注解：

@Min(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值。
@Max(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值。
@DecimalMin(value)：被注释的元素必须是一个数字，其值必须大于等于指定的最小值。
@DecimalMax(value)：被注释的元素必须是一个数字，其值必须小于等于指定的最大值。

长度校验注解：

@Size(max, min)：被注释的元素（如字符串、集合、数组）的大小必须在指定的范围内。

模式匹配校验注解：

@Pattern(regexp)：被注释的元素必须符合指定的正则表达式。

邮箱校验注解：

@Email：被注释的元素必须是电子邮箱地址。

范围校验注解：

@Range(min, max)：被注释的元素必须在合适的范围内。

二、Validation的简单应用

首先我们需要导入Validation的依赖：

<!--validation依赖,负责参数校验-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

接着在需要使用校验的类上添加@Validation注解

接着主要有两种方式使用校验注解：

1、直接在对应参数上加上注解

@RestController
@RequestMapping("/user")
@Validation
public class UserController {
    @RequestMapping("/login")
    public Result login(@Size(max = 12,min = 4) String username, @Pattern(regexp = "^\\S{5,16}$") String password){
        //登录
        return Result.success();
    }
}

2、实体类添加校验

对于一些实体类来说，直接在参数上加注解就不太可取了，程序会无法定位到指定参数。

需要再实体类内部对应的变量上添加注解：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Category {
    @NotNull
    private Integer id;//主键ID
    @NotEmpty
    private String categoryName;//分类名称
    @NotEmpty
    private String categoryAlias;//分类别名
    private Integer createUser;//创建人ID
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime createTime;//创建时间
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    private LocalDateTime updateTime;//更新时间
}

接着在使用实体类的地方加上 @Validated 注解，就能让这些校验生效了：

@PutMapping("/update")
    public Result update(@RequestBody @Validated User user){
        //业务逻辑
        return Result.success();
    }

三、分组校验

前面我们介绍了如何在实体类中添加校验注解。但是，事实上在实现不同功能时，对同一个实体类的校验规则可能是会有差异的。

比如在添加用户的场景下，用户的id值就是在存入数据库后生成的，在参数传递时自然就不是必传项；而在更新用户的场景下，我们需要通过id定位指定用户，完成信息更新操作，这时在参数传递时id就是必传项了。

这样，对id值的校验就会产生冲突了。如果将id设定为必传值，那么就会导致添加用户的操作可能出现错误。不把id设定为必传值，更新用户的操作又会出现错误。

为了应对这一问题，就可以对校验项进行分组归类。具体操作步骤如下：

在实体类内部定义相应组别接口：

public class User {
    //各成员变量
    //添加用户类分组
    public interface Add extends Default {
    }
    //更新用户类分组
    public interface Update extends Default{
    }
}

注意：如果没有手动对校验项进行分组，其默认就在 Default 组

对校验项进行分组，只需要通过groups属性指定组别即可：

@NotNull(groups = Update.class)

接着在校验时指定对应的分组即可：

@PutMapping
public Result update(@RequestBody @Validated(User.Update.class) User user){
    //业务逻辑
    return Result.success();
}

@PostMapping
public Result add(@RequestBody @Validated(User.Add.class) User user){
    //业务逻辑
    return Result.success();
}

这样就能实现不同业务场景下的多样化校验了。

四、自定义校验

实际开发中的校验规则可能是五花八门的，但官方提供的校验注解就这么多，很多时候并不能满足我们的校验需求。这时候就需要通过自定义校验注解来实现个性化的校验了。

首先需要定义一个注解：

@Documented //元注解
@Target(ElementType.FIELD) //元注解
@Retention(RetentionPolicy.RUNTIME) //元注解
@Constraint(validatedBy = {/*校验规则*/}) //自定义校验规则
public @interface State {
    //提供校验失败后的提示信息
    String message() default "state参数的值只能是已发布或草稿";
    //指定分组
    Class<?>[] groups() default {};
    //负载  获取到State注解的附加信息
    Class<? extends Payload>[] payload() default {};
}

接着定义一个类去实现 ConstraintValidator 接口，并实现 isValid 方法：

public class StateValidation implements ConstraintValidator<State,String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext constraintValidatorContext) {
        //返回true表示校验通过，返回false则表示校验不通过
        if(value==null) return false;
        if(value.equals("已发布")||value.equals("草稿"))return true;
        return false;
    }
}

然后就要在之前定义的注解中的@Constraint中填入自定义类：

 @Constraint(validatedBy = {StateValidation.class}) //自定义校验规则

接着就可以像使用其它校验注解一样来使用自己自定义的注解了：

那么本篇文章就到此为止了，如果觉得这篇文章对你有帮助的话，可以点一下关注和点赞来支持作者哦。如果有什么讲的不对的地方欢迎在评论区指出，希望能够和你们一起进步✊

到此这篇关于spring 参数校验Validation的文章就介绍到这了,更多相关spring 参数校验Validation内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java多线程编程中使用Condition类操作锁的方法详解
Condition是java.util.concurrent.locks包下的类,提供了对线程锁的更精细的控制方法,下面我们就来看一下Java多线程编程中使用Condition类操作锁的方法详解
2016-07-07
Java掩码的几种使用例举
今天小编就为大家分享一篇关于Java掩码的使用，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧
2019-03-03
解析springboot整合谷歌开源缓存框架Guava Cache原理
本文主要为大家解析了springboot整合谷歌开源缓存框架Guava Cache的原理以及在实际开发过程中的使用，附含源码，有需要的朋友可以参考下
2021-08-08
RabbitMQ 3.9.7 镜像模式集群与Springboot 2.5.5 整合
今天我们来聊聊 RabbitMQ 3.9.7 镜像模式集群与Springboot 2.5.5 整合，本文通过实例代码给大家介绍的非常详细，需要的朋友参考下吧
2021-10-10
Java基础篇之反射机制详解
本文详细讲解了Java基础篇之反射机制，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-01-01
IDEA生成servlet程序的实现步骤
这篇文章主要介绍了IDEA生成servlet程序的实现步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-03-03
Spring Security更换加密方式的完整方案
随着现在对软件系统安全性要求的越来越严苛,对于很多项目,升级密码都是势在必行的,若项目使用Spring Security框架,只需稍作修改,便可达到更换加密方式,所以本文给大家介绍了Spring Security更换加密方式的完整方案,需要的朋友可以参考下
2025-12-12
Java使用map实现带过期时间的缓存机制
在 Java 开发领域,缓存机制的构建通常依赖于 Redis 等专业缓存数据库,这类解决方案虽能提供强大的缓存能力,但引入中间件意味着增加系统架构复杂度、部署成本与运维负担,本文将深入探讨一种轻量级替代方案基于 Java 原生Map实现的带过期时间的缓存机制
2025-04-04
Java中FileOutputStream类的使用
java.io.FileOutputStream类是文件输出流,用于将数据写出到文件,下面就来介绍一下Java中FileOutputStream类的使用,具有一定的参考价值,感兴趣的可以了解一下
2023-10-10
java中自定义Spring Security权限控制管理示例（实战篇）
本篇文章主要介绍了java中自定义Spring Security权限控制管理示例（实战篇），具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
2017-02-02