Java 异常是在 Java 应用中的警报器,在出现异常的情况下,可以帮助我们程序猿们快速定位问题的类型以及位置。但是一般在我们的项目中,由于经验阅历等多方面的原因,依然有若干的童鞋在代码中没有正确的使用异常打印方法,导致在项目的后台日志中,没有收到日志或者日志信息不完整等情况的发生,这些都给项目埋下了若干隐患。本文将深入分析在异常日志打印过程中的若干情况,并给出若干的使用建议。
1. Java 异常 Exception 的结构分析
我们通常所说的 Exception 主要是继承于 Throwable 而来,可以参见如下的结构图示:
主要的 Throwable 分为异常和错误两种,然后异常 Exception 和错误 Error 做为基类,分别被具体个性化以及衍生出 NullPointerException、EOFException 等等异常信息类。
基于 Java 中的源代码来分析,Error 和 Exception 仅仅是继承了 Throwable,做了构造函数的拓展,没有进行额外方法的延展;Exception 输出的主要核心方法都是定义在 Throwable 中的,感兴趣的童鞋可以尝试阅读 JDK 的源代码。
下面将介绍一下关键的几个异常类方法:
2. Error vs Exception
Error 在 Java 体系中定义为不可控制的问题,往往用来描述系统错误或者底层的问题,比如虚拟机错误,例如内存空间不足,方法调用栈溢等。我们以上图中列举出的内存溢出错误 (StackOverflowError) 为例,它是在 JVM 层面发生的错误,已经游离于 java 应用层之外;在应用程序层面是无法进行捕获,且无法从错误中恢复的。一般一旦发了类似问题,一般都是直接宕机,应用停止正常的工作,需要重新启动或者修复问题之后,方可重新正常工作。
Exception 一般发生在应用层,即在由项目中的 Java 代码层面引发的问题,且可以尝试进行捕获,此类问题不会影响到应用程序的正常工作的,即不会导致宕机现象的发生。我们在工作或者代码中常见的都是 Exception 衍生出来的各类异常。
这里需要强调说明一下,JVM 是 Java 语言的运行环境和平台,但是并不是 Java 语言体系的一个部分;在 JVM 平台上,还可以运行 Groovy, JPython, JRuby, Closure,scala 等等遵守 Java 语言规范(JavaLanguage Specification) 的编程语言,故我们可以将 Error 理解为脱离 Java 应用之外的问题。
3. Exception 中的运行时异常(RuntimeException) 和受控异常 (checked exception)
运行时异常(RuntimeException) 是指在运行之时发生的异常,无需显式地进行捕获;如果程序中发生类似的异常,JVM 会直接抛出此类异常,并打出响应的异常栈信息。此类异常也通常被称为 unchecked exception, 未受控异常。
受控异常(checked Exception) 是我们最常见的异常种类,在代码中使用的异常基本上都是此类异常,此类异常会在代码编译阶段由 Java 编译器进行语法检查,如果未显式进行异常捕获,则会报出相应的编译异常信息。
4. 如何在代码中正确打印异常信息
下面我们将通过一系列的例子来说明上述几个 Exception 中方法的使用技巧。
Case 1: getMessage()/getLocalizedMessage()
public void testCase1() {
System.out.println("We are going to do something interesting....");
try {
throw new NullPointerException("I am an exception in the code.");
} catch (Exception e) {
System.out.println("We got unexpected:" + e.getMessage());
System.out.println("We got unexpected:" + e.getLocalizedMessage());
}
}
输出结果:
We are going to do testing interesting....
We got unexpected in getMessage==> I am an exception in the code.
We got unexpected in getLocalizedMessage==> I am an exception in the code.
基于结果来分析, 上述两个方法只是将异常对象中的 Message 打印出来,这些信息对于我们追踪问题和调试帮助有限。
Case 2:e.printStackTrace()
public void testCase2() {
System.out.println("We are going to do something interesting....");
try {
throw new Exception("I am an exception in the code.");
} catch (Exception e) {
e.printStackTrace();
}
}
运行结果:
printStackTrace() 可以打印出整个异常栈,但是异常栈信息将输出到默认的输出流中,绝大多数情况下是系统的控制台,而在实际项目中,都是需要将异常栈输出到日志文件的,如果不显式指定,则会丢失异常信息,在日志文件中无从追查。
Case 3: 基于 log4j/slf4j 等输出到日志文件
在实际项目中,一般会使用 log4j/log4j2/JDK logging/slf4j/logback 等日志系统来存放日志,那如何来讲日志的异常栈存入日志文件呢,我们来看示例。
public void testCase3() {
System.out.println("We are going to do something interesting....");
try {
throw new NullPointerException("abcedfeg");
} catch (Exception e) {
logger.info("Unexpected error in", e);
}
}
我们需要到日志文件中,找到相应的异常信息,异常信息如下:
12:24:45.387 [main] INFO org.demo.TestException - Unexpected error in
java.lang.NullPointerException: abcedfeg
at org.demo.TestException.testCase3(TestException.java:39)
at org.demo.TestException.main(TestException.java:12)
我们可以发现,整个异常栈信息由两个部分组成:
>> 异常中的 message, 类似 getMessage() 输出的信息,
>> 使用 logger.info 之类的方法,将异常信息写入到日志流中.
以下为 log4j 的声明,这里以 slf4j 为例来示例:
private static final Logger logger = LoggerFactory.getLogger(TestException.class);
Case 4: fillInStackTrace()
public class FillInExceptionTest {
public static void main(String[] args) {
FillInExceptionTest fit = new FillInExceptionTest();
try {
fit.outerMehtod();
} catch (Exception e) {
System.out.println("\n==========I am the one evil separation line==============");
e.printStackTrace();
}
}
public void innerMethod() throws Exception {
throw new Exception("I got exception in an inner method.");
}
public void outerMehtod() throws Exception {
try {
innerMethod(); //invoke inner method.
} catch (Exception e) {
e.printStackTrace();
throw (Exception)e.fillInStackTrace();
}
}
}
运行结果:
基于上述的运行结果可知,fillInStackTrace() 只提取了当下的异常栈信息,而非完整的异常栈信息,这个就是此方法带给我们的特殊之处。
如果我们需要在最外层将完整的异常栈打印出来,该如何做呢? 将下述的语句:
throw (Exception)e.fillInStackTrace();
替换为:
throw e;
重新运行程序,我们就可以在最外层得到完整的异常栈信息了。
5. 总结
在本文中,我们介绍了异常类的继承体系,不同类型的异常区别与使用场景;并将基于代码示例展示了如何使用 Exception 的若干方法,利用这些方法来保留尽可能多的日志信息,方便我们后续针对日志中的异常信息,追查和解决问题。
---------------------- 罪恶的分割线 ----------------------------------------------
- 本文系CDSN的博主<<木小鱼的笔记>>个人原创,如要转载,请保留原始链接和原作者信息,支持原创,尊重原创,让知识世界更美好。
- 作者本人也维护了一个今日头条上的头条号:程序加油站,欢迎大家关注。
来源: http://blog.csdn.net/blueheart20/article/details/71036739