springboot 增加，入参校验，controller异常全局处理

最新推荐文章于 2024-05-01 15:49:44 发布
最新推荐文章于 2024-05-01 15:49:44 发布
阅读量1.2k 收藏 4
点赞数
分类专栏： java spring web
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/hao_hl1314/article/details/99858408
版权
java 同时被 3 个专栏收录
32 篇文章 1 订阅
订阅专栏
web
13 篇文章 0 订阅
订阅专栏
spring
4 篇文章 0 订阅
订阅专栏

不废话，直接上代码

1.配置参数校验

pom中引入参数校验器

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

增加手动验证类

/**
 * 对象验证器
 * @Author hl1314
 * @Date 11:04 2019-08-19
 **/
public class BeanValidator {


    /**
     * 验证某个bean的参数
     * @Author hl1314
     * @Date 11:04 2019-08-19
     * @Param [object]
     * @return void
     **/
    public static <T> void validate(T object,Class<?>... var) {
        //获得验证器
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        //执行验证
        Set<ConstraintViolation<T>> constraintViolations = validator.validate(object,var);
        //如果有验证信息，则取出来包装成异常返回
        if (CollectionUtils.isEmpty(constraintViolations)) {
            return;
        }
        throw new ValidationException(convertErrorMsg(constraintViolations));
    }

    /**
     * 验证bean list
     * @Author hl1314
     * @Date 11:44 2019-08-19
     * @Param [objectList, var]
     * @return void
     **/
    public static <T> void validate(List<T> objectList, Class<?>... var) {
        for(T t : objectList){
            validate(t,var);
        }
    }

    /**
     * 拼接异常信息  
     * @Author hl1314
     * @Date 11:31 2019-08-19
     * @Param [set]
     * @return java.lang.String
     **/
    private static <T> String convertErrorMsg(Set<ConstraintViolation<T>> set) {
        Map<String, StringBuilder> errorMap = new HashMap<>(4);
        String property;
        for (ConstraintViolation<T> cv : set) {
            //循环获取错误信息
            property = cv.getPropertyPath().toString();
            if (errorMap.get(property) != null) {
                errorMap.get(property).append("," + cv.getMessage());
            } else {
                StringBuilder sb = new StringBuilder();
                sb.append(cv.getMessage());
                errorMap.put(property, sb);
            }
        }
        return errorMap.toString();
    }
}

定义校验分组,分组没有实际意义，只是区分每次验证那一组

/**
 * @author : hl1314
 * @description: delete分组
 * @data :  2019-08-19  11:20
 */
public interface Delete {
}

/**
 * @author : hl1314
 * @description: insert分组
 * @data :  2019-08-19  10:18
 */
public interface Insert {
}

/**
 * @author : hl1314
 * @description: select分组
 * @data :  2019-08-19  11:35
 */
public interface Select {
}

/**
 * @author : hl1314
 * @description: update分组
 * @data :  2019-08-19  10:19
 */
public interface Update {
}

在bean类中使用注解，验证参数

@Data
public class QueryDataDTO {

    @NotNull(message = "不能为空", groups = {Insert.class, Update.class})
    @Range(min = 1L, message = "最小为1", groups = {Insert.class,Update.class})
    private Long taskId;

    @NotNull(message = "不能为空", groups = {Insert.class,Update.class})
    @Range(min = 1L, message = "最小为1", groups = {Insert.class,Update.class})
    private Long queryId;

    @Range(min = 0,max = 9,message = "类型异常，超出范围", groups = {Insert.class,Update.class})
    @NotNull(message = "不能为空", groups = {Insert.class,Update.class})
    private Integer geoType;

    @NotBlank(message = "不能为空", groups = {Insert.class})
    private String wkt;

    @Range(min = 0,max = 50,message = "超出范围", groups = {Insert.class,Update.class})
    @NotNull(message = "查询地址列不能为空", groups = {Insert.class,Update.class})
    private Integer addressColumn;

    @Pattern(regexp="^[0-9]*$",message = "必须是数字", groups = {Insert.class,Update.class})
    @NotNull(message = "不能为空", groups = {Insert.class,Update.class})
    private String selectType;


}

