Java处理Exception被很多团队使用的异常处理最佳实践

小郝不负流年
小郝不负流年   + 关注
2021-02-23 21:45:05   阅读513   评论0

在Java中处理异常并不是一个简单的事情。不仅仅初学者很难理解,即使一些有经验的开发者也需要花费很多时间来思考如何处理异常,包括需要处理哪些异常,怎样处理等等。

这也是绝大多数开发团队都会制定一些规则来规范对异常的处理的原因。而团队之间的这些规范往往是截然不同的。

本文给出几个被很多团队使用的异常处理最佳实践。

在Finally块中清理资源或者使用try-with-resource语句

当使用类似InputStream这种需要使用后关闭的资源时,一个常见的错误就是在try块的最后关闭资源。


  1. public void doNotCloseResourceInTry() {  
  2.     FileInputStream inputStream = null;  
  3. try {  
  4.         File file = new File("./tmp.txt");  
  5.         inputStream = new FileInputStream(file);  
  6. // use the inputStream to read a file  
  7. // do NOT do this  
  8.         inputStream.close();  
  9.     } catch (FileNotFoundException e) {  
  10. log.error(e);  
  11.     } catch (IOException e) {  
  12. log.error(e);  
  13.     }  
  14. }  

上述代码在没有任何exception的时候运行是没有问题的。但是当try块中的语句抛出异常或者自己实现的代码抛出异常,那么就不会执行最后的关闭语句,从而资源也无法释放。

合理的做法则是将所有清理的代码都放到finally块中或者使用try-with-resource语句。


  1. public void closeResourceInFinally() {  
  2.     FileInputStream inputStream = null;  
  3. try {  
  4.         File file = new File("./tmp.txt");  
  5.         inputStream = new FileInputStream(file);  
  6. // use the inputStream to read a file  
  7.     } catch (FileNotFoundException e) {  
  8. log.error(e);  
  9.     } finally {  
  10. if (inputStream != null) {  
  11. try {  
  12.                 inputStream.close();  
  13.             } catch (IOException e) {  
  14. log.error(e);  
  15.             }  
  16.         }  
  17.     }  
  18. }  
  19.   
  20. public void automaticallyCloseResource() {  
  21.     File file = new File("./tmp.txt");  
  22. try (FileInputStream inputStream = new FileInputStream(file);) {  
  23. // use the inputStream to read a file  
  24.     } catch (FileNotFoundException e) {  
  25. log.error(e);  
  26.     } catch (IOException e) {  
  27. log.error(e);  
  28.     }  
  29. }  

指定具体的异常

尽可能的使用最具体的异常来声明方法,这样才能使得代码更容易理解。


  1. public void doNotDoThis() throws Exception {  
  2.   
  3.     ...  
  4.   
  5. }  
  6.   
  7. public void doThis() throws NumberFormatException {  
  8.   
  9.     ...  
  10.   
  11. }  

如上,NumberFormatException字面上即可以看出是数字格式化错误。

对异常进行文档说明

当在方法上声明抛出异常时,也需要进行文档说明。和前面的一点一样,都是为了给调用者提供尽可能多的信息,从而可以更好地避免/处理异常。

在Javadoc中加入throws声明,并且描述抛出异常的场景。


  1. /** 
  2.  
  3.  * This method does something extremely useful ... 
  4.  
  5.  * 
  6.  
  7.  * @param input 
  8.  
  9.  * @throws MyBusinessException if ... happens 
  10.  
  11.  */  
  12.   
  13. public void doSomething(String input) throws MyBusinessException {  
  14.   
  15.     ...  
  16.   
  17. }  

抛出异常的时候包含描述信息

在抛出异常时,需要尽可能精确地描述问题和相关信息,这样无论是打印到日志中还是监控工具中,都能够更容易被人阅读,从而可以更好地定位具体错误信息、错误的严重程度等。

但这里并不是说要对错误信息长篇大论,因为本来Exception的类名就能够反映错误的原因,因此只需要用一到两句话描述即可。


  1. try {  
  2.   
  3. new Long("xyz");  
  4.   
  5. } catch (NumberFormatException e) {  
  6.   
  7. log.error(e);  
  8.   
  9. }  

NumberFormatException即告诉了这个异常是格式化错误,异常的额外信息只需要提供这个错误字符串即可。当异常的名称不够明显的时候,则需要提供尽可能具体的错误信息。

