Spring Boot 自动参数校验的实现步骤

 更新时间:2025年06月03日 10:18:51   作者:yuren_xia  
在 Spring Boot中实现参数自动校验主要依靠 Java Bean Validation API(JSR 380)和 Spring 的集成支持,下面给大家介绍Spring Boot 自动参数校验的实现步骤,感兴趣的朋友一起看看吧

在 Spring Boot 中实现参数自动校验主要依靠 Java Bean Validation API(JSR 380)和 Spring 的集成支持。以下是详细实现步骤:

1. 添加依赖

pom.xml 中添加验证依赖:

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

2. 在实体类/DTO中添加校验注解

使用注解标记需要校验的字段:

public class UserDTO {
    @NotBlank(message = "用户名不能为空")
    private String username;
    @Email(message = "邮箱格式不正确")
    private String email;
    @Min(value = 18, message = "年龄必须大于18岁")
    private int age;
    @Pattern(regexp = "1[3-9]\\d{9}", message = "手机号格式不正确")
    private String phone;
    // Getter/Setter省略
}

常用校验注解

  • @NotNull:非 null
  • @NotBlank:非空(字符串)
  • @NotEmpty:非空集合/数组
  • @Min/@Max:数值范围
  • @Size:长度范围
  • @Email:邮箱格式
  • @Pattern:正则表达式

3. 在Controller中使用校验

在接收参数的请求方法中添加 @Valid@Validated

@PostMapping("/create")
public ResponseEntity<?> createUser(@Valid @RequestBody UserDTO userDTO) {
    // 校验通过后执行业务逻辑
    return ResponseEntity.ok("用户创建成功");
}

注意@Valid 是标准 JSR 注解,@Validated 是 Spring 的增强版(支持分组校验)。

4. 处理校验异常

添加全局异常处理器捕获校验失败异常:

@RestControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationException(MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getFieldErrors().forEach(error -> {
            errors.put(error.getField(), error.getDefaultMessage());
        });
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errors);
    }
}

响应示例

{
    "username": "用户名不能为空",
    "email": "邮箱格式不正确"
}

5. 进阶用法

分组校验(不同场景不同规则)

定义分组接口:

public interface CreateGroup {}
public interface UpdateGroup {}

在 DTO 中指定分组:

public class UserDTO {
    @NotNull(groups = UpdateGroup.class, message = "ID不能为空")
    private Long id;
    @NotBlank(groups = {CreateGroup.class, UpdateGroup.class})
    private String name;
}

Controller 指定分组:

@PostMapping("/update")
public void updateUser(@Validated(UpdateGroup.class) @RequestBody UserDTO dto) {
    // ...
}

自定义校验注解

创建自定义注解:

@Target({FIELD})
@Retention(RUNTIME)
@Constraint(validatedBy = PhoneValidator.class)
public @interface ValidPhone {
    String message() default "手机号格式错误";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

实现校验逻辑:

public class PhoneValidator implements ConstraintValidator<ValidPhone, String> {
    @Override
    public boolean isValid(String phone, ConstraintValidatorContext context) {
        return phone != null && phone.matches("1[3-9]\\d{9}");
    }
}

6. 测试校验

使用 Postman 或 curl 发送无效请求:

curl -X POST http://localhost:8080/create \
-H "Content-Type: application/json" \
-d '{"username":"", "email":"invalid-email"}'

将返回:

{
    "username": "用户名不能为空",
    "email": "邮箱格式不正确"
}

总结流程:

graph TD
    A[添加依赖] --> B[DTO添加校验注解]
    B --> C[Controller添加@Valid]
    C --> D[全局异常处理器]
    D --> E[返回错误信息]

通过以上步骤,Spring Boot 会自动完成参数校验,无需手动编写校验逻辑,大幅提升开发效率。

到此这篇关于Spring Boot 自动参数校验的文章就介绍到这了,更多相关Spring Boot 自动参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • springboot2.x整合shiro权限框架的使用

    springboot2.x整合shiro权限框架的使用

    这篇文章主要介绍了springboot2.x整合shiro权限框架的使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 自定义log4j2中的Appender来获取日志内容的示例代码

    自定义log4j2中的Appender来获取日志内容的示例代码

    在 Log4j2 中,Appender 是负责将日志事件输出到目标地点的组件,本文讲述的是通过 log4j 中自定义的 Appender 来获取需要打印的日志信息,文中有详细的代码示例供大家参考,需要的朋友可以参考下
    2024-02-02
  • mybatisPlus更新字段值为null的解决方案

    mybatisPlus更新字段值为null的解决方案

    在使用mybatis-plus时,发现当前端传入的值为null值时,结果无论怎么操作后端都不执行更新null字段的操作,下面这篇文章主要给大家介绍了关于mybatisPlus更新字段值为null的解决方案,需要的朋友可以参考下
    2023-04-04
  • springboot结合前端实现网页跳转功能实例

    springboot结合前端实现网页跳转功能实例

    今天处理Springboot统一异常拦截的时候,遇到了页面跳转的问题,这篇文章主要给大家介绍了关于springboot结合前端实现网页跳转功能的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-12-12
  • java模拟http的Get/Post请求,并设置ip与port代理的方法

    java模拟http的Get/Post请求,并设置ip与port代理的方法

    下面小编就为大家带来一篇java模拟http的Get/Post请求,并设置ip与port代理的方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-02-02
  • 一篇文章带你入门Java UML的类图

    一篇文章带你入门Java UML的类图

    这篇文章主要为大家详细介绍了Java UML的类图,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-02-02
  • 一文详解Java线程的6种状态与生命周期

    一文详解Java线程的6种状态与生命周期

    一个线程在给定的时间点只能处于一种状态。线程可以有6种状态:New、Runnable、Blocked、Waiting、Timed waiting和Terminated。本文将详细讲解这6种状态,需要的可以参考一下
    2022-05-05
  • Java编写简单计算器的完整实现过程

    Java编写简单计算器的完整实现过程

    这篇文章主要给大家介绍了关于Java编写简单计算器的完整实现过程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • 使用Java实现简单的区块链程序的方法

    使用Java实现简单的区块链程序的方法

    这篇文章主要介绍了使用Java实现简单的区块链程序的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • Java Swagger使用教程

    Java Swagger使用教程

    Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化 Restful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法、参数和模型紧密集成到服务器端的代码,允许API来始终保持同步
    2022-07-07

最新评论