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

What is a stack trace, and how can I use it to debug my application errors?

提问人:Rob Hruska 提问时间:10/21/2010 最后编辑:TarynRob Hruska 更新时间:10/3/2022 访问量:606226

问:

有时,当我运行我的应用程序时,它会给我一个错误,如下所示:

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)

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


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

Java 调试 堆栈跟踪

评论

34赞 Thorbjørn Ravn Andersen 3/11/2011
此外,如果堆栈跟踪行不包含文件名和行号,则不会使用调试信息编译该行的类。

答:

745赞 Rob Hruska 10/21/2010 #1

简单来说,堆栈跟踪是应用程序在引发异常时所处的方法调用列表。

简单示例

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

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)

为了调试这一点,我们可以打开并查看 line ,即:Book.java16

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

这将表明上面的代码中有某些内容(可能)。titlenull

包含一系列异常的示例

有时,应用程序会捕获一个异常,并将其作为另一个异常的原因重新引发。这通常如下所示:

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

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

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

同样,除了这个例外,我们想看看 line of 以了解可能导致 here 的原因。22Book.javaNullPointerException

更令人生畏的库代码示例

通常,堆栈跟踪比上面的两个示例复杂得多。下面是一个示例(它很长,但演示了多个级别的链式异常):

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”,并在“Caused by”块中,查找源自我们代码的第一个方法调用,即:

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

与前面的例子一样,我们应该查看 在线 ,因为这是此错误的来源(这有点明显,因为 SQLException 声明了错误,但调试过程是我们所追求的)。MyEntityService.java59

评论

3赞 Code-Apprentice 6/11/2015
建议的改进:解释第一个示例中以 开头的堆栈跟踪的第一行。我认为解释这一行通常伴随着一条消息,例如变量的值,可以帮助诊断问题,这将特别有帮助。我试图自己进行编辑,但我正在努力将这些想法融入您答案的现有结构中。Exception in thread "main"
5赞 dhblah 7/1/2015
此外,java 1.7 还添加了 “Suppressed: ” - 在显示此异常的 “Caused by:” 之前,它列出了被抑制的异常堆栈跟踪。它由 try-with-resource construct: docs.oracle.com/javase/specs/jls/se8/html/... 自动使用,并包含资源关闭期间引发的异常(如果有)。
1赞 Mahatma_Fatal_Error 6/5/2019
有一个 JEP openjdk.java.net/jeps/8220715 旨在通过提供诸如“无法写入字段'nullInstanceField',因为'this.nullInstanceField'为 null”等详细信息来进一步提高 NPE 的可理解性。
0赞 Thorbjørn Ravn Andersen 5/20/2021
@Mahatma_Fatal_Error 这是在 Java 14 中提供的。与 Java 11 LTS 相比,Java 17 中会有很多优点,所以希望它能成为开发的新基准。
0赞 soMuchToLearnAndShare 9/11/2021
@RobHruska,如果你在答案中添加“第 22 行”的实际代码,那就太好了,这样读者就可以更好地推理它。否则必须想象。Book.getId(Book.java:22)
24赞 Woot4Moo 10/21/2010 #2

补充一下 Rob 提到的内容。通过在应用程序中设置断点,可以逐步处理堆栈。这使开发人员能够使用调试器来查看该方法在哪个确切点执行了意外的操作。

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

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

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

以上可以防止我们用作不安全的参数。因此,通过在处理之前进行 null 检查,我们可以帮助确保我们的代码能够正常运行。为了扩展一个使用带有方法的对象的示例,我们可以在这里查看:firstName

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

以上是检查空值的正确顺序,我们从基本对象开始,在本例中为 dog,然后开始沿着可能性树向下走,以确保在处理之前一切都有效。如果顺序颠倒,可能会抛出 NPE,我们的程序将崩溃。

评论

0赞 Rob Hruska 10/21/2010
同意。例如,这种方法可用于找出语句中的哪个引用是检查 a 时引用的。nullNullPointerException
18赞 Torres 10/26/2010
在处理 String 时,如果你想使用 equals 方法,我认为最好在比较的左侧使用常量,如下所示: 而不是: if(firstName == null || firstName.equals(“”)) return;我总是使用: if((“”).equals(firstName)) 这可以防止 Nullpointer 异常
19赞 przemek hertel 9/17/2014 #3

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)

评论

5赞 PeonProgrammer 5/22/2019
我不知道我对此有何感想......鉴于线程的性质,我建议新开发人员不要定义自己的堆栈跟踪。
11赞 rghome 3/12/2015 #4

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