首先捕获最具体的异常

现在很多IDE都能智能提示这个最佳实践,当你试图首先捕获最笼统的异常时,会提示不能达到的代码。当有多个catch块中,按照捕获顺序只有第一个匹配到的catch块才能执行。因此,如果先捕获IllegalArgumentException,那么则无法运行到对NumberFormatException的捕获。


  1. public void catchMostSpecificExceptionFirst() {  
  2.   
  3. try {  
  4.   
  5.         doSomething("A message");  
  6.   
  7.     } catch (NumberFormatException e) {  
  8.   
  9. log.error(e);  
  10.   
  11.     } catch (IllegalArgumentException e) {  
  12.   
  13. log.error(e)  
  14.   
  15.     }  
  16.   
  17. }  

 不要捕获Throwable

Throwable是所有异常和错误的父类。你可以在catch语句中捕获,但是永远不要这么做。如果catch了throwable,那么不仅仅会捕获所有exception,还会捕获error。而error是表明无法恢复的jvm错误。因此除非绝对肯定能够处理或者被要求处理error,不要捕获throwable。


  1. public void doNotCatchThrowable() {  
  2.   
  3. try {  
  4.   
  5. // do something  
  6.   
  7.     } catch (Throwable t) {  
  8.   
  9. // don't do this!  
  10.   
  11.     }  
  12.   
  13. }  

不要忽略异常

很多时候,开发者很有自信不会抛出异常,因此写了一个catch块,但是没有做任何处理或者记录日志。


  1. public void doNotIgnoreExceptions() {  
  2.   
  3. try {  
  4.   
  5. // do something  
  6.   
  7.     } catch (NumberFormatException e) {  
  8.   
  9. // this will never happen  
  10.   
  11.     }  
  12.   
  13. }  

但现实是经常会出现无法预料的异常或者无法确定这里的代码未来是不是会改动(删除了阻止异常抛出的代码),而此时由于异常被捕获,使得无法拿到足够的错误信息来定位问题。合理的做法是至少要记录异常的信息。


  1. public void logAnException() {  
  2.   
  3. try {  
  4.   
  5. // do something  
  6.   
  7.     } catch (NumberFormatException e) {  
  8.   
  9. log.error("This should never happen: " + e);  
  10.   
  11.     }  
  12.   
  13. }  

不要记录并抛出异常

可以发现很多代码甚至类库中都会有捕获异常、记录日志并再次抛出的逻辑。如下:


  1. try {  
  2.   
  3. new Long("xyz");  
  4.   
  5. } catch (NumberFormatException e) {  
  6.   
  7. log.error(e);  
  8.   
  9. throw e;  
  10.   
  11. }  

这个处理逻辑看着是合理的。但这经常会给同一个异常输出多条日志。如下:


  1. 17:44:28,945 ERROR TestExceptionHandling:65 - java.lang.NumberFormatException: For input string: "xyz"  
  2.   
  3. Exception in thread "main" java.lang.NumberFormatException: For input string: "xyz"  
  4.   
  5. at java.lang.NumberFormatException.forInputString(NumberFormatException.java:65)  
  6.   
  7. at java.lang.Long.parseLong(Long.java:589)  
  8.   
  9. at java.lang.Long.(Long.java:965)  
  10.   
  11. at com.stackify.example.TestExceptionHandling.logAndThrowException(TestExceptionHandling.java:63)  
  12.   
  13. at com.stackify.example.TestExceptionHandling.main(TestExceptionHandling.java:58)  

如上所示,后面的日志也没有附加更有用的信息。如果想要提供更加有用的信息,

那么可以将异常包装为自定义异常。


  1. public void wrapException(String input) throws MyBusinessException {  
  2.   
  3. try {  
  4.   
  5. // do something  
  6.   
  7.     } catch (NumberFormatException e) {  
  8.   
  9. throw new MyBusinessException("A message that describes the error.", e);  
  10.   
  11.     }  
  12.   
  13. }  

因此,仅仅当想要处理异常时才去捕获,否则只需要在方法签名中声明让调用者去处理

包装异常时不要抛弃原始的异常

捕获标准异常并包装为自定义异常是一个很常见的做法。这样可以添加更为具体的异常信息并能够做针对的异常处理。

