springboot项目使用validated参数校验框架

目录

前言

一、validated是什么?

二、使用步骤

1.引入maven依赖

2.使用实现

总结



前言

当谈到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项目开发中遇到的参数校验问题提供一些启发和帮助。如有需要进一步了解或其他问题,请随时告诉我。

相关推荐
洲覆几秒前
Redis 驱动适配 Reactor 模式
开发语言·网络·数据库·redis
fl176831几秒前
基于matlab实现的DnCNN网络
开发语言·matlab
第二层皮-合肥1 分钟前
如何设置等长的最大走线长度
服务器·开发语言·php
搬砖的工人6 分钟前
记录WinFrom 使用 Autoupdater.NET.Official 进行软件升级更新
java·前端·.net
努力进修12 分钟前
【JavaEE初阶】 多线程编程核心:解锁线程创建、方法与状态的创新实践密码
android·java·java-ee
掘根19 分钟前
【Protobuf】proto3语法详解1
开发语言·前端·javascript
Lee_yayayayaya19 分钟前
《通信之道—从微积分到5G》阅读笔记
开发语言·matlab
xiezhr19 分钟前
见过哪些醍醐灌顶的Java代码:从"卧槽"到"原来如此"的顿悟
java·后端·设计模式
当战神遇到编程21 分钟前
数组的定义与使用
java·idea
普密斯科技24 分钟前
图像尺寸测量仪应用Type-C接口:精准检测,赋能科技
c语言·开发语言·科技