异常体系与项目实践

饭宝  金牌会员 | 2023-5-19 07:54:13 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题

主题 941|帖子 941|积分 2823

程序式阴影:为什么不报错?
一、简介

在程序开发的过程中,异常处理从来都是一个复杂的维度,无论是新手还是经验老到的选手,在编码时都会面对各种异常情况;
程序中的异常可以反映系统的缺陷和待优化的点,并且是无法完全避免的,如何处理异常和降低异常出现的频率,是系统质量的基础保障;
随着分布式架构的流行,各种复杂的请求链路给异常处理带来了巨大的麻烦,需要全面的监控来定位原因,才能快速的优化和解决;
二、异常体系

不论是JDK基础,还是各类组件,在源码中都涉及大量的异常封装,从而精确的反映出描述信息,先来看看Java中的异常体系基础;

Throwable:是所有错误「Error」和异常「Exception」的超类,
Error:通常是底层的不可恢复的类,此类错误一般都比较严重,JVM将终止其运行的线程;
Exception:程序自身可以捕获并且可以预处理的异常,例如捕获处理或者抛出;
针对「编译器」来说,异常又分为「检查」异常和「非检查」异常;

检查异常:即编译时异常,在编译时期就会被编译器查验到的异常,这类异常要么捕获处理要么抛出,否则就会报编译错误;
非检查异常:即运行时异常,在编译时期不会被编译器查验到的异常,这类异常只有在程序运行的时候,才会有可能被抛出;
三、异常用法

1、使用细节

Java异常处理关键字,分别是:「try」可能抛异常的代码块,「catch」捕获异常、「finally」必须执行的代码块、「throw」方法内抛指定异常、「throws」方法声明抛多个异常;
  1. public class UseExe01 {
  2.     public static void main(String[] args) {
  3.         try {
  4.             strStm ();
  5.             ioStm();
  6.         } catch (NullPointerException e) {
  7.             System.out.println("空指针异常:"+e.getMessage());
  8.             e.printStackTrace();
  9.         } catch (IOException e) {
  10.             System.out.println("IO流异常:"+e.getMessage());
  11.             e.printStackTrace();
  12.         } catch (Exception e) {
  13.             System.out.println("异常:"+e.getMessage());
  14.             e.printStackTrace();
  15.         } finally {
  16.             System.out.println("execute...finally");
  17.         }
  18.     }
  19.     public static void ioStm () throws FileNotFoundException {
  20.         new FileInputStream(new File("file_path"));
  21.     }
  22.     public static String strStm () throws NullPointerException {
  23.         Object object = new Object() ;
  24.         return object.getClass().getName() ;
  25.     }
  26. }
复制代码
案例分析

细节分析

  • 如果「try」代码块中没有抛出异常,执行完会跳到「finally」代码块;
  • 如果「try」代码块中抛出异常,则执行「catch」代码块,无论是否捕获异常,最终都要执行「finally」代码块;
  • 可以存在多个「catch」代码块,但是最多只匹配一个异常;
  • 捕获异常与抛出异常的类型可以匹配,或者捕获异常的类型是抛出异常的父类;
  • 在异常捕获时,同一个继承体系内,先捕获子类异常,再捕获父类异常;
2、返回值问题

在异常处理逻辑中,有一个非常经典的问题,就是「return」返回值,如果在「try.catch.finally」代码块中都存在「return」关键字,则要分情况讨论;
2.1 值类型
  1. public class UseExe02 {
  2.     // 返回【2】
  3.     public static int getInt1 () {
  4.         try {
  5.             int i = 1 / 0;
  6.         } catch (ArithmeticException e){
  7.             e.printStackTrace();
  8.             return 1;
  9.         } finally {
  10.             System.out.println("execute...finally");
  11.             return 2;
  12.         }
  13.     }
  14.     // 返回【1】
  15.     public static int getInt2 () {
  16.         int a = 1;
  17.         try{
  18.             int i = 1/0;
  19.             return a;
  20.         }catch (ArithmeticException e){
  21.             e.printStackTrace();
  22.             return a;
  23.         }finally {
  24.             ++a;
  25.             System.out.println("execute...finally");
  26.         }
  27.     }
  28.     // 返回【3】
  29.     public static int getInt3 () {
  30.         int a = 1;
  31.         try{
  32.             int i = 1/0;
  33.             a++;
  34.             return a ;
  35.         }catch (ArithmeticException e){
  36.             a++;
  37.             e.printStackTrace();
  38.         }finally {
  39.             a++;
  40.             System.out.println("execute...finally");
  41.         }
  42.         return a ;
  43.     }
  44. }
复制代码
逻辑分析

