什么是堆栈跟踪,如何使用它来调试应用程序错误?


644

有时,当我运行我的应用程序时,它给我一个错误,看起来像:

Exception in thread "main" java.lang.NullPointerException
        at com.example.myproject.Book.getTitle(Book.java:16)
        at com.example.myproject.Author.getBookTitles(Author.java:25)
        at com.example.myproject.Bootstrap.main(Bootstrap.java:14)

人们将其称为“堆栈跟踪”。什么是堆栈跟踪?关于程序中发生的错误,它能告诉我什么?


关于这个问题-我经常看到一个问题,这个问题是新手程序员在“遇到错误”时遇到的,他们只是粘贴了堆栈跟踪和一些随机的代码块,而不了解堆栈跟踪是什么或如何使用它。该问题旨在为可能需要帮助来了解堆栈跟踪值的新手程序员提供参考。


25
另外,如果stacktrace行不包含文件名和行号,则该行的类未使用调试信息进行编译。
托尔比约恩Ravn的安德森

Answers:


589

简单来说,堆栈跟踪是抛出异常时应用程序位于其中的方法调用的列表。

简单的例子

通过问题中给出的示例,我们可以准确确定在应用程序中引发异常的位置。让我们看一下堆栈跟踪:

Exception in thread "main" java.lang.NullPointerException
        at com.example.myproject.Book.getTitle(Book.java:16)
        at com.example.myproject.Author.getBookTitles(Author.java:25)
        at com.example.myproject.Bootstrap.main(Bootstrap.java:14)

这是一个非常简单的堆栈跟踪。如果我们从“ at ...”列表的开头开始,我们可以判断出错误发生在哪里。我们正在寻找的是应用程序中最顶层的方法调用。在这种情况下,它是:

at com.example.myproject.Book.getTitle(Book.java:16)

为了调试它,我们可以打开Book.java并查看line 16,它是:

15   public String getTitle() {
16      System.out.println(title.toString());
17      return title;
18   }

这将表明上面的代码中有(可能是title)某些内容null

带有一系列异常的示例

有时,应用程序会捕获异常并将其重新引发为另一个异常的原因。通常看起来像:

34   public void getBookIds(int id) {
35      try {
36         book.getId(id);    // this method it throws a NullPointerException on line 22
37      } catch (NullPointerException e) {
38         throw new IllegalStateException("A book has a null property", e)
39      }
40   }

这可能会给您一个堆栈跟踪,如下所示:

Exception in thread "main" java.lang.IllegalStateException: A book has a null property
        at com.example.myproject.Author.getBookIds(Author.java:38)
        at com.example.myproject.Bootstrap.main(Bootstrap.java:14)
Caused by: java.lang.NullPointerException
        at com.example.myproject.Book.getId(Book.java:22)
        at com.example.myproject.Author.getBookIds(Author.java:36)
        ... 1 more

与此不同的是“由...引起”。有时,例外会有多个“由...引起”部分。对于这些,您通常希望找到“根本原因”,这将是堆栈跟踪中最低的“ Cause by”部分之一。在我们的例子中是:

Caused by: java.lang.NullPointerException <-- root cause
        at com.example.myproject.Book.getId(Book.java:22) <-- important line

同样,对于此例外,我们会想看看行22Book.java,看看有什么可能导致NullPointerException这里。

库代码更令人生畏的示例

通常,堆栈跟踪要比上面的两个示例复杂得多。这是一个示例(虽然很长,但是展示了多个级别的链接异常):

javax.servlet.ServletException: Something bad happened
    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:60)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)
    at com.example.myproject.ExceptionHandlerFilter.doFilter(ExceptionHandlerFilter.java:28)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)
    at com.example.myproject.OutputBufferFilter.doFilter(OutputBufferFilter.java:33)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1157)
    at org.mortbay.jetty.servlet.ServletHandler.handle(ServletHandler.java:388)
    at org.mortbay.jetty.security.SecurityHandler.handle(SecurityHandler.java:216)
    at org.mortbay.jetty.servlet.SessionHandler.handle(SessionHandler.java:182)
    at org.mortbay.jetty.handler.ContextHandler.handle(ContextHandler.java:765)
    at org.mortbay.jetty.webapp.WebAppContext.handle(WebAppContext.java:418)
    at org.mortbay.jetty.handler.HandlerWrapper.handle(HandlerWrapper.java:152)
    at org.mortbay.jetty.Server.handle(Server.java:326)
    at org.mortbay.jetty.HttpConnection.handleRequest(HttpConnection.java:542)
    at org.mortbay.jetty.HttpConnection$RequestHandler.content(HttpConnection.java:943)
    at org.mortbay.jetty.HttpParser.parseNext(HttpParser.java:756)
    at org.mortbay.jetty.HttpParser.parseAvailable(HttpParser.java:218)
    at org.mortbay.jetty.HttpConnection.handle(HttpConnection.java:404)
    at org.mortbay.jetty.bio.SocketConnector$Connection.run(SocketConnector.java:228)
    at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:582)