需要注意的是,包装异常时,一定要把原始的异常设置为cause(Exception有构造方法可以传入cause)。否则,丢失了原始的异常信息会让错误的分析变得困难。


  1. public void wrapException(String input) throws MyBusinessException {  
  2.   
  3. try {  
  4.   
  5. // do something  
  6.   
  7.     } catch (NumberFormatException e) {  
  8.   
  9. throw new MyBusinessException("A message that describes the error.", e);  
  10.   
  11.     }  
  12.   
  13. }  

总结

综上可知,当抛出或者捕获异常时,有很多不一样的东西需要考虑。其中的许多点都是为了提升代码的可阅读性或者api的可用性。

异常不仅仅是一个错误控制机制,也是一个沟通媒介,因此与你的协作者讨论这些最佳实践并制定一些规范能够让每个人都理解相关的通用概念并且能够按照同样的方式使用它们。

文章来源:微信公众号-Java程序员社区
对我有用,我要     转载  
文章分类: Java  
所属标签: 异常   Exception  
  • 0条评论
  • 只看作者
  • 按时间|按热度
  • 由于本人多次涉及需要打印这个证明,而每次都会忘记入口,在网上各种搜索各种摸索很是浪费时间。故本次将操作流程整理记录下来,以备忘。同时也分享给大家。1、打开湖北政务服务网,地址:http://zwfw.hubei.gov.cn/s/index.html2、切换区域到“武汉市”3、在“特色服务”模块找到“(个人)武汉市社会保险公共服务平台”4、进入“(个人)武汉市社会保险公共服务平台”,登录账号密码<imgsrc="https://cdnstatic.hoscen.cn/blog/article/184053017752895488/img/497065960be44747825acb86a17483c1.png"style=
  • 本文讲触发el-dialog前动态修改窗口title的方法。1、el-dialog添加title属性el-dialog :title="titleType+'菜单'" :visible.sync="dialogVisible" width="800px" >el-dialog>  2、初始化变量(titleType,名称自己定义)export&
  • 如何使用postman模拟http发送xml参数报文的POST请求?1、postman工具通过安装软件或使用谷歌插件都可以,这里不再赘述。2、配置postman,选择POST,填写URL;切换到Headers,添加Content-Type:text/xml 3、切换到body,选择raw,XML,下方填写你的请求报文4、点击Send发送请求,如图可以看到响应状态、时间、结果等信息5、讲到这里就结束了,是不是学会了?快去试试吧!
  • 一般我们在使用CDN时都设置有缓存时间,当源站资源发生变更后,如果缓存时间没到,那么用户访问的依旧是变更前的数据,虽说又拍云控制台提供了缓存刷新功能界面,但是每次都手动去刷新显示不太理想,当然又拍云也想到了这一点,提供给我们有API可以调用。本篇文章就是讲解如何接入又拍云缓存刷新API。网站免费接入又拍云CDN的方法,请查看我另外一篇文章,地址: https://www.hoscen.cn/blog/hao/articles/204022774975430656.html又拍云API文档:https://api.upyun.com/doc#/api/guide/overview看完文档,我们会知道又拍云提供有两个缓存刷新接口,一个支持通配符(但次数有限),一个是完整url刷新。同时注意调用接口时将 Token 放入 HTTP Header 中 。那么我们需要3个接口:1、获取token2、URL刷新3、缓存批量刷新详细请求参数和响应值请查看文档。话不多说,我们直接放上核心代码1、获取token2、URL刷新<img src="https://cdnstatic.hoscen.cn/blog/article/
  • 很多时候我们需要Linux服务器定时去运行一个脚本来触发一个操作,比如写缓存数据到硬盘、定时备份、定时重启服务、定期清除日志等。下面就简单讲解一下Linuxcrontab命令如何实现自动循环执行shell脚本。一、准备shell脚本比如我们准备一个hello.shvim/hcn/sh/hello.sh#!/bin/bash  DATETIME=$(date"+%Y%m%d%H%M%S") echo"hello, www.hoscen.cn,时间:${DATETIME}"  通过chmod命令赋予该脚本的执行权限chmod755hello.sh测试正确性二、开启crontab服务 linux应该都有crontab,没有的话可以安装一下:yuminstall vixie-cronyuminstall crontabsvixie-cron软
  • 本文主要讲canonical标签的使用、canonical标签的作用、canonical标签SEO,在实践中如何正确规范的使用canonical标签。Canonical标签实际上就是一个页面内的301转向,可以帮助我们解决内容一样url不一样的网址规范化问题。和301跳转不同的是,用户并不被转向,但是对于搜索引擎来说,页面链接的权重是会被集中到代码中指明的规范化url上的。 图片来源:一灯出海对于经验丰富的SEO人员来说,canonical标签的使用一定不陌生,但最近在实践中发现不少网站的页面虽然用了canonical标签,但是使用方法却不规范。所以在这里和大家一起探讨一下canonical标签的规范使用方法,让更多的SEO人员避免走弯路。如果一个页面有多个url:https://www.hoscen.cn/blog/hao/articles/211896161185824768.htmlhttps://www.hoscen.cn/blog/hao/articles/211896161185824768/view这些url的页面内容完全一样,而我们想优化的规范化url为<ahref="https://www.hoscen.cn/blog/ha
  • 生活中难免有觉得“好累啊”的时候,岁月在不同阶段将不同压力倾轧到不同人身上,那些时刻降临时,多半只能靠自己挺过去,“人应该有力量,揪着自己的头发把自己从泥地里拔起来。”  10种疲累,10个“解药”。给累了的你。《如果,你觉得很累很累……》No.1明明休了周末,周一上班还是觉得:好累啊……一剂解药:所谓的休息并不单纯只有躺下,而是做自己想做的事,不做自己不想做的事情。休息有“储存的休息”和“释放的休息”两种。“储存的休息”通过休息来储存体力和活力。“释放的休息”则通过做喜欢的事情来释放平日累积的郁闷和压力。“储存的休息”不足时身体会坏掉,“释放的休息”不足时精神会崩坏。开药者丨@bibibi_senseiNo.2总是活在别人的眼光里,总是被他人的评价所左右,好累啊……一剂解药:纵使被说坏话
  • 1. 两数之和

    阅读数539
    总结:1、解决方法通常我们最容易想到的是暴力枚举(双重for循环),时间复杂度O(N^2),空间复杂度O(1),其中N是数组中的元素数量 2、利用哈希表可以以空间换时间,时间复杂度O(N),空间复杂度O(N),其中N是数组中的元素数量 题目给定一个整数数组nums和一个目标值target,请你在该数组中找出和为目标值的那两个整数,并返回他们的数组下标。你可以假设每种输入只会对应一个答案。但是,数组中同一个元素不能使用两遍。示例:给定nums=[2,7,11,15],target=9因为nums[0]+nums[1]=2+7=9所以返回[0,1]答案第一版:暴力枚举,时间复杂度高public int[] twoSum(int[]nums, int target){   int len=nums.length;   
  • 数据结构绪论

    阅读数538
    1、数据结构起源早期计算机被理解为数值计算工具,但是我们还有一些非数值的计算,因此需要一些更科学有效的手段(比如表、树、图等数据结构)的帮助来处理问题。所以数据结构是一门研究非数值计算的程序设计问题中的操作对象以及它们之间的关系和操作等相关问题的学科。2、基本概念和术语2.1 数据数据:是描述客观事物的符号,是计算机中可以操作的对象,是能够被计算机识别,并能输入给计算机处理的符号集合。数据不仅包括整型、实型等数值类型,还包括字符、声音、图像、视频等非数值类型。我们所说的数据,其实就是符号,但是这个符号需要满足两点:能输入到计算中能被计算机程序处理2.2 数据元素数据元素,也被称为记录。是组成数据的、具有一定意义的基本单位。比如,在人类中,人就是数据元素。在禽类中,猪狗牛羊等动物就是禽类的数据元素。2.3 数据项数据项:一个数据元素可以由若干个数据项组成。比如 人这个数据元素,就可以有眼、耳、鼻等数据项,也可以有姓名、年龄等数据项。具体有哪些数据项是视你所做的系统来决定。数据项是数据不可分割的最小单位。但注意真正讨论问题时,数据元素才是数据结构中建立数据模型的着眼点。就像我们讨论一个电影,通常是讨论角色这个“数据元素”,而不是讨论角色的姓名、年龄这些“数据项”。2.4 数据对象数据对象:是性
  • xxx:郝实诚!你真的叫这个名字啊? 我:对啊  不止一次....-- 大家好,我叫郝实诚,真的很实诚。