springboot进阶学习（十一）springboot验证机制@Valid和@Validated

最新推荐文章于 2024-07-19 17:23:52 发布

牛魔王sq

最新推荐文章于 2024-07-19 17:23:52 发布

阅读量1k

点赞数 1

分类专栏： springboot进阶学习文章标签： spring boot java

本文链接：https://blog.csdn.net/loveshanqian/article/details/107192546

版权

springboot进阶学习专栏收录该内容

18 篇文章 0 订阅

订阅专栏

springboot验证机制@Valid和@Validated

概述

在这里我们主要讲解@Valid和@Validated的使用方法，基本用法都是类似的，但在分组、注解位置、嵌套验证等功能上有所不同。

@Valid属于javax.validation包下,是jdk给提供的，@Valid不能分组
@Validated是org.springframework.validation.annotation包下的,是spring提供的。@Validated在@Valid之上提供了分组功能和验证排序功能
两个的注解位置有所不同
- @Validated：用在类、方法和方法参数上。但不能用于成员属性（field）
- @Valid：可以用在方法、构造函数、方法参数和成员属性（field）上

基础示例

使用方法总结：

简单参数直接使用验证规则@NotNull @Min等的时候，需要在类上加@Validated才可以开启验证。
实体参数直接使用@Validated或者@Valid就可以开启验证，类上不用再添加

下面开始我们的示例

我们创建一个实体类SysUser，里面对一些属性添加了简单的@NotNull和@Min验证，详细规则后面再讲。

@Data
public class SysUser {
    @NotNull(message = "id不能为空")
    @Min(value = 8, message = "id不能小于8位")
    private int id;
    @NotNull(message = "username不能为空")
    private String username;
    @NotNull(message = "password不能为空")
    private String password;
    private Date birthday;
    private String email;
}

创建ValidatedTestController测试类，主要测试@Validated

@RestController
@RequestMapping("validated")
@Validated
public class ValidatedTestController {
    //1、get方法普通参数
    @RequestMapping("user/{id}")
    public String selectById(@NotNull @Min(value = 8, message = "id不能小于8位") @PathVariable(name = "id") int id){
        System.out.println("参数id="+id);
        return "selectById请求成功";
    }

    // 2. get方法实体参数
    @RequestMapping("selectById")
    public String selectById2(@Validated SysUser sysUser){
        System.out.println("参数id="+sysUser.toString());
        return "selectById2请求成功";
    }

    // 3. post方法普通参数
    @PostMapping(path = "/addUser" )
    public String addUser(@NotNull @Min(value = 8, message = "id不能小于8位") @RequestBody String id) {
        System.out.println(id);
        return "addUser请求成功";
    }

    // 4. post方法实体参数
    @PostMapping(path = "/addUser2" )
    public String addUser2(@Validated @RequestBody SysUser sysUser) {
        System.out.println(sysUser.toString());
        return "addUser2请求成功";
    }
}

创建ValidTestController测试类，主要测试@Valid

@RestController
@RequestMapping("valid")
public class ValidTestController {
    //1、get方法普通参数（类上不加@Validated不起作用）
    @RequestMapping("user/{id}")
    public String selectById(@NotNull @Min(value = 8, message = "id不能小于8位") @PathVariable(name = "id") int id){
        System.out.println("参数id="+id);
        return "selectById请求成功";
    }

    // 2. get方法实体参数
    @RequestMapping("selectById")
    public String selectById2(@Valid SysUser sysUser){
        System.out.println("参数id="+sysUser.toString());
        return "selectById2请求成功";
    }

    // 3. post方法普通参数（类上不加@Validated不起作用）
    @PostMapping(path = "/addUser" )
    public String addUser(@NotNull @Min(value = 8, message = "id不能小于8位") @RequestBody String id) {
        System.out.println(id);
        return "addUser请求成功";
    }

    // 4. post方法实体参数
    @PostMapping(path = "/addUser2" )
    public String addUser2(@Valid @RequestBody SysUser sysUser) {
        System.out.println(sysUser.toString());
        return "addUser2请求成功";
    }
}