Caused by: com.example.myproject.MyProjectServletException
    at com.example.myproject.MyServlet.doPost(MyServlet.java:169)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:727)
    at javax.servlet.http.HttpServlet.service(HttpServlet.java:820)
    at org.mortbay.jetty.servlet.ServletHolder.handle(ServletHolder.java:511)
    at org.mortbay.jetty.servlet.ServletHandler$CachedChain.doFilter(ServletHandler.java:1166)
    at com.example.myproject.OpenSessionInViewFilter.doFilter(OpenSessionInViewFilter.java:30)
    ... 27 more
Caused by: org.hibernate.exception.ConstraintViolationException: could not insert: [com.example.myproject.MyEntity]
    at org.hibernate.exception.SQLStateConverter.convert(SQLStateConverter.java:96)
    at org.hibernate.exception.JDBCExceptionHelper.convert(JDBCExceptionHelper.java:66)
    at org.hibernate.id.insert.AbstractSelectingDelegate.performInsert(AbstractSelectingDelegate.java:64)
    at org.hibernate.persister.entity.AbstractEntityPersister.insert(AbstractEntityPersister.java:2329)
    at org.hibernate.persister.entity.AbstractEntityPersister.insert(AbstractEntityPersister.java:2822)
    at org.hibernate.action.EntityIdentityInsertAction.execute(EntityIdentityInsertAction.java:71)
    at org.hibernate.engine.ActionQueue.execute(ActionQueue.java:268)
    at org.hibernate.event.def.AbstractSaveEventListener.performSaveOrReplicate(AbstractSaveEventListener.java:321)
    at org.hibernate.event.def.AbstractSaveEventListener.performSave(AbstractSaveEventListener.java:204)
    at org.hibernate.event.def.AbstractSaveEventListener.saveWithGeneratedId(AbstractSaveEventListener.java:130)
    at org.hibernate.event.def.DefaultSaveOrUpdateEventListener.saveWithGeneratedOrRequestedId(DefaultSaveOrUpdateEventListener.java:210)
    at org.hibernate.event.def.DefaultSaveEventListener.saveWithGeneratedOrRequestedId(DefaultSaveEventListener.java:56)
    at org.hibernate.event.def.DefaultSaveOrUpdateEventListener.entityIsTransient(DefaultSaveOrUpdateEventListener.java:195)
    at org.hibernate.event.def.DefaultSaveEventListener.performSaveOrUpdate(DefaultSaveEventListener.java:50)
    at org.hibernate.event.def.DefaultSaveOrUpdateEventListener.onSaveOrUpdate(DefaultSaveOrUpdateEventListener.java:93)
    at org.hibernate.impl.SessionImpl.fireSave(SessionImpl.java:705)
    at org.hibernate.impl.SessionImpl.save(SessionImpl.java:693)
    at org.hibernate.impl.SessionImpl.save(SessionImpl.java:689)
    at sun.reflect.GeneratedMethodAccessor5.invoke(Unknown Source)
    at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
    at java.lang.reflect.Method.invoke(Method.java:597)
    at org.hibernate.context.ThreadLocalSessionContext$TransactionProtectionWrapper.invoke(ThreadLocalSessionContext.java:344)
    at $Proxy19.save(Unknown Source)
    at com.example.myproject.MyEntityService.save(MyEntityService.java:59) <-- relevant call (see notes below)
    at com.example.myproject.MyServlet.doPost(MyServlet.java:164)
    ... 32 more
Caused by: java.sql.SQLException: Violation of unique constraint MY_ENTITY_UK_1: duplicate value(s) for column(s) MY_COLUMN in statement [...]
    at org.hsqldb.jdbc.Util.throwError(Unknown Source)
    at org.hsqldb.jdbc.jdbcPreparedStatement.executeUpdate(Unknown Source)
    at com.mchange.v2.c3p0.impl.NewProxyPreparedStatement.executeUpdate(NewProxyPreparedStatement.java:105)
    at org.hibernate.id.insert.AbstractSelectingDelegate.performInsert(AbstractSelectingDelegate.java:57)
    ... 54 more

