spring中使用@Validated,什么是JSR 303数据校验,spring boot中怎么使用数据校验

news2025/2/25 5:44:55

文章目录

      • 一、JSR 303后台数据校验
        • 1.1 什么是 JSR303?
        • 1.2 为什么使用 JSR 303?
      • 二、Spring Boot 中使用数据校验
        • 2.1 基本注解校验
          • 2.1.1 使用步骤
          • 2.1.2 举例
            • @Valid注解
            • 全局统一异常处理
        • 2.2 分组校验
          • 2.2.1 使用步骤
          • 2.2.2 举例
            • @Validated注解
            • @Validated和@Valid的区别
        • 2.3 自定义校验注解
          • 2.3.1 使用步骤
          • 2.3.2 举例
        • 2.4 相关注解
          • 2.4.1 空检查相关注解
          • 2.4.2 长度检查
          • 2.4.3 布尔值检查
          • 2.4.4 日期检查
          • 2.4.5 数值检查
          • 2.4.6 其他

一、JSR 303后台数据校验

1.1 什么是 JSR303?

JSR 是 Java Specification Requests 的缩写,即 Java 规范提案。存在各种各样的 JSR,简单的理解为 JSR 是一种 Java 标准。JSR 303 是其中数据检验的一个标准(Bean Validation 1.0 (JSR 303))。

1.2 为什么使用 JSR 303?
  • 处理一段业务逻辑,首先要确保数据输入的正确性,所以需要先对数据进行检查,保证数据在语义上的正确性,再根据数据进行下一步的处理。

  • 前端可以通过 js 程序校验数据是否合法,后端同样也需要进行校验。而后端最简单的实现就是直接在业务方法中对数据进行处理,但是不同的业务方法可能会出现同样的校验操作,这样就出现了数据的冗余。

  • 为了解决这个情况,JSR 303 出现了。JSR 303 使用 Bean Validation,即在 Bean 上添加相应的注解,去实现数据校验。这样在执行业务方法前,都会根据注解对数据进行校验,从而减少自定义的校验逻辑,减少代码冗余。

二、Spring Boot 中使用数据校验

2.1 基本注解校验

之前在 Spring MVC 中介绍了数据校验,也例举了常用的注解。但是使注解生效必须要在 springmvc.xml 中配置,假如没有配置文件(比如在 spring boot)中怎么办?----> 下面详细介绍

spring boot 中需要引入依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
2.1.1 使用步骤

1、在相关的 Bean 上标注需要处理的注解,并指定需要提示的信息(若不指定,会从默认配置文件中读取默认的信息)。

2、在相关的方法上,使用 @Valid 注解(或者 @Validated 指定组名)标记需要被校验的数据,否则会不生效。

注意:检测到数据异常后,系统会向外抛出异常,如果做了统一异常处理,可以根据 postman 测试的结果,找到控制台打印出的相应的异常,并处理。

3、处理异常。

  • 使用 BindingResult 处理;

  • 也可以使用 全局统一异常 处理(@RestControllerAdvice 与 @ExceptionHandler

    全局统一异常处理后续会讲

2.1.2 举例

1、在相关的 Bean 上标注注解,并写上指定信息。

@Data
public class Emp {
    @NotNull(message = "id 不能为 null")
    private Integer id;

    @NotNull(message = "name 不能为 null")
    private String name;
}
@Valid注解

2、Controller层中使用 @Valid 注解标记需要检测的数据。

@RestController
public class EmpController {
    
    @PostMapping("/emp")
    public String createEmp(@Valid @RequestBody Emp emp) {
       return "ok";
    }
}

3、测试时,假如不传 id、name,会抛出 MethodArgumentNotValidException 异常。使用 BindingResult 可以处理异常信息,但 通常使用统一异常处理

① 使用 BindingResult:

@RestController
public class EmpController {
    @PostMapping("/emp")
    public Map createEmp(@Valid @RequestBody Emp emp, BindingResult result) {
        if (result.hasErrors()) {
            Map<String, String> map = new HashMap<>();
            // 获取校验结果,遍历获取捕获到的每个校验结果
            result.getFieldErrors().forEach(item -> {
                // 获取校验的信息
                String message = item.getDefaultMessage(); // 也获取message的值
                String field = item.getField(); //获取属性名
                // 存储得到的校验结果
                map.put(field, message);
            });
            return map;
        }
        return "ok";
    }
}

问题:通过上面的步骤,已经可以捕获异常、处理异常,但是每次都是在业务方法中手动处理逻辑,这样的实现,代码肯定会冗余。可以将其抽出,使用 统一异常处理,每次异常发生时,将其捕获。

全局统一异常处理

② 全局统一异常处理:@RestControllerAdvice、@ExceptionHandler

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Map handlerValidException(MethodArgumentNotValidException e) {
        BindingResult result = e.getBindingResult();
        Map<String, String> map = new HashMap<>();
        // 获取校验结果,遍历获取捕获到的每个校验结果
        result.getFieldErrors().forEach(item ->{
            // 存储得到的校验结果
            map.put(item.getField(), item.getDefaultMessage());
        });
        return map;
    }
}

