ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

统一异常处理

2022-09-03 12:31:53  阅读:152  来源: 互联网

标签:exception return 处理 ExceptionHandler 异常 public BizException 统一


代码托管地址:https://gitee.com/ZomiCC/code/tree/master/exception

此文应用到了[统一校验]部分功能,没有看多可先参考上文:统一校验

统一处理,我们很容易会想到spring中的AOP。没错,本篇文章核心就是使用spring为我们提供的两个注解@RestControllerAdvice + @ExceptionHandler 来实现异常的统一处理。
我们的任务主要分以下几步:

  1. 自定义统一异常类BizException,规范异常类型,便于ExceptionHandler使用
  2. 对controller切面,实现对BindingResult(即调用者请求参数)的统一异常/校验处理,我们称这一步为前置异常捕获
  3. 对service切面,捕获所有的service异常,统一封装为BizException,再返回给controller,方便RestControllerAdvice+ExceptionHandler处理异常类型。我们称这一步为业务异常捕获
  4. 全局异常处理器中,也就是RestControllerAdvice+ExceptionHandler的处理方法中,封装响应结果返回给调用者。

关键代码

依赖包
       <!-- valid校验 -->
        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>
        <!-- 想要BindResult生效,这个依赖一定要有 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <!-- aop -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <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>
统一异常定义
package com.example.exception.exception;

public class BizException extends RuntimeException{
    private String code;
    private String msg;

    public BizException(String code, String msg){
        this.code = code;
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

前置异常捕获
/**
 * 前置异常切面
 */
@Slf4j
@Aspect
@Component
public class ControllerAspect {

    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)" +
            "&&args(..,org.springframework.validation.BindingResult)")
    public void controllerAspect() {
    }

    @Around("controllerAspect()")
    public Object doBefore(ProceedingJoinPoint joinPoint) throws Throwable{
        Object[] args = joinPoint.getArgs();
        for (Object arg : args) {
            if (arg instanceof BindingResult) {
                BindingResult result = (BindingResult) arg;
                if (result.hasErrors()) {
                    log.error("请求参数校验错误");
                    FieldError fieldError = result.getFieldError();
                    if (fieldError != null) {
                        //return ResponseUtil.fail(new BizException("111111", fieldError.getDefaultMessage()));
                        throw new BizException("111111", fieldError.getDefaultMessage());
                    }
                    //return ResponseUtil.fail(new BizException("999999", "未知参数错误"));
                    throw new BizException("222222", "未知参数错误┭┮﹏┭┮");
                }
            }
        }
        return joinPoint.proceed();
    }
}
业务异常捕获
/**
 * Service异常捕获,将Service中的所有异常,转换为统一的BizException,方便ExceptionHandler统一处理
 */
@Aspect
public class ServiceAspect {
    @Pointcut("execution(public * com.example.exception.service.*.*(..))")
    public void serviceAspect() {
    }

    @Around("serviceAspect()")
    public Object doAround(ProceedingJoinPoint joinPoint) throws Throwable {
        try {
            return joinPoint.proceed();
        } catch (Exception e) {
            if (e instanceof BizException) {
                throw e;
            } else {
                throw new BizException("999999", "系统错误^_^");
            }
        }
    }
}
全局异常处理器
package com.example.exception.handler;

import com.example.exception.dto.ResponseEntity;
import com.example.exception.exception.BizException;
import com.example.exception.util.ResponseUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

@RestControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
    /**
     * 业务异常处理
     */
    @ExceptionHandler(BizException.class)
    public ResponseEntity bizExceptionHandler(BizException e) {
        return ResponseUtil.fail(e);
    }

    /**
     * 通用异常处理
     */
    @ExceptionHandler(Exception.class)
    public ResponseEntity exceptionHandler(Exception e) {
        log.error(e.getMessage(), e);
        return ResponseUtil.fail("999999", "系统错误(#^.^#)");
    }
}

流程图参考

标签:exception,return,处理,ExceptionHandler,异常,public,BizException,统一
来源: https://www.cnblogs.com/zomicc/p/16652254.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有