在这个例子中,还有更多。我们最关心的是从代码中寻找方法,这些方法可能是com.example.myproject程序包中的任何方法。在上面的第二个示例中,我们首先要查找根本原因,即:

Caused by: java.sql.SQLException

但是,该方法下的所有方法调用都是库代码。因此,我们将向上移至其上方的“ Caused by”,并寻找源于我们代码的第一个方法调用,即:

at com.example.myproject.MyEntityService.save(MyEntityService.java:59)

就像在前面的例子中,我们应该看看MyEntityService.java就行59,因为这是此错误的起源(这个有点明显出了什么问题,因为SQLException中发生的错误,但调试程序是什么,我们以后是)。


3
@RobHruska-很好解释。+1。您是否知道任何将异常跟踪作为字符串并提供有用的方法来分析堆栈跟踪的解析器?-例如getLastCausedBy()或getCausedByForMyAppCode(“ com.example.myproject”)
Andy Dufresne 2014年

1
@AndyDufresne-我没碰到任何东西,但是我也没有真正看过。
罗布·赫鲁斯卡

1
建议的改进:Exception in thread "main"在第一个示例中解释堆栈跟踪的第一行。我认为特别有用的是解释这一行通常伴随着一条消息,例如变量的值,可以帮助诊断问题。我试图自己进行编辑,但是我正在努力将这些想法适合您的答案的现有结构。
法学徒

5
Java 1.7还添加了“抑制的:”-在此异常显示“引起者:”之前,它列出了抑制的异常堆栈跟踪。try-with-resource构造会自动使用它:docs.oracle.com/javase/specs/jls/se8/html/…,并且包含在资源关闭期间抛出的任何异常。
dhblah

JEP openjdk.java.net/jeps/8220715旨在通过提供诸如“由于'this.nullInstanceField'为空,不能写字段'nullInstanceField'”之类的细节来进一步提高特别是NPE的可理解性。
Mahatma_Fatal_Error

80

我发布此答案,因此最高的答案(按活动排序时)不是一个完全错误的答案。

什么是Stacktrace?

stacktrace是一个非常有用的调试工具。它显示了引发未捕获的异常时(或手动生成stacktrace时)的调用堆栈(即,到那时为止已调用的函数堆栈)。这非常有用,因为它不仅可以向您显示错误发生的位置,而且还可以告诉您程序在代码的那个位置是如何结束的。这导致下一个问题:

什么是例外?

运行时环境用来告诉您发生错误的是异常。流行的示例是NullPointerException,IndexOutOfBoundsException或ArithmeticException。当您尝试做一些不可能的事情时,都会导致这些。例如,当您尝试取消引用Null对象时,将抛出NullPointerException:

Object a = null;
a.toString();                 //this line throws a NullPointerException

Object[] b = new Object[5];
System.out.println(b[10]);    //this line throws an IndexOutOfBoundsException,
                              //because b is only 5 elements long
int ia = 5;
int ib = 0;
ia = ia/ib;                   //this line throws an  ArithmeticException with the 
                              //message "/ by 0", because you are trying to
                              //divide by 0, which is not possible.

我应该如何处理Stacktraces / Exceptions?

首先,找出导致异常的原因。尝试在Google上搜索该异常的名称,以查明该异常的原因是什么。在大多数情况下,这是由错误的代码引起的。在上面给出的示例中,所有异常都是由错误的代码引起的。因此,对于NullPointerException示例,您可以确保当时a永远不为null。例如,您可以初始化a或包含如下检查:

if (a!=null) {
    a.toString();
}

这样,如果,则不会执行违规行a==null。其他示例也是如此。

有时,您无法确定自己没有例外。例如,如果您在程序中使用网络连接,则无法阻止计算机失去其互联网连接(例如,您不能阻止用户断开计算机的网络连接)。在这种情况下,网络库可能会引发异常。现在,您应该捕获异常并处理。这意味着,在具有网络连接的示例中,您应尝试重新打开连接或通知用户或类似内容。另外,每当您使用catch时,始终仅捕获要捕获的异常,请勿使用广泛的catch语句,例如将捕获所有异常的事件。这非常重要,因为否则您可能会意外捕获错误的异常并以错误的方式做出反应。catch (Exception e)