分别测试@Validated和@Valid的get、post方法，以及简单参数和实体类型参数，发现@Validated和@Valid的用法几乎是一样的。

分组校验：

创建两个分组接口，其实就是个标识

public interface FirstValidate {
}

public interface SecondValidate {
}

新建一个实体类SysUser2，主要就是在验证规则里面加上了groups = FirstValidate.class，表明这个规则只在该分组下启用，如果没有指定分组的
规则，默认都需要验证

@Data
public class SysUser2 {
    @NotNull(message = "id不能为空")
    @Min(value = 8, message = "id不能小于8位")
    private int id;
    @NotNull(groups = FirstValidate.class, message = "username不能为空")
    private String username;
    @NotNull(groups = SecondValidate.class,message = "password不能为空")
    private String password;
    private Date birthday;
    private String email;
}

创建测试类GroupValidateTestController

@RestController
@RequestMapping("group")
@Validated
public class GroupValidateTestController {

    // 1. 使用分组FirstValidate
    @PostMapping(path = "/addUser" )
    public String addUser(@Validated(value = FirstValidate.class) @RequestBody SysUser2 sysUser2) {
        System.out.println("addUser="+sysUser2.toString());
        return "addUser请求成功";
    }

    // 2. 使用分组SecondValidate
    @PostMapping(path = "/addUser2" )
    public String addUser2(@Validated(value = SecondValidate.class) @RequestBody SysUser2 sysUser2) {
        System.out.println("addUser2="+sysUser2.toString());
        return "addUser2请求成功";
    }
}

经过两个方法的测试，我们得出如下结论

addUser方法使用了FirstValidate分组，所以username的规则可以被验证，但是password的规则始终不会验证
addUser2方法使用了SecondValidate分组，所以password的规则可以被验证，但是username的规则始终不会验证
没有进行分组的属性id在两个方法都会被验证。

分组排序

默认情况下不同分组的验证是无序的，但是在一些情况下，项目要求有顺序验证。
我们可以使用组排序，在使用组序列验证的时候，如果序列前边的组验证失败，则后面的组将不再给予验证。

创建分组接口IValidateGroup，使用@GroupSequence进行排序，默认排到第一，SecondValidate放到第二

import javax.validation.GroupSequence;
import javax.validation.groups.Default;
//排序
@GroupSequence({Default.class, SecondValidate.class, FirstValidate.class})
public interface IValidateGroup {
}

添加测试方法

// 3. 排序，在IValidateGroup里面，我们把SecondValidate放到前面，所以password和username同时为null的时候，先验证的就是password
@PostMapping(path = "/addUser3" )
public String addUser3(@Validated({IValidateGroup.class}) @RequestBody SysUser2 sysUser2) {
    System.out.println("addUser2="+sysUser2.toString());
    return "addUser2请求成功";
}

测试后发现会先验证默认规则，然后验证SecondValidate分组，最后验证FirstValidate分组

嵌套校验：

我们创建课程类Course

@Data
public class Course {
    @NotNull(message = "name不能为空")
    private String name;
    @NotNull(message = "grade不能为空")
    @Min(value = 60, message = "成绩不能低于60")
    private double grade;
}

创建SysUser3

public class SysUser3 {
    @NotNull(message = "id不能为空")
    @Min(value = 8, message = "id不能小于8位")
    private int id;
    @NotNull(message = "username不能为空")
    private String username;
    @NotNull(message = "password不能为空")
    private String password;
    @Valid//如果不加@Valid，那么就不会对courseList里面的Course对象的属性验证了
    @NotNull(message = "courseList不能为空")
    @Size(min = 3, message = "至少有3门课程")
    private List<Course> courseList;
}
::: tip 提示
//@Valid注解可以写在list上，也可以写在Course前面，效果一样
@NotNull(message = "courseList不能为空")
@Size(min = 3, message = "至少有3门课程")
private List<@Valid Course> courseList;
:::

创建测试方法

@PostMapping(path = "/addUser4" )
public String addUser4(@Valid @RequestBody SysUser3 sysUser3) {
    System.out.println("addUser4="+sysUser3.toString());
    return "addUser4请求成功";
}

