valid参数校验

最新推荐文章于 2025-03-09 20:56:23 发布

原创最新推荐文章于 2025-03-09 20:56:23 发布 · 1k 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#leetcode #java #贪心算法

Web开发专栏收录该内容

20 篇文章

订阅专栏

本文详细介绍如何在Spring Boot项目中实现GET和POST请求参数的有效校验，包括引入依赖、配置异常处理、具体实践案例及常见注解说明。

valid参数校验

1.引入相关依赖

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

2.配置全局异常处理

@ControllerAdvice
@RestControllerAdvice
@Slf4j
public class ValidExceptionHandler extends GlobalExceptionHandler {

    // GET请求参数异常处理
    @ExceptionHandler(value = ConstraintViolationException.class)
    public Result<Object> constraintViolationExceptionHandler(ConstraintViolationException e) {
        StringBuilder msg = new StringBuilder();
        Set<ConstraintViolation<?>> constraintViolations = e.getConstraintViolations();
        for (ConstraintViolation<?> constraintViolation : constraintViolations) {
            String message = constraintViolation.getMessage();
            msg.append(message).append(";");
        }
        return ResultResponse.getFailResult(ResultCode.BODY_NOT_MATCH.getResultCode(), msg.toString());
    }

    @ExceptionHandler(ArithmeticException.class)
    public Result<Object> arithmeticExceptionHandler(ArithmeticException e) {
        e.printStackTrace();
        return ResultResponse.getFailResult(ResultCode.NOT_FOUND.getResultCode(), "算术异常！"+e.getMessage());
    }

    // POST请求参数异常处理
    @ExceptionHandler(BindException.class)
    public Result<Object> bindExceptionHandler(BindException e) {
        FieldError fieldError = e.getBindingResult().getFieldError();
        String msg;
        if (Objects.isNull(fieldError)) {
            msg = "POST请求参数异常:" + JSON.toJSONString(e.getBindingResult());
            log.info(msg);
        } else {
            msg = fieldError.getDefaultMessage();
        }
        return ResultResponse.getFailResult(ResultCode.BODY_NOT_MATCH.getResultCode(), msg);
    }

}

3.GET请求参数校验

@RestController
@RequestMapping(value = "/test")
@Slf4j
//@ApiIgnore
@Validated
public class TestController {

    @GetMapping(value = "/test")
    public Result<Object> test(@NotNull(message = "name必传")
                                   @NotBlank(message = "name格式错误")String name) {
        return ResultResponse.getSuccessResult("hello: " + name);
    }

}

请求示例1:

请求示例2:
在这里插入图片描述

4.POST请求参数校验

@RestController
@RequestMapping(value = "/test")
@Slf4j
@Validated
@ApiIgnore
public class TestController {
    
    @PostMapping(value = "/test1")
    public Result<Object> test1 (@Valid @RequestBody UserRequest user) {
        return ResultResponse.getSuccessResult(user);
    }

}

@Data
public class UserRequest implements Serializable {

    @NotNull(message = "userId必传")
    @Min(value = 1, message = "userId格式错误")
    private Long userId;

    @NotNull(message = "name必传")
    @NotBlank(message = "name格式错误")
    private String name;

    @Valid
    @NotEmpty(message = "至少传一个girlFriend")
    private List<UserRequest> girlFriends;

}

请求示例1:
在这里插入图片描述

请求示例2:
在这里插入图片描述

请求示例3:
在这里插入图片描述

5.相关注解

注解	解释
@Null	限制只能为null
@NotNull	限制必须不为null
@AssertFalse	限制必须为false
@AssertTrue	限制必须为true
@DecimalMax(value)	限制必须为一个不大于指定值的数字
@DecimalMin(value)	限制必须为一个不小于指定值的数字
@Digits(integer,fraction)	限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction
@Future	限制必须是一个将来的日期
@Past	限制必须是一个过去的日期
@Max(value)	限制必须为一个不大于指定值的数字
@Min(value)	限制必须为一个不小于指定值的数字
@Pattern(value)	限制必须符合指定的正则表达式
@Size(max,min)	限制字符长度必须在min到max之间
@NotEmpty	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@NotBlank	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty @NotBlank只应用于字符串且在比较时会去除字符串的空格
@Email	验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式