Springboot中请求参数校验

原创

已于 2023-04-19 17:17:11 修改 · 2.9k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#java #开发语言

于 2022-03-11 14:51:31 首次发布

本文介绍了如何在Spring Boot中实现参数校验和异常处理，包括添加依赖、配置拦截器、定义参数规则、使用校验注解以及处理不同类型的参数校验异常。通过示例展示了如何在控制器中优雅地处理参数错误，并提供了常见的校验注解说明和问题解答。

1.添加依赖

<!-- 参数校验 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2.添加拦截器

拦截器用来拦截校验参数统一封装响应数据

package com.hhmt.delivery.handler;

import com.hhmt.delivery.ocpx.bean.ResultVo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.support.DefaultMessageSourceResolvable;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.stream.Collectors;

/**
 * 辉煌明天
 * FileName: ValidatedAdvice
 * Author:   huachun
 * email: huachun_w@163.com
 * Date:     2022/3/11 11:52
 * Description:
 */
@ControllerAdvice
@Slf4j
public class ValidatedAdvice {

    //处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常，详情继续往下看代码
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public ResultVo BindExceptionHandler(BindException e) {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        return ResultVo.error(message);
    }

    //处理请求参数格式错误 @RequestParam上validate失败后抛出的异常是javax.validation.ConstraintViolationException
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public ResultVo ConstraintViolationExceptionHandler(ConstraintViolationException e) {
        String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
        return ResultVo.error(message);
    }

    //处理请求参数格式错误 @RequestBody上validate失败后抛出的异常是MethodArgumentNotValidException异常。
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public ResultVo MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        return ResultVo.error(message);
    }
}

3.添加拦截配置

如果多个请求参数都校验失败，则遇到第一个校验失败就抛出异常，接下来的异常参数不做校验，配置如下

package com.hhmt.delivery.config;

import org.hibernate.validator.HibernateValidator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.validation.beanvalidation.MethodValidationPostProcessor;

import javax.validation.Validation;
import javax.validation