SpringBoot参数校验@Validated、@Valid

news2024/11/24 4:33:05

SpringBoot参数校验@Validated、@Valid（javax.validation）

一、应用场景

在实际开发中，前端校验并不安全，任何人都可以通过接口来调用我们的服务，就算加了一层token的校验，有心人总会转空子，来传各式各样错误的参数，如果后端不校验，导致数据库数据混乱、特别是关于金额的数据，可能一个接口把公司都给干倒了

二、原生参数校验

0、返回类（可以不用看）

/**
 * 用于返回
 * @param <T>
 */
@ApiModel("统一返回类")
public class Results<T> {
    public static final String ERROR = "500";
    public static final String SUCCESS = "200";

    /**
     * 返回码
     */
    @ApiModelProperty("返回码,正确码为：200")
    private String resCode ;

    /**
     * 返回消息
     */
    @ApiModelProperty("返回消息")
    private String msg ;

    /**
     * 返回实体
     */
    @ApiModelProperty("返回实体")
    private T obj;

    public static <T> Results<T> success(){
        return success(SUCCESS,"成功",null);
    }

    public static <T> Results<T> success(String msg){
        return success(SUCCESS,msg,null);
    }

    public static <T> Results<T> success(T obj){
        return success(SUCCESS,"成功",obj);
    }

    public static <T> Results<T> success(String msg,T obj){
        return success(SUCCESS,msg,obj);
    }

    public static <T> Results<T> success(String resCode,String msg,T obj){
        Results<T> result = new Results<T>();
        result.setResCode(resCode);
        result.setMsg(msg);
        result.setObj(obj);
        return result;
    }

    public static <T> Results<T> failed() {
        return failed(ERROR,"失败",null);
    }

    public static <T> Results<T> failed(String msg) {
        return failed(ERROR,msg,null);
    }

    public static <T> Results<T> failed(String msg,T obj) {
        return failed(ERROR,msg,obj);
    }

    public static <T> Results<T> failed(String resCode,String msg) {
        return failed(resCode,msg,null);
    }

    public static <T> Results<T> failed(Integer resCode,String msg) {
        return failed(String.valueOf(resCode),msg);
    }

    public static <T> Results<T> failed(String resCode,String msg,T obj) {
        Results<T> result = new Results<T>();
        result.setResCode(resCode);
        result.setMsg(msg);
        result.setObj(obj);
        return result;
    }

    public static <T> Results<T> failedNoPermission() {
        return failed(90005,"没有权限");
    }
    public static <T> Results<T> failedNoPermission(String msg) {
        return failed(90005,msg);
    }


    public static <T> Results<T> failedParameterException() {
        return failed(90004,"参数异常");
    }
    public static <T> Results<T> failedParameterException(String msg) {
        return failed(90004,msg);
    }

    public static <T> Results<T> failedLoginException() {
        return failed(90002,"登录失败");
    }
    public static <T> Results<T> failedLoginException(String msg) {
        return failed(90002,msg);
    }

    public String getResCode() {
        return resCode;
    }

    public void setResCode(String resCode) {
        this.resCode = resCode;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getObj() {
        return obj;
    }

    public void setObj(T obj) {
        this.obj = obj;
    }

    @Override
    public String toString() {
        return "Results{" +
                "resCode='" + resCode + '\'' +
                ", msg='" + msg + '\'' +
                ", obj=" + obj +
                '}';
    }
}

1、实体类

@ApiModel("测试 validation 入参")
@Data
public class TestDto {
    @ApiModelProperty(value = "名字",required = true)
    private String name;
    @ApiModelProperty(value = "年龄",required = true)
    private Integer age;
    @ApiModelProperty(value = "爱好",required = true)
    private List<String> hobbies;
}

2、服务层（为了方便，我直接跟Controller写在一起了）

我们可以看见如果参数过大，要一个一个筛选条件十分浪费时间

@RestController
// lombok 的日志注解
@Slf4j
// swagger 的注解
@Api("测试")
public class TestController {