2.2 引用类型
  1. public class UseExe03 {
  2.     // 返回【张三】
  3.     public static String getStr1 () {
  4.         String var ;
  5.         try {
  6.             var = new String("张三");
  7.             return var ;
  8.         } catch (ArithmeticException e){
  9.             e.printStackTrace();
  10.         } finally {
  11.             var = new String("李四");
  12.             System.out.println("execute...finally:"+var);
  13.         }
  14.         return var ;
  15.     }
  16.     // 返回【李四】
  17.     public static String getStr2 () {
  18.         String var ;
  19.         try{
  20.             int i = 1/0;
  21.             var = new String("张三");
  22.             return var;
  23.         }catch (ArithmeticException e){
  24.             e.printStackTrace();
  25.             var = new String("李四");
  26.             return var;
  27.         }finally {
  28.             var = new String("王五");
  29.             System.out.println("execute...finally:"+var);
  30.         }
  31.     }
  32.     // 返回【王五】
  33.     public static String getStr3 () {
  34.         String var ;
  35.         try{
  36.             int i = 1/0;
  37.             var = new String("张三");
  38.             return var ;
  39.         }catch (ArithmeticException e){
  40.             var = new String("李四");
  41.             e.printStackTrace();
  42.         }finally {
  43.             var = new String("王五");
  44.             System.out.println("execute...finally:"+var);
  45.         }
  46.         return var ;
  47.     }
  48. }
复制代码
逻辑分析

2.3 结论说明


  • 如果只有「try」代码块中有「return」关键字,逻辑执行正常则得到「try」处的返回值;
  • 如果只有「try.catch」代码块中有「return」关键字,「try」代码块异常,「catch」代码块执行正常,则得到「catch」处的返回值;
  • 如果「finally」代码块中有「return」关键字,当该代码块执行正常时会得到此处的返回值;
值得说明的一点是,从异常的设计原理来来说,并不推荐在「finally」代码块中使用「return」关键字,可能会导致程序提前结束,这也是常见的开发规范;
四、项目实践

1、异常定义

对于复杂的分布式工程来说,系统发生问题时,十分依赖异常信息的捕获,从而快速定位原因和解决;
项目在处理异常时,需要考虑两个核心维度:「1」捕获和解决异常信息,「2」传递异常信息到应用端,从而引导用户的动作;
在系统中,通常依赖很多自定义的异常,比如常见:系统异常,业务异常,第三方异常;基本都是「运行时」异常;

系统异常:比如超时请求或者服务级别异常,导致流程无法执行,需要研发人员介入处理;
业务异常:基于响应的提示信息,用户可以自行解决的问题,比如常见的参数校验,授权问题等;
第三方异常:可以是内部不同系统的交互,也可以是第三方的交互,可能会涉及到各种响应状态,通过内部的封装进行统一管理,并且要保留第三方的响应;
2、异常封装

基于运行时异常「RuntimeException」类,分别定义「系统」、「业务」、「第三方」三类异常;

自定义异常基础类,注意此处省略很多构造方法,作为「RuntimeException」的子类,具体参考其源码的构造方法即可;
  1. public class BaseExe extends RuntimeException {
  2.     private String code ;
  3.     public BaseExe (String code,String msg) {
  4.         super(msg);
  5.         this.code = code ;
  6.     }
  7.     public BaseExe(String message, Throwable cause) {
  8.         super(message, cause);
  9.     }
  10.     // 省略其他构造方法
  11. }
复制代码
系统异常类,并提供常用的系统异常信息枚举类;
  1. public enum SysExeCode {
  2.     SYSTEM_EXE("S00000", "系统异常");
  3. }
  4. public class SysException extends BaseExe {
  5.     public SysException(String code, String msg) {
  6.         super(code, msg);
  7.     }
  8.     public SysException(SysExeCode sysExeCode) {
  9.         super(sysExeCode.getCode(), sysExeCode.getMsg());
  10.     }
  11. }
复制代码
业务异常类,并提供常用的业务异常信息枚举类;
  1. public enum BizExeCode {
  2.     BIZ_EXE("B00000", "业务异常");
  3. }
  4. public class BizException extends BaseExe {
  5.     public BizException(String code, String msg) {
  6.         super(code, msg);
  7.     }
  8.     public BizException(BizExeCode bizExeCode) {
  9.         super(bizExeCode.getCode(), bizExeCode.getMsg());
  10.     }
  11. }
