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

更新时间：2024年05月30日 09:13:44 作者：风止￴

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

引言

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

一、validated是什么？

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

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

编写一个用户注册接口，结合@Pattern注解对用户名和密码进行格式校验。
处理校验失败时的异常情况，并返回友好的错误信息给接口调用方。
@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参数校验的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

基于RxPaparazzo实现图片裁剪、图片旋转、比例放大缩小功能
这篇文章主要为大家详细介绍了基于RxPaparazzo实现图片裁剪、图片旋转、比例放大缩小功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-05-05
Springboot中动态语言groovy介绍
Apache的Groovy是Java平台上设计的面向对象编程语言，这门动态语言拥有类似Python、Ruby和Smalltalk中的一些特性，可以作为Java平台的脚本语言使用，这篇文章主要介绍了springboot中如何使用groovy,需要的朋友可以参考下
2022-09-09
java Timer 定时每天凌晨1点执行任务
这篇文章主要介绍了java Timer 定时每天凌晨1点执行任务的代码，代码简单易懂，非常不错，具有一定的参考借鉴价值,需要的朋友可以参考下
2019-09-09
Mybatis空值关联的具体实现
在复杂的数据库查询中,处理空值关联是一项常见的需求,本文就来介绍一下Mybatis空值关联的具体实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2024-07-07
IDEA 去除 mybatis.xml 文件黄色警告的图文教程
这篇文章主要介绍了IDEA 去除 mybatis.xml 文件黄色警告的方法，本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
2020-07-07
Spring Boot利用Lombok减少Java中样板代码的方法示例
spring Boot是非常高效的开发框架，lombok是一套代码模板解决方案，将极大提升开发的效率，下面这篇文章主要给大家介绍了关于Spring Boot利用Lombok减少Java中样板代码的相关资料，需要的朋友可以参考借鉴，下面来一起看看吧。
2017-09-09
Java实现带头结点的单链表
这篇文章主要为大家详细介绍了Java实现带头结点的单链表，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-09-09
Spring MVC实现mysql数据库增删改查完整实例
这篇文章主要介绍了Spring MVC实现mysql数据库增删改查完整实例，从创建一个web项目开始，分享了项目结构以及具体Java代码和前端页面等相关内容，具有一定借鉴价值，需要的朋友可以了解下。
2017-12-12
java网络编程学习java聊天程序代码分享
java聊天程序代码分享,大家参考使用吧
2013-12-12
Springboot实现对配置文件中的明文密码加密详解
我们在SpringBoot项目当中，会把数据库的用户名密码等配置直接放在yaml或者properties文件中，这样维护数据库的密码等敏感信息显然是有一定风险的。所以本文为大家整理了对配置文件中的明文密码加密的方法，希望对大家有所帮助
2023-03-03