Controller 中不需要再用 BindingResult 去处理数据了。

2.2 分组校验

1、为什么使用 分组校验?

上面的过程,如果出现多个方法,都需要校验 Bean,且校验规则不同的时候,怎么办呢?分组校验就可以去解决该问题,每个分组指定不同的校验规则,不同的方法执行不同的分组,就可以得到不同的校验结果。

2、JSR 303 的每个注解都默认具备三个属性

  • message 用来定义数据校验失败后的提示消息,默认读取配置文件的内容。idea 全局搜索 ValidationMessages.properties,可以看到默认的信息。
  • groups 用来定义分组,它是一个 class 数组,可以指定多个分组。
  • payload()
String message() default "{javax.validation.constraints.NotNull.message}";

Class<?>[] groups() default { };

Class<? extends Payload>[] payload() default { };
2.2.1 使用步骤

1、定义一个空接口,用于指定分组,内部不需要任何实现。

2、指定 注解时,通过 groups 指定分组。用于指定在某个分组条件下,才去执行校验规则。

3、在 Controller 中通过 @Validated 注解指定分组,去指定校验。

注:使用分组校验后,Bean 注解上若不指定分组,则不会执行校验规则。

2.2.2 举例

1、如:创建两个分组接口 AddGroup、UpdateGroup。

AddGroup 用于指定 添加数据 时的校验规则(比如:id、name 均不为 null)。

UpdateGroup 用于指定 修改数据 时的校验规则(比如:name 不允许为 null)。

2、给 Bean 添加注解,并指定分组信息。

@Data
public class Emp {
  
    @NotNull(message = "id 不能为 null", groups = {AddGroup.class})
    private Integer id;

    @NotNull(message = "name 不能为 null", groups = {AddGroup.class, UpdateGroup.class})
    private String name;
}
@Validated注解

3、通过 @Validated 注解指定分组,去指定校验

@RestController
public class EmpController {
    @PostMapping("/emp")
    public void createEmp(@Validated({AddGroup.class}) @RequestBody Emp emp) {
       
    }

    @PutMapping("/emp")
    public void UpdateEmp(@Validated({UpdateGroup.class}) @RequestBody Emp emp) {
      
    }
}
@Validated和@Valid的区别
  • @Validated:

    • Spring 框架特有的注解,是标准 JSR-303 的一个变种,提供了一个分组功能。
    • 作用在类上、方法上、方法参数上,不能作用于成员属性上。
  • @Valid:

    • 标准 JSR-303 规范的标记型注解。

    • 作用在方法、构造函数、方法参数、成员属性上。

2.3 自定义校验注解

上面的注解满足不了业务需求时,可以自定义校验注解、然后自定义校验规则

2.3.1 使用步骤

1、自定义一个校验注解。可以创建一个 ValidationMessages.properties 用于保存默认的 message 信息。

2、自定义一个校验器(即自定义校验规则):实现 ConstraintValidator 接口,并重写相关方法。

  • initialize :初始化,可以获取 自定义的属性的值。

  • isValid :校验,可以获取到实际的值,然后与自定义的属性值进行比较。

