java异常及日志注意事项
一、异常注意事项
简单整理了下关于异常的规范:
1) 在异常处理模块中应提供精确、易读的错误原因信息。
2) 不要处理能够避免的异常。
3) 一个方法不应该抛出太多类型的异常,最好不超过三个。
4) 不要在try以及finally字段内部使用return语句。
5) 数据库、io操作等涉及资源池泄漏的操作一定要在finally中来释放资源。
6) 将try/catch区段置于循环之外。
7) 不要将异常用于程序流程控制,异常处理效率低于条件分支,且跳转流程难以预测。
8) 在程序中使用异常处理还是使用错误返回码处理,根据是否有利于程序结构来确定,并且异常和错误码不应该混合使用,推荐使用异常。
9) 异常捕获尽量不要直接catch(Exception),应该把异常细分处理。
10) 对于异常应分类处理,不要只捕捉Exception。
11) 对于异常不能忽略,并且应该记入日志。
二、异常优化
2.1、不要忽略checked Exception
1) 处理异常,进行修复以让程序继续执行。例如在进行数据库查询时,数据库连接断链后重新链接成功。
2) 在对异常进行分析后发现这里不能处理它,那么重新抛出异常,让调用者处理。异常依次向上抛出,如果所有方法都不能恰当地处理异常,最终会在用户以恰当的方式提示用户,由用户来判断下一步处理措施。例如在进行数据库查询时,断链后重试几次依旧失败的情况。
3) 将异常转换为其他异常再抛出,这时应该注意不要丢失原始异常信息。这种情况一般用于将底层异常封装为应用层异常。
4) 不要捕获异常,应在函数定义中使用throws声明将抛出该异常,让调用者去处理该异常。
5) 因此,当捕获一个checked Exception的时候,必须对异常进行处理;如果认为不必要在这里作处理,就不要捕获该异常,在方法体中声明方法抛出异常,由上层调用者来处理该异常。
2.2、不要捕获unchecked Exception
有两种checked Exception:
1) Error:这种情况属于JVM发生了不可恢复的故障,例如内存溢出,无法处理。
2) RuntimeException:这种情况属于错误的编码导致的,出现异常后需要修改代码才能修复,一般来说catch后没有恰当的处理方式,因此不应该捕获。(该规则不适用于守护线程中处理catch runtime exception)
2.3、不要一次捕获所有的异常
1) 针对try块中抛出的每种Exception,很可能需要不同的处理和恢复措施,而由于这里只有一个catch块,分别处理就不能实现。
2) Try块中还可能抛出RuntimeException,代码中捕获了所有抛出的RuntimeException而没有做任何处理,掩盖了编程的错误,会导致程序难以调试。
2.4、使用finally块释放资源
什么是资源:程序中使用的数量有限的对象,或者只能独占式访问的对象。例如:线程、线程池、数据库连接、ftp连接,因为资源是“有限的“,因此资源使用后必须释放,以避免程序中的资源被耗尽,影响程序运行。某些资源,使用完毕后会自动释放,如线程,某些资源则需要显示释放,如数据库连接。
Finally关键字保证无论程序使用任何方式离开try块,finally中的语句都会执行。
因此,当你需要一个地方来执行在任何情况下都必须执行的代码时,就可以将这些代码放入到finally块中。当你的程序中使用了资源,如数据库连接,文件,Ftp连接,线程等,必须将示范给这些资源的代码写入finally块中。
2.5、finally块中不能抛出异常
JAVA异常处理机制保证无论在任何情况下都先执行finally快的代码,然后再离开整个try,catch,finally块。在try,catch块中向外抛出异常的时候,JAVA虚拟机先转到finally块执行finally中的代码,然后将异常抛出。但如果在finally块中抛出异常,try,catch块的异常就不能抛出,外部捕捉到的异常就是finally块中的异常信息,而try,catch块中发生的真正的异常堆栈信息则丢失了。
2.6、抛出自定义异常时带上原始异常信息
Try块捕获抛出的异常后,抛出了新的自定义异常需要将原来异常的堆栈信息带上,利于排错。
2.7、不要同时使用异常机制和返回值来进行异常处理
例如:
try{
......
}catch(Exception e){
throw new Exception(msg,e);
return " ";
}
混合使用JAVA异常处理机制和返回值使程序的异常处理部分变得“丑陋不堪”,并难以理解。如果有多种不同的异常情况,就定义多种不同的异常,而不要像上面代码那样综合使用Exception和返回值。
三、日志优化及注意事项
3.1、Log上下文
在Log中必须尽量带入上下文的信息,对比以下两个Log信息,后者比前者更有作用。
3.2、Error或者Warn级别中碰到Exception的情况尽量log完整的异常信息
Error和Warn级别是比较严重的情况,意味着系统出错或者危险,我们需要更多的信息来帮助分析原因,这个时候越多的信息越有帮助。包含以下内容:
1) 你是在做什么事情的时候出错了
2) 你是在用什么数据做这个事情的时候出错了
3) 出错的信息是什么
对比下面三个Log语句,第一个提供了详尽的信息,第二个只提供了部分信息,Exception的Message不一定包含有用的信息,第三个只告诉你出错了,其他的你一无所知:
1) Log.error(“获取用户[{}]的用户信息时出错”,username,ex);
2) Log.error(“获取用户[{}]的用户信息时出错”,username,ex.getMessage());
3) Log.error(“获取用户[{}]的用户信息时出错”);
3.3、基本的Logger编码
1) 在一个对象中通常只使用一个Logger对象,Logger应该是static final的,只有在少数需要在构造函数中传递logger的情况下才使用private fianl。
Static final Logger logger = LoggerFactory.getLogger(Main.class);
2) 输出Exceptions的全部Throwable信息,因为logger.error(msg)和logger.error(msg,e.getMessage())这样的日志输出方法会丢失掉最重要的StackTrace信息。
Void foo(){
Try{
......
}catch(Exception e){
Logger.error(e.getMessage());//错误
Logger.error(“msg”,e.getMessage());//错误
Logger.error(“msg”,e);//正确
}
}
3) 对与不是特别重要的异常,不允许记录日志后又抛出异常,因为这样会多次记录日志,只允许记录一次
Try{
......
}catch(Exception ex){
Logger.error(errorMessage,ex);
Throw new UserSercviceException(errorMessage,ex);
}
4) 不允许出现System print(包括System.out.println和System.error.println)语句。
5) 不允许出现e.printStackTrace。
6) 日志性能的考虑,如果代码为核心代码,执行频率非常高,则输出日志建议增加判断,尤其是低级别的输出<debug、info、warn>。
7) 有意义的日志
通常情况下在程序日志里记录一些比较有意义的状态数据:程序启动,退出的时间点:
程序运行消耗时间;耗时程序的执行进度;重要变量的状态变化。
除此之外,在公共的日志里规避打印程序的调试或者提示信息。
说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?
java异常及日志注意事项的更多相关文章
- 写给大忙人的ELK最新版6.2.4学习笔记-Logstash和Filebeat解析(java异常堆栈下多行日志配置支持)
接前一篇CentOS 7下最新版(6.2.4)ELK+Filebeat+Log4j日志集成环境搭建完整指南,继续对ELK. logstash官方最新文档https://www.elastic.co/g ...
- ELK学习笔记之Logstash和Filebeat解析对java异常堆栈下多行日志配置支持
0x00 概述 logstash官方最新文档.假设有几十台服务器,每台服务器要监控系统日志syslog.tomcat日志.nginx日志.mysql日志等等,监控OOM.内存低下进程被kill.ngi ...
- Java异常使用要点记录
近期有离职的想法,奈何简历过于寒碜,技术懂的少,基础也薄弱,想要提升自己却不知从哪里入手.在郁闷一段时间后偶然间看到一篇博客,博主说出了许多人的心声,同时也指出了切入点,的确基础才是重点,是时候沉迷学 ...
- java编写规范及注意事项
java编写规范及注意事项 1.注释 常见注释有三种 // /**/ /****/ 如何才能写出漂亮的注释呢,注释的目的就是为了使你的代码让人更容易理解和维护,写一手好的注释是一个优秀码农的基本 ...
- Java 异常讲解(转)
六种异常处理的陋习 你觉得自己是一个Java专家吗?是否肯定自己已经全面掌握了Java的异常处理机制?在下面这段代码中,你能够迅速找出异常处理的六个问题吗? 1 OutputStreamWrite ...
- 一篇不错的讲解Java异常的文章(转载)
http://www.blogjava.net/freeman1984/archive/2007/09/27/148850.html 六种异常处理的陋习 你觉得自己是一个Java专家吗?是否肯定自己已 ...
- java异常——RuntimeException和User Define Exception
1.RuntimeException public class RuntimeException { public static void main(String[] args) { // TODO ...
- Java异常的面试问题及答案-Part 1
本文由 ImportNew - 韩远青 翻译自 Journaldev. Java提供了一个健壮的.面向对象的方法来处理出现异常,称为Java异常处理.我以前写过一篇长文章来介绍Java异常处理,今天我 ...
- JAVA异常的捕获与抛出原则
在可能会出现exception的地方,要使用try-catch或者throws或者两者都要.我的判断依据是:如果对可能出现的exception不想被外部(方法的调用者)知道,就在方法内部try-cat ...
随机推荐
- PIE的使用
实际上是指的是一个名为pie的htc文件,即pie.htc,使用CSS的behavior行为,可以调用此文件,然后让IE也能实现一些常见的 CSS3效果,如圆角(border-radius),盒阴影( ...
- c++细节--section1
1.register声明的变量为寄存器变量,因此没有地址,不能对它取地址操作. 2.[用错sizeof]当数组作为函数参数传递时,数组会退化为同类型的指针. 3.每个成员在成员初始化列表中只能出现一次 ...
- js之事件冒泡和事件捕获及其阻止详细介绍
虽然精通jquery,但对它的原型javascript却不是很了解,最近在学习javascript中遇到了一些困难,比如冒泡和捕获,很多次被提到,但又不知究竟应用在何处.找到了一些好文章解惑,在这里分 ...
- trace spring
package xx.com.aspect; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotati ...
- Vue 3.0 的生命周期
new Vue() new一个vue实例化对象 init Event & Lifecycle 执行一些初始化和生命周期相关的操作 beforeCreate 组件实例刚刚被创建出来 执行一些初始 ...
- Pytorch数据读取框架
训练一个模型需要有一个数据库,一个网络,一个优化函数.数据读取是训练的第一步,以下是pytorch数据输入框架. 1)实例化一个数据库 假设我们已经定义了一个FaceLandmarksDataset数 ...
- python面向对象(五)之多态
继承 在讲多态之前我们再复习下继承,下面是一个例子. Circle 和 Rectangle 继承自 Shape,不同的图形,面积(area)计算方式不同. # shape.py class S ...
- C# LINQ语句
1.select 和 selectMany SelectMany() 将中间数组序列串联为一个最终结果值,其中包含每个中间数组中的每个值 2.join语句 from x in xx join d in ...
- irport报表,把数字金额转换成大写人民币金额
1.编写oracle函数 CREATE OR REPLACE Function MoneyToChinese(Money In Number) Return Varchar2 Is strYuan ) ...
- git —— bug分支
储藏工作现场 $ git stash 切换到需要修改bug的分支,创建临时分支 修复bug,修复完提交 修复完之后,切换到需要修改的分支.完成合并 合并后删除临时分支 完成后,可以重新回到没有修改完的 ...