    @PostMapping("/testValidation")
	// swagger 的注解
    @ApiOperation("测试 validation")
    public Results testValidation(@RequestBody TestDto dto){
        try {
            log.info("test 入参 dto={}",dto);
            // 这要一个一个的塞，很浪费时间
            if (dto.getName() == null || "".equals(dto.getName().trim())){
                return Results.failed("名字不能为空");
            }
            if (dto.getAge() == null){
                return Results.failed("年龄不能为空");
            }
            if (dto.getHobbies() == null || dto.getHobbies().size() == 0){
                return Results.failed("爱好不能为空");
            }
            return Results.success();
        } catch (Exception e) {
            log.error("test 报错",e);
            return Results.failed();
        }
    }
}

三、使用 javax.validation 进行参数校验

1、导包

        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2、全局异常处理类

@RestControllerAdvice
public class ExceptionControllerAdvice {

    @ResponseStatus(HttpStatus.OK)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Results MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        // 从异常对象中拿到ObjectError对象
        BindingResult br = e.getBindingResult();
        if (br.hasFieldErrors()) {
            List<FieldError> fieldErrorList = br.getFieldErrors();
            List<String> errors = new ArrayList<>(fieldErrorList.size());
            for (FieldError error : fieldErrorList) {
                errors.add(error.getField() + ":" + error.getDefaultMessage());
            }
            // 然后提取错误提示信息进行返回
            return Results.failed(errors.toString());
        }
        // 然后提取错误提示信息进行返回
        return Results.failed("校验错误");
    }
 
}
如果不加这个全局处理类，只会给前端返回这样的参数

在这里插入图片描述

加上全局配置类

在这里插入图片描述

3、实体类

@ApiModel("测试 validation 入参")
@Data
public class TestDto {
    
    @ApiModelProperty(value = "名字",required = true)
    // 适用于 String 类型的数据上，加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0，必须有实际字符
    @NotBlank(message = "名字不能为空")
    private String name;
    
    @ApiModelProperty(value = "年龄",required = true)
    @NotNull(message = "年龄不能为空")
    // 适用于基本数据类型(Integer，Long，Double等等)，当 @NotNull 注解被使用在 String 类型的数据上，则表示该数据不能为 Null（但是可以为 Empty）
    private Integer age;
    
    @ApiModelProperty(value = "爱好",required = true)
    // 适用于 String、Collection集合、Map、数组等等，加了@NotEmpty 注解的参数不能为 Null 或者 长度为 0
    @NotEmpty(message = "年龄不能为空")
    private List<String> hobbies;
}

4、服务层（为了方便，我直接跟Controller写在一起了）

必须要加上 @Valid 或者 @Validated，后续我会讲解这两个有什么不同，目前来说，都可以用，但推荐用 @Validated

@RestController
@Slf4j
@Api("测试")
public class TestController {

    @PostMapping("/testValidation")
    @ApiOperation("测试 validation")
    // 必须要加上 @Valid 或者 @Validated
    public Results testValidation(
        // 必须要加上 @Valid 或者 @Validated
        @Valid @RequestBody TestDto dto){
        try {
            log.info("test 入参 dto={}",dto);
            return Results.success();
        } catch (Exception e) {
            log.error("test 报错",e);
            return Results.failed();
        }
    }
}

6、测试

在这里插入图片描述

四、javax.validation 包下其它常用的校验注解：

这个颜色的是常用的