3、将校验注解 与 校验器 关联起来。@Constraint(validatedBy = {校验器类.class})

2.3.2 举例

自定义一个校验规则,判断数据长度是否合法。

1、自定义一个校验注解:(比如这里是@TestValid)

@Target({FIELD})
@Retention(RUNTIME)
@Documented
@Constraint(validatedBy={JiaoYan.class})
public @interface TestValid {
    // 提示信息
    String message() default "{本自定义注解的全类名.message}";
   	
    class<?>[] groups() default {};
    
    Class<? extends Payload>[] payload() default {};
    
    /**
     * 返回一个长度
     * @return 默认为 5
     */
    int length() default 5; 
}

在这里插入图片描述

配置文件内容为:

自定义注解的全类名.message=值不能为 Null,且长度不超过 5

2、自定义一个校验器(比如这里是 JiaoYan)

/**
 * 实现 ConstraintValidator 接口,
 * 其中 ConstraintValidator 的泛型,一个需要指定自定义的注解,一个需要指定需要获取的值的类型。
 * 比如:
 *  ConstraintValidator<TestValid, String> 中
 *      TestValid   表示自定义注解
 *      String      表示获取的值的类型
 * 即定义规则,判断一个 String 的值的长度是否满足条件
 */
public class JiaoYan implements ConstraintValidator<TestValid, String> {
    /**
     * 用于保存自定义的(默认)长度
     */
    private int length;
    
    /**
     * 初始化方法,获取默认数据
     * @param test 注解对象
     */
    @Override
    public void initialize(TestValid test) {
        length = test.length();
    }
    
    /**
     * 自定义校验规则,如果 String 为 Null 或者 长度大于 5,则校验失败(返回 false)
     * @param value 需要校验的值
     * @param context
     * @return true 表示校验成功,false 表示校验失败
     */
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        return value == null ? false : length > value.length();
    }
}

3、使用注解

@Data
public class Emp {
   
    @NotNull(message = "id 不能为 null", groups = {AddGroup.class})
    private Integer id;
    
    // 默认
    @TestValid()
    @NotNull(message = "name 不能为 null", groups = {AddGroup.class, UpdateGroup.class})
    private String name;

    // 自定义
    @TestValid(length = 10, message = "值不能为 Null 且长度不超过 10", groups = {AddGroup.class})
    private String email;
}
2.4 相关注解
2.4.1 空检查相关注解
注解注解详情
@Null被指定的注解元素必须为 Null
@NotNull任意类型,不能为 Null,但可以为空,比如:空数组[]、空字符串""
@NotBlank针对字符串,不能为 Null,且去除前后空格后的字符串长度要大于 0
@NotEmpty针对字符串、集合、数组,针对字符串时,不能为 Null,且长度要大于 0
2.4.2 长度检查
注解注解详情
@Size针对字符串、集合、数组,判断长度是否在给定范围内
@Length针对字符串,判断长度是否在给定范围内
2.4.3 布尔值检查
注解注解详情
@AssertTrue针对布尔值,用来判断布尔值是否为 true
@AssertFalse针对布尔值,用来判断布尔值是否为 false
2.4.4 日期检查
注解注解详情
@Past针对日期,用来判断当前日期是否为 过去的日期
@Future针对日期,用来判断当前日期是否为 未来的日期
2.4.5 数值检查
注解注解详情
@Max(value)针对字符串、数值,用来判断是否小于等于某个指定值
@Min(value)针对字符串、数值,用来判断是否大于等于某个指定值
2.4.6 其他
注解注解详情
@Pattern验证字符串是否满足正则表达式
@Email验证字符串是否满足邮件格式
@Url验证是否满足 url 格式
@Digits验证数字整数和小数位数,如:@Digits(integer=6, fraction=2)

文章结束!恭喜你又学会了一个知识点!!!

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

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

相关文章

网页单机版五子棋小游戏项目练习-初学前端可用于练习~