复制代码
第三方异常类,并提供常用的第三方异常信息枚举类;
  1. public enum ThirdExeCode {
  2.     THIRD_EXE("T00000", "第三方异常");
  3. }
  4. public class ThirdException extends BaseExe {
  5.     // 第三方交互异常响应信息
  6.     private String thirdCode ;
  7.     private String thirdMsg ;
  8.     public ThirdException(String code, String msg) {
  9.         super(code, msg);
  10.     }
  11.     public ThirdException(String code, String msg,String thirdCode,String thirdMsg) {
  12.         super(code, msg);
  13.         this.thirdCode = thirdCode ;
  14.         this.thirdMsg = thirdMsg ;
  15.     }
  16.     public ThirdException(ThirdExeCode thirdExeCode,String thirdCode,String thirdMsg) {
  17.         super(thirdExeCode.getCode(), thirdExeCode.getMsg());
  18.         this.thirdCode = thirdCode ;
  19.         this.thirdMsg = thirdMsg ;
  20.     }
  21. }
复制代码
从开发规范来说,不允许在代码中随意添加异常描述信息,必须都维护在相应的枚举类中,不同的异常类型,要在合适的场景下抛出,尽量由最上层统一捕获并处理,再转换为统一的响应结果;
3、异常处理

3.1 响应方式

在微服务项目中,通常采用RestControllerAdvice和ExceptionHandler注解,实现全局异常的捕获和处理;
  1. @RestControllerAdvice
  2. public class ExeHandler {
  3.     /**
  4.      * 默认异常
  5.      */
  6.     @ExceptionHandler(value = Exception.class)
  7.     public void defaultException(Exception e) {
  8.         // 统一返回
  9.     }
  10.     /**
  11.      * 系统异常
  12.      */
  13.     @ExceptionHandler(value = SysException.class)
  14.     public void sysException(SysException e) {
  15.         // 统一返回
  16.     }
  17.     /**
  18.      * 业务异常
  19.      */
  20.     @ExceptionHandler(value = BizException.class)
  21.     public void bizException(BizException e) {
  22.         // 统一返回
  23.     }
  24.     /**
  25.      * 第三方异常
  26.      */
  27.     @ExceptionHandler(value = ThirdException.class)
  28.     public void thirdException(ThirdException e) {
  29.         // 统一返回
  30.     }
  31. }
复制代码
3.2 记录方式

通常在一些核心的业务流程中,会通过注解的方式记录日志,于研发而言,最关心的还是异常日志,以此为逻辑优化的关键依据;
比较常用的技术手段是自定义注解+切面编程来实现,细节参考开源仓库中《集成日志,复杂业务下的自定义实现》篇幅内容;
  1. @Component
  2. @Aspect
  3. public class LogAop {
  4.     /**
  5.      * 日志切入点
  6.      */
  7.     @Pointcut("@annotation(com.defined.log.annotation.DefinedLog)")
  8.     public void logPointCut() {
  9.     }
  10.     /**
  11.      * 环绕切入
  12.      */
  13.     @Around("logPointCut()")
  14.     public Object around (ProceedingJoinPoint proceedingJoinPoint) {
  15.         try{
  16.             // 执行方法
  17.             result = proceedingJoinPoint.proceed();
  18.         } catch (SysException e){
  19.             // 系统异常
  20.         } catch (BizException e){
  21.             // 业务异常
  22.         } catch (ThirdException e){
  23.             // 第三方异常
  24.         } catch (Exception e){
  25.             // 默认异常
  26.         } finally {
  27.             // 信息处理
  28.         }
  29.         return result ;
  30.     }
  31. }
复制代码
4、异常通知

抛开业务异常不说,对于「系统」和「第三方」异常,通常都会第一时间触达到研发,从而快速定位原因和处理;
一般会根据异常的级别,将进行不同维度的消息触达,比如某微,某钉,邮件,短信等;

从技术的实现上来看,常规也是采用切面编程的方式,细节参考开源仓库中《基于AOP切面,实现系统告警功能》篇幅内容;关于消息中心的搭建设计,同样可以参考开源仓库中《聊聊消息中心的设计与实现逻辑》篇幅内容;
5、系统故障

从系统架构的层面来分析,大部分组件都提供了必要的监控能力,而这种监控手段的核心价值在于快速发现故障,并且提供一定的分析能力;
比如分布式系统中,复杂的请求的链路,对于故障的定位和排查难度都是极大的,需要将各种组件的监控信息进行统筹分析;
系统层面监控

请求链路分析

日志记录能力

可以从关键的日志记录作为问题切入点,再基于系统层面的监控能力缩小问题范围,分析请求链路的异常原因,最后通过完整的日志分析细节,从而提升问题解决的效率;
关于这些技术的应用,在开源仓库中都有详细案例,此处不再赘述;
五、参考源码
  1. 编程文档:
  2. https://gitee.com/cicadasmile/butte-java-note
  3. 应用仓库:
  4. https://gitee.com/cicadasmile/butte-flyer-parent
复制代码
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有账号?立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览

快速回复

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

本版积分规则

饭宝

金牌会员
这个人很懒什么都没写!

标签云

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