在controller中手动验证，两个方法的验证错误都将错误抛出了，所以，需要加全局异常处理

    /**
     * 校验对象，手动触发校验
     *
     * @Author hl1314
     * @Date 17:50 2019-07-16
     * @Param [importDataDTO]
     **/
    @RequestMapping(value = "/importData", method = {RequestMethod.POST})
    @ResponseBody
    public ShortResponseVO importData(@RequestBody QueryDataDTO dto) throws Exception {
        //只校验Insert分组
        BeanValidator.validate(dto, Insert.class);
        dataAnalysisService.importDataAnalysisTemp(importDataDTO);
        return ShortResponseVO.success(null);
    }


    /**
     * 在参数上使用校验，需要在controller类上加，@Validated注解
     *
     * @Author hl1314
     * @Date 17:51 2019-07-16
     **/
    @RequestMapping(value = "/triggerDataAnalysis", method = {RequestMethod.GET})
    @ResponseBody
    public ShortResponseVO triggerDataAnalysis(@NotNull(message = "taskId不能为空") @Range(min = 1, message = "taskId最小为1") @RequestParam("taskId") Long taskId,
                                               @NotNull(message = "isDelayed不能为空") @Range(min = 0, max = 3, message = "isDelayed取值范围为0-3") @RequestParam("isDelayed") Integer isDelayed) throws Exception {

        dataAnalysisService.triggerDataReserveAnalysis(taskId, isDelayed);
        return ShortResponseVO.success(null);
    }

2.添加全局异常处理

首先增加自定义异常

/**
 * @author : hl1314
 * @description: 通用异常
 * @data :  2019-07-16  17:22
 */
public class CommonException extends RuntimeException {

    private Integer code;

    public Integer getCode() {
        return code;
    }

    public CommonException(String msg){
        super(msg);
    }

    public CommonException(String msg,Throwable cause){
        super(msg,cause);
    }

    public CommonException(String msg,Integer code,Throwable cause){
        super(msg,cause);
        this.code = code;
    }

    public CommonException(String msg,Integer code){
        super(msg);
        this.code = code;
    }
}

定义返回对象

/**
 * @author : hl1314
 * @description: 返回对象
 * @data :  2019-07-16  17:08
 */
@Data
@JsonSerialize(include= JsonSerialize.Inclusion.NON_NULL)
public class ShortResponseVO {

    private Integer code;

    private String message;

    private Object data;

    public ShortResponseVO(){

    }

    public ShortResponseVO(Integer code,String message){
        this.code = code;
        this.message = message;
    }

    public ShortResponseVO(Integer code,String message,Object data){
        this.code = code;
        this.message = message;
        this.data = data;
    }

    public static ShortResponseVO success(Object data){
        return new ShortResponseVO(ResponseCodeEnum.SUCCESS.getCode(),ResponseCodeEnum.SUCCESS.getMsg(),data);
    }

    public static ShortResponseVO err(){
        return new ShortResponseVO(ResponseCodeEnum.SYSTEM_ERROR.getCode(),ResponseCodeEnum.SYSTEM_ERROR.getMsg(),null);
    }
}

定义返回编码

/**
 * 返回编码
 * @Author hl1314
 * @Date 17:13 2019-07-16
 **/
public enum ResponseCodeEnum {
    SUCCESS(0,"OK"),
    SYSTEM_ERROR(1,"系统错误"),
    PARAM_IS_EMPTY(10001,"必填参数为空"),
    DATA_SIZE_TRANSFINITE(10002,"数据超限限制"),
    PARAM_IS_ERROR(10003,"参数填写错误"),
    PATH_ERROR(10004,"路径错误")
    ;

     /**
     * 获取msg
     * @Author hl1314
     * @Date 11:26 2019-07-17
     * @Param [code]
     * @return java.lang.String
     **/
    public static String getMsg(Integer code){
        for(ResponseCodeEnum enum : ResponseCodeEnum.values()){
            if(enum.code.equals(code)){
                return enum.msg;
            }
        }
        return null;
    }