今天给大家分享一个 前端练习的项目&#xff0c;技术使用的是 html css 和javascrpit 。希望能对于 刚刚学习前端的小伙伴一些帮助。 先看一下 实现的效果图 1. HTML&#xff08;HyperText Markup Language&#xff09; HTML 是构建网页的基础语言&#xff0c;它的主要作用是定…

UE5材质节点Distance

Distance可以计算两个物体间的距离&#xff0c;可以用来做过渡效果 当相机和物体距离3000的时候&#xff0c;就会渐渐从蓝过渡到红色&#xff0c;除以500是为了平滑过渡

【AIGC-ChatGPT进阶提示词指令】AI美食助手的设计与实现:Lisp风格系统提示词分析

引言 在人工智能助手的应用领域中&#xff0c;美食烹饪是一个既专业又贴近生活的方向。本文将详细分析一个基于Lisp风格编写的美食助手系统提示词&#xff0c;探讨其结构设计、功能实现以及实际应用效果。 提出你的菜系&#xff0c;为你分析&#xff0c;并生成图片卡片 提示词…

基于开发/发布/缺陷分离模型的 Git 分支管理实践20250103

基于开发/发布/缺陷分离模型的 Git 分支管理实践 引言 在现代软件开发中&#xff0c;合理的分支管理策略是保证项目成功的关键因素之一。本文将详细介绍一种基于开发/发布/缺陷分离的 Git 分支管理模型&#xff0c;这种模型不仅能提升团队协作效率&#xff0c;还能确保代码质…

【Cocos TypeScript 零基础 3.1】

目录 场景跳转 场景跳转 把新建好的TS文件与场景绑定 选中 场景 或 camera 拖进右边的 属性检查器 双击T文件,进入编辑 至于用什么IDE看个位朋友高兴 我这里有 VScode ,先用这个,老师也没有推荐 (老师也用的是这个) VScode UI 也有中文包,请自行上网搜索 打开创建的TS文件后…

SAP SD学习笔记23 - 无偿出荷(免费交货)与继续无偿出荷(继续免费交货)

上一章讲了SAP中的一括请求处理。 SAP SD学习笔记22 - VF04&#xff0c;VF06&#xff0c;VF24 等一括请求处理-CSDN博客 本章继续讲SAP中的内容&#xff1a;无偿出荷 和 继续无偿出荷。 - 无偿出荷本身是挺常用的&#xff0c;常见的例子就是送给客户样品&#xff1b; - 继续…

021-spring-springmvc-组件

SpringMVC的handMapping 比较重要的部分 比较重要的部分 比较重要的部分 关于组件的部分 这里以 RequestMappingHandlerMapping 为例子 默认的3个组件是&#xff1a; org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping org.springframework.web.servlet.mvc…

实现一个iOS晃动动画

有时候在开发中&#xff0c; 需要我们实现一个晃动动画&#xff0c; 达到一个提示的效果&#xff0c;如下图所示 思路&#xff0c; 我们要实现的本质上是一个旋转动画&#xff0c;然后 设置一个旋转角度&#xff0c;以底部中间为中心旋转&#xff0c; 左右各有一个旋转的角度…

C# 服务调用RFC函数获取物料信息,并输出生成Excel文件

这个例子是C#服务调用RFC函数&#xff0c;获取物料的信息&#xff0c;并生成Excel文件 上接文章&#xff1a;C#服务 文章目录 创建函数创建结构编写源代码创建批处理文件运行结果-成功部署服务器C#代码配置文件注意&#xff01;&#xff01; 创建函数 创建结构 编写源代码 创建…

戴尔/Dell 电脑按什么快捷键可以进入 Bios 设置界面?

BIOS&#xff08;基本输入输出系统&#xff09;是计算机硬件与操作系统之间的桥梁&#xff0c;它负责初始化和测试系统硬件组件&#xff0c;并加载启动操作系统。在某些情况下&#xff0c;如调整启动顺序、更改系统时间或日期、修改硬件配置等&#xff0c;您可能需要进入BIOS进…

利用3DGS中convert.py处理自采数据