注解含义
@Null任何类型 必须为null
@NotBlank字符串、字符 字符类不能为null，且去掉空格之后长度大于
@NotNull任何类型 不能为null
@Length(min = 6, max = 8, message = “密码长度为6-8位。”)字符串的大小必须在指定的范围内
@NotEmpty适用于 String、Collection集合、Map、数组等等，加了@NotEmpty 注解的参数不能为 Null 或者 长度为 0
@AssertTrueBoolean、boolean 布尔属性必须是true
@AssertFalseBoolean、boolean 布尔属性必须是false
@Min(10)必须是一个数字，其值必须大于等于指定的最小值（我这填的是10）（整型）
@Max(10)必须是一个数字，其值必须小于等于指定的最大值（我这填的是10）（整型）
@DecimalMin(“10”)必须是一个数字，其值必须大于等于指定的最小值（我这填的是10）（字符串，可以是小数）
@DecimalMax(“10”)必须是一个数字，其值必须小于等于指定的最大值（我这填的是10）（字符串，可以是小数）
@Size(max = 10,min = 1)集合 限定集合大小
@Digits(integer = 3, fraction = 2, message = “请输入有效的数字”)
private double number;		@Digits 用于验证数字的整数位数和小数位数。该注解的 integer 和 fraction 属性分别用于指定整数位数和小数位数的限制。
integer 属性用于指定数字的最大整数位数。它是一个整数值，表示数字允许的最大整数位数。例如，integer = 3 表示数字最多可以有三位整数部分。
fraction 属性用于指定数字的最大小数位数。它是一个整数值，表示数字允许的最大小数位数。例如，fraction = 2 表示数字最多可以有两位小数部分。
@Past时间、日期 必须是一个过去的时间或日期
@Future时期、时间 必须是一个未来的时间或日期
@Email字符串 必须是一个邮箱格式
@Pattern(regexp = “[a-zA-Z]*”, message = “密码不合法”)字符串、字符 正则匹配字符串
@Range(max = 150, min = 1, message = “年龄范围应该在1-150内。”)数字类型（原子和包装） 限定数字范围（长整型）
@URL(protocol=,host=, port=,regexp=, flags=)被注释的字符串必须是一个有效的url
@CreditCardNumber被注释的字符串必须通过Luhn校验算法，银行卡，信用卡等号码一般都用Luhn计算合法性
@ScriptAssert(lang=, script=, alias=)要有Java Scripting API 即JSR 223 (“Scripting for the JavaTM Platform”)的实现
@SafeHtml(whitelistType=, additionalTags=)classpath中要有jsoup包

五、@Validated 与 @Valid 比较

1、文字讲解

Spring Validation验证框架对参数的验证机制提供了@Validated（Spring’s JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。

@Valid属于javax.validation包下,是jdk给提供的 是使用Hibernate validation的时候使用

@Validated是org.springframework.validation.annotation包下的,是spring提供的 是只用Spring Validator校验机制使用

说明：java的JSR303声明了@Valid这类接口，而Hibernate-validator对其进行了实现

@Validation对@Valid进行了二次封装，在使用上并没有区别，但在分组、注解位置、嵌套验证等功能上有所不同，这里主要就这几种情况进行说明。

在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等功能上两个有所不同：

  1. 分组

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制，这个网上也有资料，不详述。@Valid：作为标准JSR-303规范，还没有吸收分组的功能。

  1. 注解地方

@Validated：用在类型、方法和方法参数上。但不能用于成员属性（field）

@Valid：可以用在方法、构造函数、方法参数和成员属性（field）上 所以可以用@Valid实现嵌套验证

总结：

@Valid 和 @Validated 两者都可以对数据进行校验，待校验字段上打的规则注解（@NotNull, @NotEmpty等）都可以对 @Valid 和 @Validated 生效；

@Valid 进行校验的时候，需要用 BindingResult 来做一个校验结果接收。当校验不通过的时候，如果手动不 return ，则并不会阻止程序的执行；

@Validated 进行校验的时候，当校验不通过的时候，程序会抛出400异常，阻止方法中的代码执行，这时需要再写一个全局校验异常捕获处理类，然后返回校验提示。

