Spring Boot 参数校验

1、常用注解

  • @NotNull :确保字段的值不能为 null。
java 复制代码
@NotNull(message = "用户名不能为空")
private String username;
  • @NotEmpty :确保字符串不能为 null 或空字符串 ""。
java 复制代码
@NotEmpty(message = "密码不能为空")
private String password;
  • @NotBlank :确保字符串不能为 null 或空格字符(包括空格、tab 等)。
java 复制代码
@NotBlank(message = "用户名不能为空")
private String username;
  • @Size:用于约束字符串、集合、数组的大小。
java 复制代码
@Size(min = 5, max = 20, message = "用户名长度必须在 5 到 20 个字符之间")
private String username;
  • @Min 和 @Max:用于对数字进行大小校验。
java 复制代码
@Min(value = 18, message = "年龄必须大于等于 18 岁")
private int age;

@Max(value = 100, message = "年龄不能超过 100 岁")
private int age;
  • @Email:用于校验邮箱格式。
java 复制代码
@Email(message = "邮箱格式不正确")
private String email;
  • @Pattern:用于校验字符串是否匹配正则表达式。
java 复制代码
@Pattern(regexp = "^[A-Za-z0-9]+$", message = "用户名只能包含字母和数字")
private String username;
  • @Range :用于数字范围校验(@Min 和 @Max 的组合)。
java 复制代码
@Range(min = 18, max = 100, message = "年龄必须在 18 到 100 之间")
private int age;
  • @AssertTrue 和 @AssertFalse:用于验证布尔值。
java 复制代码
@AssertTrue(message = "必须为成年人")
private boolean isAdult;
  • @Valid :用于嵌套对象的校验。通常在对象的属性为另一个对象时,使用 @Valid 来触发子对象的校验。
java 复制代码
public class User {
    @Valid
    private Address address;
}

2、Spring Boot中实现参数校验

2.1 引入依赖pom.xml

xml 复制代码
<!-- 参数校验 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.2 在实体类上添加校验注解

2.3 在Controller方法参数上添加@Validated

2.4 在全局异常处理中添加参数校验异常处理

java 复制代码
@ExceptionHandler(MethodArgumentNotValidException.class)
public Result<String> handleValidationException(MethodArgumentNotValidException e) {
    String message = e.getBindingResult().getFieldErrors().stream()
            .map(error -> error.getField() + ": " + error.getDefaultMessage())
            .collect(Collectors.joining("; "));
    return Result.error(400, message);
}
相关推荐
特立独行的猫A3 小时前
别再用 nohup 了:让应用在后台常驻的正确姿势与 systemd 服务详解
java·后端·python
一起_java4 小时前
技术文章-基于Dify-Agent的智能问答系统设计与实现
java·spring boot·后端·agent·dify
Flynn Liang5 小时前
I/O 密集型高并发实战:Java 服务 10 维优化,从线程打满到 10 万 QPS
java·spring boot·性能优化·高并发·系统设计·虚拟线程·io密集型
吃我一窝jio6 小时前
Python与Go线程模型深度对比
java·开发语言·python
这个昵称不容易6 小时前
SpringBoot 购物推荐网站的设计与实现:120 个 Java 文件、147 个接口、13 张表,附真实运行截图
java·springboot·毕设
文丑颜不良啊6 小时前
LeetCode3041~3060题目解析
java·leetcode
文丑颜不良啊8 小时前
LeetCode3101~3120题目解析
java·leetcode
Resean02238 小时前
SpringMVC 6+源码分析(十一)视图渲染与异步请求(收尾篇)
java·spring·springmvc
靠沿9 小时前
MySQL数据库进阶——存储过程和触发器
java·数据库·mysql
码少女9 小时前
MySQL--库与表的增删改查基础
java·数据库·mysql