前言 3DGS源码中convert.py提供对自采数据集的处理&#xff0c;需要预先安装Colmap和ImageMagick. ubuntu22.04安装colmap 点击进入NVIDIA官网&#xff0c;查看GPU的CMAKE_CUDA_ARCHITECTURES 1、克隆colmap源码&#xff0c;并进入colmap文件夹 git clone https://github.c…

数据结构(ing)

学习内容 指针 指针的定义&#xff1a; 指针是一种变量&#xff0c;它的值为另一个变量的地址&#xff0c;即内存地址。 指针在内存中也是要占据位置的。 指针类型&#xff1a; 指针的值用来存储内存地址&#xff0c;指针的类型表示该地址所指向的数据类型并告诉编译器如何解…

实践:事件循环

实践&#xff1a;事件循环 代码示例 console.log(1); setTimeout(() > console.log(2), 0); Promise.resolve(3).then(res > console.log(res)); console.log(4);上述的代码的输出结果是什么 1和4肯定优先输出&#xff0c;因为他们会立即方式堆栈的执行上下文中执行&am…

从零开始开发纯血鸿蒙应用之逻辑封装

从零开始开发纯血鸿蒙应用 一、前言二、逻辑封装的原则三、实现 FileUtil1、统一的存放位置2、文件的增删改查2.1、文件创建与文件保存2.2、文件读取2.2.1、读取内部文件2.2.2、读取外部文件 3、文件删除 四、总结 一、前言 应用的动态&#xff0c;借助 UI 响应完成&#xff0…

ESP32 I2S音频总线学习笔记(一):初识I2S通信与配置基础

文章目录 简介为什么需要I2S&#xff1f;关于音频信号采样率分辨率音频声道 怎样使用I2S传输音频&#xff1f;位时钟BCLK字时钟WS串行数据SD I2S传输模型I2S通信格式I2S格式左对齐格式右对齐格式 i2s基本配置i2s 底层API加载I2S驱动设置I2S使用的引脚I2S读取数据I2S发送数据卸载…

CSS 中 content换行符实现打点 loading 正在加载中的效果

我们动态加载页面内容的时候&#xff0c;经常会使用“正在加载中…”这几个字&#xff0c;基本上&#xff0c;后面的 3 个点都是静态的。静态的问题在于&#xff0c;如果网络不流畅&#xff0c;加载时间比较长&#xff0c;就会给人有假死的 感觉&#xff0c;但是&#xff0c;如…

25考研王道数据结构课后习题笔记

声明&#xff1a;以下内容来自于B栈知名up主–白话拆解数据结构 回答&#xff1a;为什么要做这个&#xff0c;因为我这个学期学完了数据结构&#xff0c;而且这个数据结构是408的重头&#xff0c;为什么选择25的&#xff0c;因为这个25考研刚刚结束&#xff0c;25相对成熟&…

小程序发版后,强制更新为最新版本

为什么要强制更新为最新版本&#xff1f; 在小程序的开发和运营过程中&#xff0c;强制用户更新到最新版本是一项重要的策略&#xff0c;能够有效提升用户体验并保障系统的稳定性与安全性。以下是一些主要原因&#xff1a; 1. 功能兼容 新功能或服务通常需要最新版本的支持&…

GRAPE——RLAIF微调VLA模型:通过偏好对齐提升机器人策略的泛化能力(含24年具身模型汇总)

前言 24年具身前沿模型大汇总 过去的这两年&#xff0c;工作之余&#xff0c;我狂写大模型与具身的文章&#xff0c;加之具身大火&#xff0c;每周都有各种朋友通过CSDN私我及我司「七月在线」寻求帮助/指导(当然&#xff0c;也欢迎各大开发团队与我司合作共同交付&#xff09…

0xc0000020错误代码怎么处理,Windows11、10坏图像错误0xc0000020的修复办法

“0xc0000020”是一种 Windows 应用程序错误代码&#xff0c;通常表明某些文件缺失或损坏。这可能是由于系统文件损坏、应用程序安装或卸载问题、恶意软件感染、有问题的 Windows 更新等原因导致的。 比如&#xff0c;当运行软件时&#xff0c;可能会出现类似“C:\xx\xxx.dll …