如果您获取堆栈跟踪并希望跟踪异常的原因,那么理解该异常的良好起点是使用 Eclipse 中的 Java 堆栈跟踪控制台。如果您使用其他 IDE,可能会有类似的功能,但这个答案是关于 Eclipse 的。

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

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

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

Consoles button

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

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

例如,如果我们有这个程序:

public class ExceptionTest {
    
    public static void main(String[] args) {
        int l = trimmedLength(null);
        System.out.println("Trimmed length = " + l);
    }
    
    private static int trimmedLength(String string) {
        return string.trim().length();
    }
}

你会得到以下堆栈跟踪:

Pasted stack trace

最近进行的方法调用(以及导致异常的方法调用)将是堆栈的顶部,即第一行(不包括错误消息文本)。在这种情况下,这就是方法。往下走,堆栈会回到过去。第二行是调用第一行的方法,依此类推。trimmedLength

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

99赞 Dakkaron 10/14/2015 #5

什么是堆栈跟踪?

堆栈跟踪是一个非常有用的调试工具。它显示在引发未捕获的异常时(或手动生成堆栈跟踪时)的调用堆栈(即在该点之前调用的函数堆栈)。这非常有用,因为它不仅向您显示错误发生的位置,还显示程序如何最终出现在代码的那个位置。 这就引出了下一个问题:

什么是例外?

异常是运行时环境用来告诉您发生了错误的内容。常见的示例包括 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.

我应该如何处理堆栈跟踪/异常?

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

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

这样,如果出现以下情况,则不会执行有问题的行。其他例子也是如此。a==null

有时你无法确保你不会得到例外。例如,如果您在程序中使用网络连接,则无法阻止计算机失去其 Internet 连接(例如,您无法阻止用户断开计算机的网络连接)。在这种情况下,网络库可能会引发异常。现在,您应该捕获异常并对其进行处理。这意味着,在网络连接的示例中,您应该尝试重新打开连接或通知用户或类似的东西。此外,每当使用 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(异常 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;
    }
}

这段代码试图做的是捕捉由可能的除以 0 引起的。但它也捕获了抛出 if 或 are 的可能性。这意味着,你可能会得到一个,但你会把它当作一个 ArithmeticException,并且可能会做错事。在最好的情况下,您仍然会错过 NullPointerException。诸如此类的东西使调试变得更加困难,因此不要这样做。ArithmeticExceptionNullPointerExceptionabnullNullPointerException

顶级域名

  1. 找出异常的原因并修复它,以便它根本不会引发异常。
  2. 如果 1.不可能,捕获特定异常并处理。
    • 永远不要只添加一个 try/catch,然后忽略异常!别这样!
    • 从不使用 ,始终捕获特定的异常。这将为您省去很多麻烦。catch (Exception e)

评论

3赞 Dakkaron 2/7/2017
据我所知,我的意思是现在已经删除了。它基本上说“只需放置一个 try{} catch(Exception e){} 并忽略所有错误”。公认的答案比我的答案要古老得多,所以我的目标是对此事给出一些不同的看法。我不认为只是复制别人的答案或覆盖其他人已经涵盖的内容对任何人都没有帮助。
0赞 Bill K 3/8/2017
说“不要捕获异常”具有误导性,这只是一个用例。你的例子很好,但是你在线程循环的顶部(内部运行)的位置呢?您应该始终在那里捕获异常(或者可能是可抛出的)并记录它,以便它不会无形地消失(除非您已设置线程/记录器,否则通常不会正确记录从运行中抛出的异常)。
3赞 Dakkaron 3/8/2017
我没有包括这种特殊情况,因为它只与多线程有关。在单线程中,泄露的异常会终止程序并明显记录。如果有人不知道如何正确处理异常,他们通常也不知道如何使用多线程。
11赞 Eugene S 4/19/2016 #6

只是为了补充其他示例,有一些内部(嵌套)类与符号一起出现。例如:$

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)
21赞 Kevin 7/26/2016 #7

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

关键1:这里需要理解的一件棘手而重要的事情是:最深的原因可能不是“根本原因”,因为如果你写了一些“坏代码”,它可能会在下面引起一些比其层更深的异常。例如,错误的 sql 查询可能会导致 bottem 中的 SQLServerException 连接重置,而不是 syndax 错误,这可能就在堆栈的中间。

-> 在中间找到根本原因是你的工作。 enter image description here

关键 2:另一个棘手但重要的事情是在每个“原因”块内,第一行是最深的层,并且发生在该块的第一位。例如

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 是根本原因。 此处附上一个图表,按时间顺序对跟踪堆栈进行排序。enter image description here