总体来说，@Validated 使用起来要比 @Valid 方便一些，它可以帮我们节省一定的代码，并且使得方法看上去更加的简洁。

2、代码讲解，groups属性

在开发中，新增、修改两个接口，一般关系就在于新增时ID可以为空，修改时ID不能为空，那我们如果要使用 validation 用于参数校验，创建两个实体类就非常的不划算，这时

①、创建一个update接口

import javax.validation.groups.Default;

public interface Update extends Default {
}
②、修改实体类
@ApiModel("测试 validation 入参")
@Data
public class TestDto {
    @ApiModelProperty(value = "ID",required = true)
    // 新增时ID为空，修改时ID不能为空
    @NotNull(message = "ID不能为空",groups = Update.class)
    private Integer id;
    @ApiModelProperty(value = "名字",required = true)
    @NotBlank(message = "名字不能为空")
    private String name;
}
③、服务层（为了方便，我直接跟Controller写在一起了）
@RestController
@Slf4j
@Api("测试")
public class TestController {

    @PostMapping("/testAdd")
    @ApiOperation("测试 新增")
    public Results testAdd(@Validated @RequestBody TestDto dto){
        try {
            log.info("testAdd 入参 dto={}",dto);
            return Results.success();
        } catch (Exception e) {
            log.error("testAdd 报错",e);
            return Results.failed();
        }
    }

    @PostMapping("/testUpdate")
    @ApiOperation("测试 新增")
    public Results testUpdate(@Validated(Update.class) @RequestBody TestDto dto){
        try {
            log.info("testUpdate 入参 dto={}",dto);
            return Results.success();
        } catch (Exception e) {
            log.error("testUpdate 报错",e);
            return Results.failed();
        }
    }
}
⑤、测试
新增：

在这里插入图片描述

修改：

在这里插入图片描述

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1394162.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

如何禁用WordPress站点的管理员电子邮件验证或修改检查频率？

如何禁用WordPress站点的管理员电子邮件验证或修改检查频率？

今天boke112百科登录某个WordPress站点时&#xff0c;又出现“管理员邮件确认”的提示&#xff0c;要求确认此站点的管理员电子邮箱地址是否仍然正确。具体如下图所示&#xff1a; 如果点击“稍后提醒我”&#xff0c;那么管理员邮件验证页面就会在3天后重新显示。 说实话&…
阅读更多...
【JVM】JVM概述

【JVM】JVM概述

JVM概述 基本介绍 JVM&#xff1a;全称 Java Virtual Machine&#xff0c;即 Java 虚拟机&#xff0c;一种规范&#xff0c;本身是一个虚拟计算机&#xff0c;直接和操作系统进行交互&#xff0c;与硬件不直接交互&#xff0c;而操作系统可以帮我们完成和硬件进行交互的工作特…
阅读更多...
大数据开发之Hadoop（MapReduce）

大数据开发之Hadoop（MapReduce）

第 1 章&#xff1a;MapReduce概述 1.1 MapReduce定义 MapReduce是一个分布式运算程序的编程框架&#xff0c;是用户开发“基于Hadoop的数据分析应用”的核心框架。 MapReduce核心功能是将用户编写的业务逻辑代码和自带默认组件整合成一个完整的分布式运算程序&#xff0c;并…
阅读更多...
我的隐私计算学习——联邦学习（4）

我的隐私计算学习——联邦学习（4）

本篇笔记部分内容来源于这位老师的知识分享【公众号&#xff1a;秃顶的码农】&#xff0c;我从他的资料里学到了很多&#xff0c;期间还私信询问了一些困惑&#xff0c;都得到了老师详细的答复&#xff0c;相当nice&#xff01; &#xff08;六&#xff09;横向联邦学习 — 梯度…
阅读更多...
学习VUE-安装环境

学习VUE-安装环境

