首页 > 其他分享 >SpringBoot统一异常处理

SpringBoot统一异常处理

时间:2024-08-15 19:49:23浏览次数:15  
标签:return SpringBoot MsgData String msg 异常 public 统一

简介

Spring Boot项目中实现统一的异常处理是一种常见的做法,这有助于保持代码的整洁并提供一致的错误响应格式。Spring Boot 中的统一异常处理是一种机制,用于集中管理和格式化应用程序中抛出的所有异常。这种机制可以提高程序的健壮性和用户体验,同时简化开发过程。

统一异常处理的一些主要作用:

  1. 一致性:
    保证了在不同地方发生的异常都能以相同的方式被处理和响应。
    用户或客户端接收到的错误信息和格式保持一致,有助于问题定位。
  2. 错误信息定制:
    可以根据需要定制错误信息,包括HTTP状态码、错误代码和描述等。
    这样可以更好地向用户解释发生了什么问题,并提供可能的解决方法。
  3. 日志记录:
    在捕获异常后,可以根据异常类型和级别记录到日志文件中,便于后续分析和调试。
    日志记录可以帮助追踪问题发生的时间点、环境和上下文。
  4. 资源释放:
    在某些情况下,可以在异常处理过程中释放资源或者进行清理工作,确保系统稳定运行。
  5. API 文档化:
    对于对外提供的 API,可以通过异常处理来定义预期的错误情况,这有助于生成清晰的 API 文档。
  6. 安全性:
    可以避免敏感信息泄露给客户端,例如数据库查询语句、内部类名等。
    可以返回更泛化的错误信息,而不是具体的异常堆栈跟踪。
  7. 性能优化:
    通过合理设计异常处理逻辑,可以减少不必要的资源消耗和调用链路,从而提升整体性能。

实现

1.创建自定义异常类

根据项目场景创建一些自定义异常类 extends RuntimeException

  • WarnException 警告类异常
@Data
public class WarnException extends RuntimeException{

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

返回告警信息,
日志记录WARN级别日志,且不打印堆栈
异常概要信息不会落库

  • UserException 用户业务类异常
@Data
public class UserException extends RuntimeException {

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

    @Override
    public String toString() {
        return getClass().getName() + StringConstant.COLON +this.getMessage();
    }
}

返回告警信息,
日志记录ERROR级别日志,且打印堆栈
异常概要信息落库

StringConstant.COLON = ":"

  • PlatformException 系统内部异常
@Data
public class PlatformException extends RuntimeException {

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

    @Override
    public String toString() {
        return getClass().getName() + StringConstant.COLON +this.getMessage();
    }

}

返回告警信息,
日志记录ERROR级别日志,且打印堆栈
异常概要信息落库

StringConstant.COLON = ":"

2.创建全局异常处理器

定义一个带有 @ControllerAdvice 注解的类,并在其中声明一个或多个带有 @ExceptionHandler 注解的方法来处理特定类型的异常

  • ZKExceptionHandler统一异常处理类
@ControllerAdvice
@Slf4j
public class ZKExceptionHandler {

    @Autowired
    private AlarmMsgService alarmMsgService;

    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public <T> MsgData<T> handleException(Exception e) {
        //预期内告警类异常不计入数据库;日志不记录堆栈
        if (e instanceof WarnException) {
            WarnException warnException = (WarnException) e;
            log.warn(warnException.getMessage());
            return MsgData.fill(warnException.getMessage());
        }
        String msg = e.getMessage();
        String exceptionName = e.getClass().getName();
        String stackTrace = ExceptionUtils.getStackTrace(e);
        //用户异常
        if (e instanceof UserException) {
            alarmMsgService.saveUserAlarmMsg(msg, AlarmLevelEnum.ALARM, exceptionName, stackTrace);
            log.error("UserException", e);
            return MsgData.fill(msg);
        }
        //平台类异常
        if (e instanceof PlatformException) {
            alarmMsgService.savePlatformAlarmMsg(msg, AlarmLevelEnum.ALARM, exceptionName, stackTrace);
            log.error("PlatformException", e);
            return MsgData.fill(msg);
        }
        //其他异常
        alarmMsgService.saveOtherAlarmMsg("系统异常", AlarmLevelEnum.ALARM, exceptionName, stackTrace);
        log.error("OtherException", e);
        return MsgData.fill(msg);
    }
}

alarmMsgService为异常概要信息入库操作,可自定义替换为自己的数据库操作
这里会对三种自定义异常分别进行处理,用于达到信息返回及记录预期
对于其他异常也会进行兜底记录及处理

  • MsgData 返回实体类
@Data
public class MsgData<T> {
    private int status;
    private String errorCode;
    private String msg;
    private T data;

    public static <T> MsgData<T> success() {
        return success(null);
    }

    public static <T> MsgData<T> success(T data) {
        return success(null, data);
    }

    public static <T> MsgData<T> success(String msg) {
        return success(msg, null);
    }

    public static <T> MsgData<T> success(String msg, T data) {
        return success(HttpCodeConstant.SUCCESS, msg, data);
    }