try {
    Socket x = new Socket("1.1.1.1", 6789);
    x.getInputStream().read()
} catch (IOException e) {
    System.err.println("Connection could not be established, please try again later!")
}

为什么不使用catch (Exception e)

让我们用一个小例子来说明为什么您不应该只捕获所有异常:

int mult(Integer a,Integer b) {
    try {
        int result = a/b
        return result;
    } catch (Exception e) {
        System.err.println("Error: Division by zero!");
        return 0;
    }
}

这段代码试图做的是捕获ArithmeticException由0除以可能引起的结果。但是它也捕获NullPointerExceptionif abare 抛出的可能null。这意味着,您可能会得到一个a,NullPointerException但您会将其视为ArithmeticException并可能做错了事。在最好的情况下,您仍然会错过NullPointerException。这样的东西会使调试变得更加困难,所以不要那样做。

TLDR

  1. 找出导致异常的原因并加以解决,以使它根本不会引发异常。
  2. 如果不可能1.捕获特定的异常并进行处理。

    • 永远不要只添加try / catch,然后忽略异常!不要那样做!
    • 从不使用catch (Exception e),始终捕获特定的异常。这样可以省去很多麻烦。

1
关于为什么我们应该避免错误掩盖的很好解释
Sudip Bhandari

2
我正在发布此答案,因此最高的答案(按活动排序时)不是一个完全错误的答案,我不知道您在谈论哪个答案,因为这可能已经改变了。但是公认的答案无疑是更有趣的;)
AxelH

1
据我所知,我的意思是到现在为止已被删除。它的基本含义是“只需尝试try {} catch(Exception e){},然后忽略所有错误”。可接受的答案比我的答案要老很多,因此我的目的是就此事发表一些不同的看法。我认为这不会帮助任何人复制别人的答案或掩盖其他人已经很好涵盖的内容。
达卡龙

说“不要捕获异常”是一种误导,这只是一个用例。您的示例很棒,但是在线程循环顶部(内部运行)的位置怎么样?您应该始终在此处捕获异常(或可能是Throwable)并记录下来,这样它就不会消失(除非您设置了线程/记录器,否则正常运行时抛出的异常不会被正确记录)。
比尔K

1
我没有包括这种特殊情况,因为它仅与多线程有关。在单线程中,泄漏的异常会杀死程序并以可见方式记录该异常。如果某人不知道如何正确地处理异常,那么他们通常通常也不知道如何使用多线程。
达卡龙

21

要补充罗伯提到的内容。在应用程序中设置断点可以逐步处理堆栈。这使开发人员可以使用调试器查看该方法在什么时候执行了意外的操作。

由于Rob使用NullPointerException(NPE)来说明一些常见问题,因此我们可以通过以下方式帮助解决此问题:

如果我们有一个采用参数的方法,例如: void (String firstName)

在我们的代码中,我们想要评估firstName包含一个值的代码,我们将这样做:if(firstName == null || firstName.equals("")) return;

上面的内容阻止我们将其firstName用作不安全的参数。因此,通过在处理之前进行空检查,我们可以帮助确保代码正常运行。为了扩展一个利用对象和方法的示例,我们可以在这里看:

if(dog == null || dog.firstName == null) return;

上面是检查空值的正确顺序,我们从基础对象(在这种情况下为dog)开始,然后开始沿可能性树走去,以确保在处理之前所有内容都是有效的。如果顺序被颠倒,则可能会引发NPE,并且我们的程序将崩溃。


同意 例如,可以使用这种方法来找出语句中的哪个引用是null何时NullPointerException检查a的。
罗布·赫鲁斯卡

16
在处理String时,如果您想使用equals方法,我认为最好在比较的左侧使用常量,如下所示:而不是:if(firstName == null || firstName.equals(“” ))返回;我一直使用:if((“”)。equals(firstName))这样可以防止Nullpointer异常
Torres 2010年

15

Throwable系列提供了另一个堆栈跟踪功能-可以操作堆栈跟踪信息。

标准行为:

package test.stack.trace;

public class SomeClass {

    public void methodA() {
        methodB();
    }

    public void methodB() {
        methodC();
    }

    public void methodC() {
        throw new RuntimeException();
    }

    public static void main(String[] args) {
        new SomeClass().methodA();
    }
}

堆栈跟踪:

