Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 13682|回复: 0

springboot+aop+自定义注解,打造通用的全局异常处理和参数校验切面(通用版)

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-4-11 13:30:12 | 显示全部楼层 |阅读模式

    一.引入相应的maven依赖

    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
    </dependency>
    <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    </dependency>

     


    二.自定义参数校验注解

    /**
    * @Author: guandezhi
    * @Date: 2019/3/11 13:07
    */
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface ParamValidate {
    String value() default "";
    }
    

      


    三.自定义异常切面

    package com.gdz.paramvalidate.aspect;
    
    import com.gdz.paramvalidate.annotation.ParamValidate;
    import lombok.extern.slf4j.Slf4j;
    import org.aspectj.lang.JoinPoint;
    import org.aspectj.lang.annotation.Aspect;
    import org.aspectj.lang.annotation.Before;
    import org.aspectj.lang.reflect.MethodSignature;
    import org.springframework.stereotype.Component;
    import org.springframework.validation.BindingResult;
    import org.springframework.validation.FieldError;
    import org.springframework.validation.ObjectError;
    
    import java.lang.reflect.Method;
    import java.util.List;
    
    /**
    * 异常处理切面
    * @Author: guandezhi
    * @Date: 2019/3/11 13:03
    */
    @Slf4j
    @Aspect
    @Component
    public class ExceptionAspect {
    
    @Before("@annotation(com.gdz.paramvalidate.annotation.ParamValidate)")
    public void before(JoinPoint jp) throws Exception {
    doBefore(jp);
    }
    
    private void doBefore(JoinPoint jp) throws Exception {
    if (getParamValidate(jp) == null) {return;}
    Object[] args = jp.getArgs();
    if (args == null) {return;}
    //将异常格式化成通用格式
    formateException(args); 
    }
    
    private ParamValidate getParamValidate(JoinPoint jp) {
    MethodSignature methodSignature = (MethodSignature) jp.getSignature();
    Method method = methodSignature.getMethod();
    return method.getAnnotation(ParamValidate.class);
    }
    
    private void formateException(Object[] args) throws Exception {
    for (Object arg : args) {
    if (arg instanceof BindingResult) {
    BindingResult result = (BindingResult) arg;
    if (result != null && result.getErrorCount() > 0) {
    List<ObjectError> errors = result.getAllErrors();
    String errorMsg = "";
    for (ObjectError error : errors) {
    if (error instanceof FieldError) {
    FieldError fe = (FieldError) error;
    errorMsg = String.format("%s:%s", fe.getField(), error.getDefaultMessage());
    } else {
    errorMsg = String.format("%s:%s ", error.getCode(), error.getDefaultMessage());
    }
    log.error(errorMsg);
    throw new Exception(errorMsg);
    }
    }
    }
    }
    }
    
    }
    

      


    四.自定义全局异常处理器

    package com.gdz.paramvalidate.exception;
    
    import com.gdz.paramvalidate.bean.ResultVo;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.http.converter.HttpMessageNotReadableException;
    import org.springframework.web.bind.annotation.ControllerAdvice;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.ResponseBody;
    
    /**
    * 全局异常处理
    *
    * @Author: guandezhi
    * @Date: 2019/3/11 14:43
    */
    @Slf4j
    @ControllerAdvice
    public class GlobalExceptionHandler {
    
    
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ResultVo<Object> handleException(Exception e) {
    String errorMsg = "";
    if (e instanceof NullPointerException) {
    errorMsg = "参数空指针异常";
    } else if (e instanceof HttpMessageNotReadableException) {
    errorMsg = "请求参数匹配错误," + e.getLocalizedMessage();
    } else {
    errorMsg = e.getMessage();
    }
    log.error(String.format("请求异常[%s]", e));
    
    ResultVo<Object> resultVo = new ResultVo<>();
    resultVo.setResultCode("501");
    resultVo.setResultMsg(errorMsg);
    return resultVo;
    }
    }
    其中的resultVo如下:
    
    /**
    * @Author: guandezhi
    * @Date: 2019/3/11 12:14
    */
    @Data
    public class ResultVo<T> {
    
    private String resultCode;
    
    private String resultMsg;
    
    private T data;
    
    }
    

      

    五.在需要校验入参的controller方法上加上自定义注(@ParamValidate)

    /**
    * @Author: guandezhi
    * @Date: 2019/3/11 12:15
    */
    @Slf4j
    @RequestMapping("/user")
    @RestController
    public class UserController {
    
    @ParamValidate
    @RequestMapping("/addUser")
    public String addUser(@RequestBody @Valid User user, BindingResult result) throws Exception {
    int i = 1 / 0;
    return "success";
    }
    }
    

      


    这里必须加上@ParamValidate  @Valid这两个注解才能生效

    其中User类如下:

    /**
    * @Author: guandezhi
    * @Date: 2019/3/11 12:19
    */
    @Data
    public class User {
    
    @NotNull(message = "用户名不能为空")
    private String name;
    
    @NotNull(message = "手机号不能为空")
    private String mobile;
    }
    

      


    六.测试一下

    1.当入参为空值时

     

     

     
    1.当程序有异常时

     

     

    代码地址:https://github.com/dezhiguan/GlobalExceptionHandler
    ---------------------
    作者: guandezhi
    来源:CSDN
    原文:https://blog.csdn.net/qq_35859844/article/details/88394376
    版权声明:本文为博主原创文章,转载请附上博文链接!

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2024-12-22 23:58 , Processed in 0.061632 second(s), 30 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表