    public static <T> MsgData<T> success(int status, String msg, T data) {
        MsgData<T> msgData = new MsgData<>();
        msgData.setStatus(status);
        msgData.setMsg(msg);
        msgData.setData(data);
        return msgData;
    }

    public static <T> MsgData<T> fill(String msg) {
        return fill(null, msg);
    }

    public static <T> MsgData<T> fill(String errorCode, String msg) {
        return fill(HttpCodeConstant.ERROR, errorCode, msg, null);
    }

    public static <T> MsgData<T> fill(int status, String errorCode, String msg, T data) {
        MsgData<T> msgData = new MsgData<>();
        msgData.setStatus(status);
        msgData.setErrorCode(errorCode);
        msgData.setMsg(msg);
        msgData.setData(data);
        return msgData;
    }

}

HttpCodeConstant.SUCCESS = 200
HttpCodeConstant.ERROR = 500

使用

通过throw 不同的Exception进行区分不同的异常

// 警告类异常
throw new WarnException("测试WARN告警");
// 用户业务类异常
throw new UserException("测试用户告警");
// 平台系统类异常
throw new PlatformException("测试平台告警");
// 其他异常
throw new RuntimeException("测试系统告警");

结束

标签:return,SpringBoot,MsgData,String,msg,异常,public,统一
From: https://www.cnblogs.com/zktww/p/18361699

相关文章

  • 【Springboot系统开发】——网上商城购物系统(文末附源码)源码+万字文档+配套PPT
    ......
  • 003springboot图书个性化推荐系统的设计与实现———源码+数据库文件+万字文档+配套PP
     博主介绍:java高级开发,从事互联网行业六年,熟悉各种主流语言,精通java、python、php、爬虫、web开发,已经做了六年的毕业设计程序开发,开发过上千套毕业设计程序,没有什么华丽的语言,只有实实在在的写点程序。......
  • 实现同时接收文件与实体类,java springboot maven
    首先,需要有一个Post接口,有一个实体类方法需要返回什么,直接修改void即可实体类需要接收什么,直接改User即可 @PostMapping(value="/post_interface")publicvoidpostInterface(@RequestParam("file")MultipartFilefile,@RequestParamMap<String,Object>user){......
  • SpringBoot修改内置tomcat版本的操作步骤
    一:由于Tomcat高危漏洞影响,本文介绍了如何查询和修改Springboot内嵌的Tomcat版本,包括通过POM文件或mvnrepository查询版本,以及通过添加properties配置更改版本。此外,还提到了遇到缺少tomcat-juli依赖时的解决办法。最近Tomcat爆出高危漏洞,基本影响所有的Tomcat版本,故需要对sprin......
  • SpringBoot优雅的封装不同研发环境下(环境隔离)RocketMq自动ack和手动ack
    1.RocketMq的maven依赖版本:<dependency><groupId>org.apache.rocketmq</groupId><artifactId>rocketmq-spring-boot-starter</artifactId><version>2.3.0</version></dependenc......
  • Python教程:异常捕捉与代码重构
    异常pYthon使用被称为异常的特殊对象来管理程序执行期间发生的错误。每当发生让python不知所错的错误时,他都会创建一个异常对象。当你编写了处理改异常的代码,该程序将继续运行;如果你未对异常进行处理,程序停止,并显示一个traceback,其中包含有关异常的报告。异常是使用try-except代......
  • Java面试题学习(Spring & SpringBoot)
    1.Java基础2.Spring&SpringBoot(正在浏览)目录一、Spring1.谈谈你对Spring的理解?/什么是Spring?2.Spring有什么特点?3.Spring框架中都用到了哪些设计模式?二、SpringIOC4.什么是SpringIOC?什么是SpringIOC容器?有什么作用?5.SpringIOC的实现机制是什么?6.什么是S......
  • Java IO、异常处理
    JavaIOJava.io包几乎包含了所有操作输入、输出需要的类。所有这些流类代表了输入源和输出目标。Java.io包中的流支持很多种格式,比如:基本类型、对象、本地化字符集等等。一个流可以理解为一个数据的序列。输入流表示从一个源读取数据,输出流表示向一个目标写数据。一、读取控......
  • 基于Java Springboot音乐播放器系统
    一、作品包含源码+数据库+设计文档万字+PPT+全套环境和工具资源+部署教程二、项目技术前端技术:Html、Css、Js、Vue、Element-ui数据库:MySQL后端技术:Java、SpringBoot、MyBatis三、运行环境开发工具:IDEA/eclipse数据库:MySQL5.7数据库管理工具:Navicat10以上版本环境......
  • 基于Java Springboot北京医疗企业固定资产管理系统
    一、作品包含源码+数据库+设计文档万字+PPT+全套环境和工具资源+部署教程二、项目技术前端技术:Html、Css、Js、Vue、Element-ui数据库:MySQL后端技术:Java、SpringBoot、MyBatis三、运行环境开发工具:IDEA/eclipse数据库:MySQL5.7数据库管理工具:Navicat10以上版本环境......