    ResponseCodeEnum(Integer code,String msg){
        this.code = code;
        this.msg = msg;
    }

    private Integer code;

    private String msg;


    public Integer getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

}

 

全局异常拦截（需要拦截的异常可以再添加）

/**
 * 异常注解处理
 *
 * @Author hl1314
 * @Date 17:04 2019-08-17
 **/
@RestControllerAdvice
public class BadRequestExceptionHandler {

    private Logger logger = LoggerFactory.getLogger(BadRequestExceptionHandler.class);


    /**
     * validated类验证错误
     * @Author hl1314
     * @Date 17:50 2019-08-17
     * @Param [e]
     **/
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO validatedForClassExceptionHandler(ConstraintViolationException e) {
        Iterator<ConstraintViolation<?>> iterator = e.getConstraintViolations().iterator();
        StringBuffer msg = new StringBuffer();
        while (iterator.hasNext()) {
            ConstraintViolation<?> next = iterator.next();
            msg.append(next.getMessage());
            msg.append(";");
        }
        logger.error("validatedForClassExceptionHandler -> e={}", e.getLocalizedMessage());
        return new ShortResponseVO(ResponseCodeEnum.PARAM_IS_ERROR.getCode(), msg.toString());
    }


    /**
     * validated模型验证错误
     * @Author hl1314
     * @Date 10:59 2019-08-17
     * @Param [e]
     **/
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO validatedForModleExceptionHandler(MethodArgumentNotValidException e) {
        List<FieldError> fieldErrors = e.getBindingResult().getFieldErrors();
        StringBuffer msg = new StringBuffer();
        for (FieldError fieldError : fieldErrors) {
            msg.append(fieldError.getDefaultMessage());
            msg.append(";");
        }
        logger.error("validatedForModleExceptionHandler -> e={}", e.getLocalizedMessage());
        return new ShortResponseVO(ResponseCodeEnum.PARAM_IS_ERROR.getCode(), msg.toString());
    }