Exception in thread "main" java.lang.RuntimeException
    at test.stack.trace.SomeClass.methodC(SomeClass.java:18)
    at test.stack.trace.SomeClass.methodB(SomeClass.java:13)
    at test.stack.trace.SomeClass.methodA(SomeClass.java:9)
    at test.stack.trace.SomeClass.main(SomeClass.java:27)

操纵堆栈跟踪:

package test.stack.trace;

public class SomeClass {

    ...

    public void methodC() {
        RuntimeException e = new RuntimeException();
        e.setStackTrace(new StackTraceElement[]{
                new StackTraceElement("OtherClass", "methodX", "String.java", 99),
                new StackTraceElement("OtherClass", "methodY", "String.java", 55)
        });
        throw e;
    }

    public static void main(String[] args) {
        new SomeClass().methodA();
    }
}

堆栈跟踪:

Exception in thread "main" java.lang.RuntimeException
    at OtherClass.methodX(String.java:99)
    at OtherClass.methodY(String.java:55)

2
我不知道我对此有何看法...鉴于线程的性质,我建议新开发人员不要定义自己的堆栈跟踪。
PeonProgrammer

15

要了解名称,请执行以下操作:堆栈跟踪是一个异常列表(或者您可以说“原因”列表),从最表面的异常(例如,服务层异常)到最深层的异常(例如,数据库异常)。就像我们称之为“堆栈”的原因一样,因为堆栈是先进先出(FILO),最深层的异常发生在一开始,然后异常链产生了一系列后果,表面异常是最后一个事情及时发生了,但我们首先看到了它。

关键1:这里需要理解的一个棘手和重要的事情是:最深层的原因可能不是“根本原因”,因为如果您编写一些“不良代码”,则可能会在其深层之下导致某些异常。例如,错误的sql查询可能会导致在bottem中重置SQLServerException连接而不是syndax错误,该错误可能恰好在堆栈的中间。

-> 在中间找到根本原因是您的工作。 在此处输入图片说明

关键2:另一个棘手但重要的事情是在每个“ Cause by”块中,第一行是最深的层,并且在该块中排在第一位。例如,

Exception in thread "main" java.lang.NullPointerException
        at com.example.myproject.Book.getTitle(Book.java:16)
           at com.example.myproject.Author.getBookTitles(Author.java:25)
               at com.example.myproject.Bootstrap.main(Bootstrap.java:14)

Book.java:16被Auther.java:25调用,而Bootstrap.java:14则被调用,Book.java:16是根本原因。在此附上一个图表,按时间顺序对跟踪堆栈进行排序。 在此处输入图片说明


8

只是为了增加其他示例,还有内部(嵌套)类$符号一起出现。例如:

public class Test {

    private static void privateMethod() {
        throw new RuntimeException();
    }

    public static void main(String[] args) throws Exception {
        Runnable runnable = new Runnable() {
            @Override public void run() {
                privateMethod();
            }
        };
        runnable.run();
    }
}

将导致此堆栈跟踪:

Exception in thread "main" java.lang.RuntimeException
        at Test.privateMethod(Test.java:4)
        at Test.access$000(Test.java:1)
        at Test$1.run(Test.java:10)
        at Test.main(Test.java:13)

5

其他文章描述了堆栈跟踪是什么,但是仍然很难使用。

如果你得到一个堆栈跟踪,并要跟踪的异常的原因,了解一个很好的起点是使用的Java堆栈跟踪控制台Eclipse中。如果您使用另一个IDE,可能会有类似的功能,但是此答案与Eclipse有关。

首先,请确保您可以在Eclipse项目中访问所有Java源代码。

然后在Java透视图中,单击“ 控制台”选项卡(通常在底部)。如果“控制台”视图不可见,请转到菜单选项“ 窗口”->“显示视图”,然后选择“ 控制台”

然后在控制台窗口中,单击以下按钮(在右侧)

控制台按钮

然后从下拉列表中选择Java Stack Trace Console

将堆栈跟踪信息粘贴到控制台中。然后,它将提供指向您的源代码和任何其他可用源代码的链接的列表。

这可能是您所看到的(来自Eclipse文档的图像):

Eclipse文档中的图

由最近的方法调用将是顶部堆叠的,这是顶线(不包括消息文本)。往下走可以追溯到过去。第二行是调用第一行的方法,依此类推。

如果使用的是开源软件,则可能需要下载源并将其附加到项目中。下载源jar,在您的项目中,打开Referenced Libraries文件夹以找到您的开源模块(带有类文件的jar ),然后右键单击,选择“ 属性”并附加源jar。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.