下载安装Node.js 官网下载最新版本&#xff1a;https://nodejs.org/en/download/ 解压zip包 由于node.js默认安装了npm所以不用额外配置全局命令就可以使用npm命令 在cmd中输入node -v 和 npm -v就可以得到版本信息 配置一下目录&#xff1a; node.js环境配置 配置镜像 安装…
阅读更多...
命令行参数环境变量和进程空间地址

命令行参数环境变量和进程空间地址

文章目录 命令行参数环境变量进程地址空间 正文开始前给大家推荐个网站&#xff0c;前些天发现了一个巨牛的 人工智能学习网站&#xff0c; 通俗易懂&#xff0c;风趣幽默&#xff0c;忍不住分享一下给大家。 点击跳转到网站。 命令行参数 什么是命令行参数&#xff1f; 我…
阅读更多...
✅稳定检索，高校嘉宾出席，2024年机械应用与机器视觉研究国际会议(ICMAMVR 2024)

✅稳定检索，高校嘉宾出席，2024年机械应用与机器视觉研究国际会议(ICMAMVR 2024)

2024年机械应用与机器视觉研究国际会议(ICMAMVR 2024) 数据库&#xff1a;EI,CPCI,CNKI,Google Scholar 等 2024 International Conference on Mechanical Applications and Machine Vision Research(ICMAMVR 2024) 一、【会议简介】 &#x1f389;&#x1f389; 2024年机械应用…
阅读更多...
运维平台介绍：视频智能运维平台的视频质量诊断分析和监控中心

运维平台介绍：视频智能运维平台的视频质量诊断分析和监控中心

目 录 一、概述 二、框架图 1、图像过亮检测&#xff1a; 2、图像模糊检测&#xff1a; 3、画面冻结检测&#xff1a; 4、信号缺失检测&#xff1a; 5、图像偏色检测&#xff1a; 6、噪声干扰检测&#xff1a; 7、条纹干扰检测&#xff1a; 三、监控中心模…
阅读更多...
electron+vite+vue3 快速入门教程

electron+vite+vue3 快速入门教程

文章目录 前言一、electron是什么&#xff1f;二、electron 进程模型1.主进程2.渲染进程3.预加载脚本4.进程通信4.1 sendon&#xff08;单向&#xff09;4.2 invokehandle (双向)4.3 主进程向渲染进程发送事件 三、窗口创建与应用事件四、技术栈和构建工具五、electron-vite安装…
阅读更多...
母线温度预测业务需求设计

母线温度预测业务需求设计

1、需求背景 需求对象&#xff1a;设备使用方、设备维修人员 使用场景&#xff1a;使用方需要对母线温度进行实时监测和预警&#xff0c;及时排除安全隐患&#xff0c;保证长期正常运行。 使用目的&#xff1a;准确预测母线的未来温度&#xff0c;对于可能存在的隐患提前预警…
阅读更多...
【C++】STL 算法 - 累加填充算法 ( 元素累加算法 - accumulate 函数 | 元素填充算法 - fill 函数 )

【C++】STL 算法 - 累加填充算法 ( 元素累加算法 - accumulate 函数 | 元素填充算法 - fill 函数 )

文章目录 一、元素累加算法 - accumulate 函数1、函数原型分析2、代码示例 二、元素填充算法 - fill 函数1、函数原型分析2、代码示例 一、元素累加算法 - accumulate 函数 1、函数原型分析 在 C 语言 的 标准模板库 ( STL , STL Standard Template Library ) 中 , 提供了 accu…
阅读更多...
josef约瑟 三相电压继电器 WY-35A4 100V DC220V 导轨安装

josef约瑟 三相电压继电器 WY-35A4 100V DC220V 导轨安装

三相 WY-35A4电压继电器&#xff1b;WY-35B4电压继电器&#xff1b;WY-35C4电压继电器&#xff1b;WY-31A4电压继电器&#xff1b;WY-31B4电压继电器&#xff1b; WY-31C4电压继电器&#xff1b;JY-45A4电压继电器&#xff1b;JY-45B4电压继电器&#xff1b;JY-45C4电压继电器…
阅读更多...
CentOS使用docker本地部署StackEdit Markdown编辑器并实现公网访问