::: tip 测试结论

如果courseList上面不加@Valid，那么他就只能验证list的相关信息，不能验证course里面的属性
加上@Valid后就可以验证course里面的属性
@Valid可以加在list的上面，也可以加在course的前面，效果一样
:::

校验规则

自定义注解校验

在实际工作中，我们有时候需要自定义注解进行验证，可以通过@Constraint注解实现，具体做法如下：

创建自定义注解UserNameValidate

@Target({ElementType.METHOD, ElementType.FIELD}) //注解放置的目标位置
@Retention(RetentionPolicy.RUNTIME) //注解在哪个阶段执行
@Documented //生成文档
//代表处理逻辑是UserNameValidateImpl类
@Constraint(validatedBy = UserNameValidateImpl.class)
public @interface UserNameValidate {
    // 验证失败的提示信息
    String message() default "用户名验不通过，请重新输入";;
    // 用户名长度最小值
    int  min();
    // 用户名长度最大值
    int  max();
    //虽然没用到，但是要加上
    Class<?>[] groups() default {};
    //虽然没用到，但是要加上
    Class<? extends Payload>[] payload() default {};
}

创建@Constraint的实现类UserNameValidateImpl

/**
 * 实现ConstraintValidator，自定义用户名的长度范围
 */
public class UserNameValidateImpl implements ConstraintValidator<UserNameValidate, Object> {
    private int  min = 0;
    private int  max = 0;

    @Override
    public void initialize(UserNameValidate UserNameValidate) {
        max = UserNameValidate.max();
        min = UserNameValidate.min();
        System.out.println("初始化完成");
    }

    @Override
    public boolean isValid(Object o, ConstraintValidatorContext constraintValidatorContext) {
        if(o == null){
            return true;
        }
        if(o.toString().trim().length()>=min && o.toString().trim().length()<=max){
            return true;
        }
        return false;
    }
}

创建实体类SysUser4，我们在username上面使用了自定义注解@UserNameValidate

@Data
public class SysUser4 implements Serializable {
    @NotNull(message = "id不能为空")
    private int id;
    @UserNameValidate(min = 2,max = 5)
    private String username;
}

创建测试方法

@PostMapping(path = "/addUser5" )
public String addUser5(@Valid @RequestBody SysUser4 sysUser4) {
    System.out.println("addUser5="+sysUser4.toString());
    return "addUser5请求成功";
}

1介绍
 2springboot初体验
 3springboot集成jsp
4springboot属性注入
 5springboot集成mybatis
6springboot集成lombok
7springboot集成logback日志
 8springboot开启全局热部署
 9springboot面向切面编程
 10springboot文件上传
 11springboot文件下载
 12springboot自定义拦截器
 13springboot打成war包发布
 14springboot打成jar包发布
 15springboot自定义banner
16springboot配置文件拆分
 17springboot定时任务
 18springboot定时任务配置详解
 19springboot动态定时任务
 20springboot集成websocket
21springboot多数据源
 22springboot配置druid监听
 23springboot自定义注解
 24springboot常见注解详解
 25springboot接收参数详解
 26springboot验证机制@Valid和@Validated
27springboot集成Swagger2
28springboot集成swagger-bootstrap-ui
29springboot集成shiro
30springboot集成shiro（二）
31springboot集成jwt
32springboot集成ActiveMQ
33springboot缓存机制

牛魔王sq

关注

1
点赞
踩
3

收藏

觉得还不错? 一键收藏
1
评论
springboot进阶学习（十一）springboot验证机制@Valid和@Validated

springboot验证机制@Valid和@Validated概述在这里我们主要讲解@Valid和@Validated的使用方法，基本用法都是类似的，但在分组、注解位置、嵌套验证等功能上有所不同。@Valid属于javax.validation包下,是jdk给提供的，@Valid不能分组@Validated是org.springframework.validation.annotation包下的,是spring提供的。@Validated在@Valid之上提供了分组功能和验证排序功能两个的注解位
复制链接

扫一扫

专栏目录