SpringBoot项目使用validated实现参数校验框架

 更新时间:2024年05月30日 09:13:44   作者:风止￴  
当谈到Spring的参数校验功能时,@Validated注解无疑是一个重要的利器,它为我们提供了一种简单而又强大的方式来验证请求参数的合法性,保证了系统的稳定性和安全性,本文将介绍Spring Validated的基本用法以及在实际项目中的应用,需要的朋友可以参考下

引言

当谈到Spring的参数校验功能时,@Validated注解无疑是一个重要的利器。它为我们提供了一种简单而又强大的方式来验证请求参数的合法性,保证了系统的稳定性和安全性。本文将介绍Spring Validated的基本用法以及在实际项目中的应用。

一、validated是什么?

  1. @Validated注解的作用和使用方法

    • 可以用于Controller类或方法上,开启对请求参数的校验功能。
    • 通过在方法参数上使用其他校验注解(如@NotNull、@NotBlank、@Min、@Max等),对请求参数进行校验和验证,确保参数的合法性。
    • 可配合使用Spring Validation API或其他支持JSR-303规范的验证框架(如Hibernate Validator),发挥@Validated注解的最大效用。
  2. @Validated注解的实际应用示例

    • 编写一个用户注册接口,结合@Pattern注解对用户名和密码进行格式校验。
    • 处理校验失败时的异常情况,并返回友好的错误信息给接口调用方。
  3. @Validated注解的注意事项和最佳实践

    • 讨论@Validated注解在复杂校验场景下的使用技巧。
    • 如何在全局配置文件中声明验证器或配置验证规则,使得@Validated注解更加灵活地适应各种项目需求。

二、使用步骤

1.引入maven依赖

代码如下(示例):

<!--        Validation合法性校验(参数)  参数校验框架的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

2.使用实现

代码如下 参数长度在  5 - 16位(示例):

/**
 * @Description: 用户相关的控制层
 * @Author: windStop
 * @Date: 2024/5/26 16:18
 */
@RestController
@RequestMapping("/user")
@Validated  //启用参数校验功能
public class UserController {
    @Autowired
    private UserService userService;

    /**
     * 用于注册新用户  在注册用户的时候需要先判断用户名是否存在,因为用户名不可以重复
     * 这里我不打算使用给用户名添加唯一字段
     * @param username 用户名
     * @param password 密码
     * @return 是否注册成功
     */
    @PostMapping("/register")
    public Result register(@Pattern(regexp = "^\\S{5,16}") String username, @Pattern(regexp = "^\\S{5,16}")String password){
        //1.判断用户是否存在
        if (userService.findByUsername(username)){
            return Result.error("用户名已存在无法注册");
        }
        //2.不存在进行注册
        boolean flag = userService.register(username,password);
        return Result.success(flag);
    }

}

总结

通过本文的学习,读者将深入了解Spring Validated的使用方法和原理,掌握在实际项目中如何有效地利用@Validated注解进行参数校验。希望本文能够为您在Spring项目开发中遇到的参数校验问题提供一些启发和帮助。如有需要进一步了解或其他问题,请随时告诉我。

以上就是SpringBoot项目使用validated实现参数校验框架的详细内容,更多关于SpringBoot validated参数校验的资料请关注脚本之家其它相关文章!

相关文章

  • Intellij IDEA下Spring Boot热切换配置

    Intellij IDEA下Spring Boot热切换配置

    这篇文章主要介绍了Intellij IDEA下Spring Boot热切换配置,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • Java基础之容器Vector详解

    Java基础之容器Vector详解

    这篇文章主要介绍了Java基础之容器Vector详解,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好的帮助,需要的朋友可以参考下
    2021-04-04
  • 轻松掌握java责任链模式

    轻松掌握java责任链模式

    这篇文章主要帮助大家轻松掌握java责任链模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-09-09
  • Java SimpleDateFormat与System类使用示例详解

    Java SimpleDateFormat与System类使用示例详解

    这篇文章主要介绍了Java SimpleDateFormat与System类使用示例,对于SimpleDateFormat类,是一个用来区分区域设置的方式进行日期的是指,以及对日期进行处理分析的一个实现类
    2022-11-11
  • mybatis-plus用insertBatchSomeColumn方法批量新增指定字段

    mybatis-plus用insertBatchSomeColumn方法批量新增指定字段

    mybatisPlus底层的新增方法是一条一条的新增的,下面这篇文章主要给大家介绍了关于mybatis-plus用insertBatchSomeColumn方法批量新增指定字段的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-05-05
  • SpringBoot中Mockito单元测试入门

    SpringBoot中Mockito单元测试入门

    单元测试在很多地方都用的到,本文主要介绍了SpringBoot中Mockito单元测试入门,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-06-06
  • 冒泡排序的原理及java代码实现

    冒泡排序的原理及java代码实现

    冒泡排序法:关键字较小的记录好比气泡逐趟上浮,关键字较大的记录好比石块下沉,每趟有一块最大的石块沉底。算法本质:(最大值是关键点,肯定放到最后了,如此循环)每次都从第一位向后滚动比较,使最大值沉底,最小值上升一次,最后一位向前推进
    2016-02-02
  • Mybatis中and和循环or混用操作(or转换成in)

    Mybatis中and和循环or混用操作(or转换成in)

    这篇文章主要介绍了Mybatis中and和循环or混用操作(or转换成in),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • java使用OGEngine开发2048

    java使用OGEngine开发2048

    众所周知OGEngine是国人对AndEngine改进后的国产Java编程的游戏引擎,除了支持3D游戏这个鸡肋功能之外AndEngine的功能OGEngine都有,而且AndEngine缺少的多点触摸功能也被国人完善了。今天我们就尝试下使用OGEngine制作热门游戏2048.
    2015-03-03
  • 解决springboot导入失败,yml未识别的问题

    解决springboot导入失败,yml未识别的问题

    这篇文章主要介绍了解决springboot导入失败,yml未识别的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-07-07

最新评论