javax.validation在Spring Boot请求中使用

最新推荐文章于 2025-08-09 14:14:53 发布

原创最新推荐文章于 2025-08-09 14:14:53 发布 · 1.6k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

SpringBoot 同时被 2 个专栏收录

2 篇文章

订阅专栏

接口

1 篇文章

订阅专栏

本文介绍了如何在Springboot应用中实现请求参数的校验，包括在pom.xml引入validation starter，使用javax.validation注解在实体类中定义规则，通过@Valid注解在控制器方法中启用验证，以及捕获并处理BindException异常，提供统一的错误响应。

在Spring boot中对请求的参数做简单的验证，可以使用javax.validation注解。需要做以下配置：

1. 在pom.xml配置，引入spring boot validation starter (这步比较容易遗漏，因为代码中没有对它的引用依赖，打包编译都不会报错)

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

2. 在需要请求的实体类中使用javax.validation注解

import lombok.Data;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

@Data
public class QueryVo {
    private String data;

    @NotEmpty(message = "Input can not be empty!")
    @NotNull(message = "Input can not be empty!")
    private String input;
}

3. 在对应的请求中使用@Valid 注解

    @ApiOperation(value = "查询")
    @RequestMapping(path = "/query", method = RequestMethod.POST)
    @ResponseBody
    public APIModel query(@Valid @RequestBody QueryVo query) throws Exception {
        return service.query(query);
    }

4. 捕获异常并组装返回消息格式

    @ExceptionHandler(value = BindException.class)
    public APIModel bindExceptionHandler(HttpServletRequest request, BindException e) {
        logger.error("Error found:", e);
        BindingResult bindingResult = e.getBindingResult();
        List<ObjectError> objectErrors = bindingResult.getAllErrors();
        ObjectError objectError = objectErrors.get(0);
        return APIModel.error(objectError.getDefaultMessage());
    }