当前位置: 首页 > article >正文

Spring Boot中常用的JSR 380参数校验注解

@NotNull: 验证对象值不应为 null。
@AssertTrue: 验证布尔值是否为 true。
@AssertFalse: 验证布尔值是否为 false。
@Min(value): 验证数字是否不小于指定的最小值。
@Max(value): 验证数字是否不大于指定的最大值。
@DecimalMin(value): 验证数字值(可以是浮点数)是否不小于指定的最小值。
@DecimalMax(value): 验证数字值(可以是浮点数)是否不大于指定的最大值。
@Positive: 验证数字值是否为正数。
@PositiveOrZero: 验证数字值是否为正数或零。
@Negative: 验证数字值是否为负数。
@NegativeOrZero: 验证数字值是否为负数或零。
@Size(min, max): 验证元素(如字符串、集合或数组)的大小是否在给定的最小值和最大值之间。
@Digits(integer, fraction): 验证数字是否在指定的位数范围内。例如,可以验证一个数字是否有两位整数和三位小数。
@Past: 验证日期或时间是否在当前时间之前。
@PastOrPresent: 验证日期或时间是否在当前时间或之前。
@Future: 验证日期或时间是否在当前时间之后。
@FutureOrPresent: 验证日期或时间是否在当前时间或之后。
@Pattern(regexp): 验证字符串是否与给定的正则表达式匹配。
@NotEmpty: 验证元素(如字符串、集合、Map 或数组)不为 null,并且其大小/长度大于0。
@NotBlank: 验证字符串不为 null,且至少包含一个非空白字符。
@Email: 验证字符串是否符合有效的电子邮件格式。

如何使用?

导入参数校验的依赖

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

在实体类中需要校验的字段添加注解即可,如:

@Data
public class User {
    @NotBlank(message = "用户名不能为空")
    private String username;

    @NotBlank(message = "密码不能为空")
    private String password;

    @NotBlank(message = "邮箱不能为空")
    @Email(message = "邮箱格式不正确")
    private String email;

    @NotBlank(message = "手机号不能为空")
    @Size(min = 11, max = 11, message = "手机号少于11位")
    private String phone;
    
    @Min(value = 18, message = "年龄必须大于18岁")
    @Max(value = 100, message = "年龄不能大于100岁")
    private String age;
}

在控制器类中指定需要进行参数校验的类

@RequestMapping("/test")
@RestController
public class TestController {
    @PostMapping("/user")
    @ApiOperationlog(description = "测试接口")
    public Response testA(@RequestBody @Validated User user, BindingResult bindingResult){
        if (bindingResult.hasErrors()){
            //获取参数校验失败的信息
            String errorMessage = bindingResult.getFieldErrors()
                    .stream()
                    .map(FieldError::getDefaultMessage).
                    collect(Collectors.joining(","));
            return Response.failed(errorMessage);
        }
        return Response.success();
    }
}
// @Validated注解指定需要校验的类
//BindingResult 校验结果

效果如下
入参

{
 "username":"123",
 "password":"123",
 "email":"@qq.com",
 "phone":"123",
 "age":"1000"
 }

响应


{
    "code": "201",
    "message": "邮箱格式不正确,手机号少于11位,年龄不能大于100岁",
    "data": null
}

http://www.kler.cn/news/330166.html

相关文章:

  • 项目级别的配置文件 `.git/config`||全局配置文件 `~/.gitconfig`
  • Qt --- 界面优化 --- QSS和绘图API
  • ML 系列: (10)— ML 中的不同类型的学习
  • 【rCore OS 开源操作系统】Rust 练习题题解: Enums
  • Nacos 是阿里巴巴开源的一款动态服务发现、配置管理和服务管理平台,旨在帮助开发者更轻松地构建、部署和管理微服务应用。
  • python单例和工厂模式
  • OpenCV库 详细常见操作
  • Lumerical脚本语言-系统(System)
  • RAG(检索增强生成)新探索:IdentityRAG 提高 RAG 准确性
  • springboot儿童物品共享平台的设计与实现
  • VMware Aria Suite Lifecycle 8.18 发布,新增功能概览
  • Go基础学习10-原子并发包sync.atomic的使用:CSA、Swap、atomic.Value......
  • 基于单片机的两轮直立平衡车的设计
  • 经验笔记:JavaScript 中的对象
  • 阿里云部署1Panel(失败版)
  • setState是同步更新还是异步更新
  • 基于Python的人工智能应用案例系列(18):SpaCy简历信息抽取
  • 旅游避坑指南
  • 基础岛第6关:OpenCompass 评测 InternLM-1.8B 实践
  • 深入了解 Ne10:优化 ARM 处理器的数字信号处理库
  • [C++][第三方库][gflags]详细讲解
  • Vue项目开发注意事项
  • Ubuntu22.04之测试本机网口速度(二百七十二)
  • PySpark把一列数据上下移动,时序数据
  • 【趣学Python算法100例】三色球
  • 认知杂谈94《菜鸟的自我修炼:创业的那些事》
  • 两数相加leetcode
  • 样式重置 normalize.css
  • 【零基础入门产品经理】学习准备篇 | 需要学一些什么呢?
  • 死锁的成因与解决方案