    /**
     * validated手动验证错误
     * @Author hl1314
     * @Date 12:50 2019-08-18
     * @Param [e]
     **/
    @ExceptionHandler(ValidationException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO validatedExceptionHandler(ValidationException e) {
        logger.error("validatedExceptionHandler -> e={}", e.getLocalizedMessage());
        return new ShortResponseVO(ResponseCodeEnum.PARAM_IS_ERROR.getCode(), e.getLocalizedMessage());
    }

    /**
     * 参数为空错误
     * @Author hl1314
     * @Date 11:40 2019-08-18
     * @Param [e]
     **/
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO missingServletRequestParameterExceptionHandler(MissingServletRequestParameterException e) {
        logger.error("missingServletRequestParameterExceptionHandler -> e={}", e.getLocalizedMessage(), e);
        return new ShortResponseVO(ResponseCodeEnum.PARAM_IS_EMPTY.getCode(), ResponseCodeEnum.PARAM_IS_EMPTY.getMsg() + ":" + e.getLocalizedMessage());
    }


    /**
     * 路径错误
     * @Author hl1314
     * @Date 10:00 2019-08-20
     * @Param [e]
     **/
    @ExceptionHandler(NoHandlerFoundException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO noHandlerFoundExceptionHandler(NoHandlerFoundException e) {
        logger.error("noHandlerFoundExceptionHandler -> e={}", e.getLocalizedMessage(), e);
        return new ShortResponseVO(ResponseCodeEnum.PATH_ERROR.getCode(), ResponseCodeEnum.PATH_ERROR.getMsg() + ":" + e.getLocalizedMessage());
    }


    /**
     * 自定义异常
     * @Author hl1314
     * @Date 10:45 2019-08-20
     * @Param [e]
     **/
    @ExceptionHandler(CommonException.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO commonExceptionHandler(CommonException e) {
        logger.error("commonExceptionHandler -> e={}", e.getLocalizedMessage());
        return new ShortResponseVO(e.getCode(), e.getMessage());
    }


    /**
     * http参数异常
     * @Author hl1314
     * @Date 14:50 2019-08-19
     * @Param [e]
     **/
    @ExceptionHandler({HttpMessageNotReadableException.class, MethodArgumentTypeMismatchException.class, TypeMismatchException.class})
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO httpParamExceptionHandler(Exception e) {
        logger.error("httpParamExceptionHandler -> e={}", e.getLocalizedMessage(), e);
        return new ShortResponseVO(ResponseCodeEnum.PARAM_IS_ERROR.getCode(), ResponseCodeEnum.PARAM_IS_ERROR.getMsg() + ":" + e.getLocalizedMessage());
    }


    /**
     * 异常处理
     *
     * @Author hl1314
     * @Date 18:09 2019-08-17
     * @Param [e]
     **/
    @ExceptionHandler(Exception.class)
    @ResponseBody
    @ResponseStatus(HttpStatus.OK)
    public ShortResponseVO runtimeExceptionHandler(Exception e) {
        logger.error("runtimeExceptionHandler -> e={}", e.getLocalizedMessage(), e);
        return new ShortResponseVO(ResponseCodeEnum.SYSTEM_ERROR.getCode(),ResponseCodeEnum.SYSTEM_ERROR.getMsg() + ":" + e.getLocalizedMessage());
    }

}

如果要校验路径等错误，需要在配置文件中添加

spring:
  mvc:
    throw-exception-if-no-handler-found: true
  resources:
    add-mappings: false

全部添加完毕，测试下

 

hao_hl1314
关注
  • 0
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot 项目中参数校验和异常拦截
2301_76607156的博客
03-27 442
比如前端提交的某个参数必须是枚举值中的一个，我们尝试用自定义注解来完成该校验逻辑。定义校验注解String message() default "必须指定颜色类型";// 所有允许的颜色值Class
在拦截器里放入参数 controller_SpringBoot 拦截器解析
weixin_39951419的博客
11-20 2530
SpringWeb框架中的拦截器作用类似于过滤器，都可以对一个请求进行拦截处理。我们可以用拦截器做很多事情：日志记录：记录请求信息的日志，以便进行信息监控、信息统计等；权限检查：如登录校验，在处理器处理之前先判断是否已经登录；性能监控：通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间。通用行为：读取 Cookie 得到用户信息并将用户对象放入请求，从而方便后...
SpringBoot 参数检查 Controller中检查参数是否合法
weixin_30457551的博客
09-11 362
springboot 验证 默认使用的是hibernate validator ，不用额外增加引用包，springboot已经内置包含。 设置pom相关依赖 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http...
SpringBoot参数校验
最新发布
刘浩琦的博客
05-01 889
是一个用于将请求参数映射到控制器处理方法的参数上的注解。当你需要处理请求中的集合（例如，多个相同名称的查询参数）时，可以在。，你可以告诉 Spring，即使请求中没有该参数，也不应该抛出异常。，Spring 将不知道如何处理同名的多个请求参数，或者如何将它们绑定到方法参数上。的异常处理器，也可以使用SpringBoot自带的异常处理机制。），Spring 会尝试将请求参数的值转换为该类型。：当一个请求参数在查询字符串中有多个值时（例如，的请求参数，并且期望它被绑定到一个。，并且你想要将这些值绑定到一个。
Springboot 使用HibernateValidator校验必填参数
weixin_44073321的博客
12-02 2128
前言： 在开发中经常需要写一些字段校验的代码，比如字段非空，字段长度限制，邮箱格式验证等等，写这些与业务逻辑关系不大的代码个人感觉有两个麻烦： 验证代码繁琐，重复劳动 方法内代码显得冗长 每次要看哪些参数验证是否完整，需要去翻阅验证逻辑代码 hibernate validator（官方文档）提供了一套比较完善、便捷的验证实现方式。 spring-boot-starter-web包里面有hibe...
SpringBoot中处理校验逻辑的两种方式
nic's blog
03-09 948
转自：SpringBoot中处理校验逻辑的两种方式，真的很机智！ 侵删 平时在开发接口的时候，常常会需要对参数进行校验，这里提供两种处理校验逻辑的方式。一种是使用Hibernate Validator来处理，另一种是使用全局异常来处理，下面我们讲下这两种方式的用法。 一、Hibernate Validator Hibernate Validator是SpringBoot内置的校验框架，只要集成了S...
springboot JSR303参数校验 全局异常处理
01-07
Springboot全局异常处理、JSR303参数校验，具体详见: https://blog.csdn.net/herojuice/article/details/85788681
详解SpringBoot中的参数校验(项目实战)
08-18
主要介绍了SpringBoot中的参数校验,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
SpringBoot全局异常与数据校验的方法
08-26
主要介绍了SpringBoot全局异常与数据校验的方法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
SpringBoot中的异常处理与参数校验的方法实现
08-19
主要介绍了SpringBoot中的异常处理与参数校验的方法实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
Java参数校验和全局异常处理
06-05
Java参数校验和全局异常处理 博客地址：https://blog.csdn.net/qq_38234785/article/details/125129050
Springboot controller argument type mismatch
qq_34412985的博客
10-23 2985
controller接口中写了HttpHeaders但缺@RequestHeader HttpHeaders httpHeaders
Springboot开发中遇到的问题01---java.lang.IllegalArgumentException: argument type mismatch
代码搬运工
04-16 3252
场景：springboot+mybatisplus   在数据同步时新增记录 报错：java.lang.IllegalArgumentException: argument type mismatch 大致看出是mybatis 映射字段的时候出错了 。第一反应就是检查字段类型，检查字段有没有写错，回头对比了实体字段还有sql实在没发现问题。找不到出路的时候，想到在ibatis的setBe...
路径变量@PathVariable，格式校验：@Validated（Controller上）+ @Pattern + ConstraintViolationException（异常处理）
宋冠巡的博客
12-21 1402
对API接口中的`路径参数`进行严格的合法性验证是一个重要的环节，以确保请求指向的资源正确无误。在 RESTful API 设计中，通常会通过URL路径中的特定字段来唯一标识资源，例如一个记录的ID。 主要的应用场景包括：当需要根据`id`值查询、删除或更新数据库中的一条记录时，必须对传入的`id`参数进行长度和格式的有效性校验。
正则表达式
wang_2011_ying的专栏
10-10 735
[正则表达式]文本框输入内容控制 2 整数或者小数：^[0-9]+\.{0,1}[0-9]{0,2}$ 3 只能输入数字："^[0-9]*$"。 4 只能输入n位的数字："^\d{n}$"。 5 只能输入至少n位的数字："^\d{n,}$"。 6 只能输入m~n位的数字：。"^\d{m,n}$" 7 只能输入零和非零开头的数字："^(0|[1-9][0-9]*)...
SpringBoot教程(五) | SpringBoot中Controller用法及传参
热门推荐
lsqingfeng的博客
01-19 2万+
SpringBoot整合SpringMvc其实千面一直讲的都是。只需要我们在pom文件中引入 web的starter就可以了，然后我们就可以正常使用springMvc中的功能了。所以本篇文章可能更多的是回顾，回顾一下springMVC中的一些常用的功能。重点讲讲Controller的传参
controller参数校验
zgsxhdzxl的博客
11-14 2054
使用javax.validation去校验参数，可以避免过多的if判断。 对需要校验的入参类添加注解 public class TestVO { /*** 用户ID*/ @NotNull(message = "用户id不能为空") private Long userId; /** 用户名*/ @NotBlank(message = "用户名不能...
spring的controller层参数合法性校验，多层实体类情况
goxingman的博客
10-31 1019
一、对于只有一层的实体类，直接使用@Validated注解就行。①controller层。
请不要再使用判断进行参数校验了
码农小胖哥
07-25 2212
1. 前言因为网络传输的不可靠性，以及前端数据控制的可篡改性，后端的参数校验是必须的，应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。2. 数据校验的痛点为了保证数据语...
springboot接口入参校验
06-03
在Spring Boot中，可以使用JSR-303 Bean验证框架来进行接口入参校验。步骤如下： 1. 在实体类中使用注解标注需要校验的属性，如@NotBlank、@NotNull等。 2. 在Controller中使用@Valid注解标注需要校验的实体类参数...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值