什么是堆栈跟踪，我如何使用它来调试我的应用程序错误？

Question

有时当我运行我的应用程序时，它会给我一个看起来像这样的错误：

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)

人们将此称为“堆栈跟踪”。 什么是堆栈跟踪？它可以告诉我关于我的程序中发生的错误的什么信息？

---

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

Answer 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 ...”列表的开头开始，我们可以知道我们的错误发生在哪里。我们正在寻找的是作为我们应用程序一部分的 topmost 方法调用。在这种情况下，它是：

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

要调试这个，我们可以打开Book.java，查看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

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

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

同样，除了这个例外，我们想查看Book.java 的22 行，看看是什么导致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”，然后在那个“Caused by”块中，寻找源自我们的第一个方法调用代码，即：

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

与前面的示例一样，我们应该查看59 上的MyEntityService.java，因为这是该错误的起源（这有点明显出了什么问题，因为 SQLException 说明了错误，但调试过程是我们追求）。

Answer 2

什么是 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？

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

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

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

有时您无法确保不会出现异常。例如，如果您在程序中使用网络连接，则无法阻止计算机断开其 Internet 连接（例如，您无法阻止用户断开计算机的网络连接）。在这种情况下，网络库可能会抛出异常。现在您应该捕获异常并处理它。这意味着，在网络连接的示例中，您应该尝试重新打开连接或通知用户或类似的东西。此外，无论何时使用 catch，始终只捕获您想要捕获的异常，不要使用像 catch (Exception e) 这样会捕获所有异常的宽泛的 catch 语句。这非常重要，否则您可能会意外捕获错误的异常并以错误的方式做出反应。

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;
    }
}

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

TLDR

1. 找出异常的原因并修复它，使其根本不抛出异常。
2. 如果 1. 不可能，则捕获特定异常并处理它。
   • 永远不要只添加一个try/catch，然后忽略异常！不要那样做！
   • 永远不要使用catch (Exception e)，总是捕获特定的异常。这将为您省去很多麻烦。

Answer 3

补充 Rob 提到的内容。在应用程序中设置断点允许逐步处理堆栈。这使开发人员能够使用调试器来查看该方法在什么时候执行了未预料到的操作。

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

如果我们有一个带参数的方法，例如：void (String firstName)

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

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

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

上面是检查空值的正确顺序，我们从基础对象开始，在这种情况下是狗，然后开始沿着可能性树走，以确保在处理之前一切都是有效的。如果顺序颠倒，NPE 可能会被抛出，我们的程序会崩溃。

Answer 4

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

关键1：这里需要理解的一个棘手而重要的事情是：最深的原因可能不是“根本原因”，因为如果你写了一些“糟糕的代码”，可能会导致下面的一些异常比它的层更深。例如，一个错误的 sql 查询可能会导致底层的 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 被 Bootstrap.java:14 调用的 Auther.java:25 调用，Book.java:16 是根本原因。 这里附上一张按时间顺序对跟踪堆栈进行排序的图表。

Answer 5

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)

Answer 6

只是添加到其他示例中，有 inner(nested) classes 以$ 符号出现。例如：

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)

Answer 7

其他帖子描述了堆栈跟踪是什么，但它仍然很难使用。

如果您获得堆栈跟踪并想跟踪异常的原因，了解它的一个很好的起点是使用 Eclipse 中的 Java Stack Trace Console .如果您使用其他 IDE，可能会有类似的功能，但这个答案是关于 Eclipse。

首先，确保您可以在 Eclipse 项目中访问所有 J​​ava 源代码。

然后在 Java 透视图中，单击 Console 选项卡（通常位于底部）。如果控制台视图不可见，请转到菜单选项 Window -> Show View 并选择 Console。

然后在控制台窗口中，点击下面的按钮（右侧）

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

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

这是您可能会看到的（图片来自 Eclipse 文档）：

最近进行的方法调用将是堆栈的top，即顶行（不包括消息文本）。沿着堆栈往下走可以回到过去。第二行是调用第一行的方法，以此类推

如果您使用的是开源软件，则可能需要下载源代码并将其附加到您的项目中以进行检查。下载源 jars，在您的项目中，打开 Referenced Libraries 文件夹，找到您的开源模块（带有类文件的那个）的 jar，然后右键单击，选择 Properties em> 并附上源 jar。