CentOS使用docker本地部署StackEdit Markdown编辑器并实现公网访问

文章目录 1. docker部署Stackedit2. 本地访问3. Linux 安装cpolar4. 配置Stackedit公网访问地址5. 公网远程访问Stackedit6. 固定Stackedit公网地址 StackEdit是一个受欢迎的Markdown编辑器&#xff0c;在GitHub上拥有20.7k Star&#xff01;&#xff0c;它支持将Markdown笔记保…
阅读更多...
再获权威认证！紫光展锐5G芯片T820荣获国密二级安全认证

再获权威认证！紫光展锐5G芯片T820荣获国密二级安全认证

近日&#xff0c;紫光展锐系统级安全的高性能 5G SoC T820荣获国密二级认证&#xff0c;这是T820获得金融科技产品认证证书后&#xff0c;再次荣获的行业权威认证&#xff0c;标志着T820在金融安全能力和应用水准位居行业前沿水平。 荣获国密二级安全认证意味着紫光展锐T820满…
阅读更多...
力扣1929.数组串联

力扣1929.数组串联

前言 虽然力扣对我来说很难&#xff0c;但只要每天刷一点&#xff0c;就会慢慢增强能力&#xff0c;总有一天刷动力扣的难题&#xff0c;所以说&#xff0c;今天也是刷力扣的一天。 &#x1f606;&#x1f606; /** * Note: The returned array must be malloced, assume call…
阅读更多...
VSCode使用Makefile Tools插件开发C/C++程序

VSCode使用Makefile Tools插件开发C/C++程序

提起Makefile&#xff0c;可能有人会觉得它已经过时了&#xff0c;毕竟现在有比它更好的工具&#xff0c;比如CMake&#xff0c;XMake&#xff0c;Meson等等&#xff0c;但是在Linux下很多C/C源码都是直接或者间接使用Makefile文件来编译项目的&#xff0c;可以说Makefile是基石…
阅读更多...
vue实现导出+ 样式修改

vue实现导出+ 样式修改

1.安装插件 npm install xlsx-style ^0.18.5 npm install xlsx -S ^0.8.13 2. 修改代码 node_modules里面找到 以下位置xlsx.js 搜索 write_ws_xml_data 替换成以下代码 function write_ws_xml_data(ws, opts, idx, wb) {var o [], r [], range safe_decode_range(…
阅读更多...
Kubernetes增加master节点

Kubernetes增加master节点

一. 新增节点 无论是node节点还是master节点&#xff0c;kubelet、kubeadm、kubectl、CRI需要部署好&#xff0c; ### 新增node, 重新生成token, 复制加入即可, 前提是需要装上面的 kubectl kubeadm kubelet containerd 等 kubeadm token create --print-join-command### 新增 …
阅读更多...
K8S对外服务ingress

K8S对外服务ingress

Sevice作用体现在两个方面 集群内部 不断跟踪pod的变化&#xff0c;更新endpoint中的pod对象&#xff0c;基于pod的ip地址不断发现的一种服务发现机制 集群外部 类似负载均衡器&#xff0c;把流量&#xff08;ip端口&#xff09;&#xff0c;不涉及转发url&#xff08;http ht…
阅读更多...
【Git相关问题】修改代码提交push时的用户名字

【Git相关问题】修改代码提交push时的用户名字

最简方法如下&#xff1a; 直接修改Git的用户配置文件 .gitconfig&#xff0c;这个配置文件的路径一般是 C:\Users\本机用户名\.gitconfig 用记事本或编辑器打开&#xff0c;在[user]下即可修改用户名name或邮箱email 参考&#xff1a; 使用Git进行版本控制&#xff0c;不同…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023