关于java:什么是堆栈跟踪,如何使用它来调试我的应用程序错误?

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

有时,当我运行应用程序时,会出现如下错误:

1
2
3
4
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)

人们称之为"堆栈跟踪"。什么是堆栈跟踪?它能告诉我程序中发生的错误是什么?


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


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

简单实例

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

1
2
3
4
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…"列表的开头开始,就可以知道错误发生在哪里。我们要寻找的是应用程序中最顶层的方法调用。在这种情况下,它是:

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

要进行调试,我们可以打开Book.java并查看行16,即:

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

这表明上面代码中的某个东西(可能是title)是null

例外链示例

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

1
2
3
4
5
6
7
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   }

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

1
2
3
4
5
6
7
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

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

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

同样,除了这个例外,我们想看一下Book.java22行,看看什么可能导致NullPointerException出现在这里。

使用库代码的更令人生畏的示例

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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包中的任何内容。在上面的第二个示例中,我们首先要查找根本原因,即:

1
Caused by: java.sql.SQLException

但是,下面的所有方法调用都是库代码。因此,我们将转到上面的"caused by",并查找源于代码的第一个方法调用,即:

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

像前面的例子一样,我们应该在59行上查看MyEntityService.java,因为这就是产生错误的地方(这个错误有点明显,因为sqlException声明了错误,但调试过程是我们要处理的)。


我发布这个答案,所以最上面的答案(按活动排序)不是一个明显错误的答案。

什么是stacktrace?

stacktrace是一个非常有用的调试工具。它显示在引发未捕获异常(或手动生成stacktrace时)的调用堆栈(也就是在该点调用的函数堆栈)。这是非常有用的,因为它不仅显示了错误发生的位置,而且还显示了程序是如何在代码所在的位置结束的。这就引出了下一个问题:

例外是什么?

异常是运行时环境用来告诉您发生了错误的原因。常见的例子有nullpointerException、indexoutofboundsException或arithmeticeException。这些都是当你试图做一些不可能的事情时造成的。例如,当尝试取消对空对象的引用时,将引发NullPointerException:

1
2
3
4
5
6
7
8
9
10
11
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.

我应该如何处理stacktrace/异常?

首先,找出导致异常的原因。尝试在谷歌上搜索异常的名称,找出异常的原因。大多数情况下,这是由错误的代码引起的。在上面给出的示例中,所有异常都是由错误的代码引起的。因此,对于nullpointerException示例,您可以确保a在当时永远不为空。例如,您可以初始化a或包括如下支票:

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

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

有时候你不能确定你没有例外。例如,如果在程序中使用网络连接,则无法阻止计算机失去其Internet连接(例如,无法阻止用户断开计算机的网络连接)。在这种情况下,网络库可能会抛出异常。现在您应该捕获异常并处理它。这意味着,在使用网络连接的示例中,您应该尝试重新打开连接或通知用户或类似的事情。另外,无论何时使用catch,总是只捕获想要捕获的异常,不要使用像catch (Exception e)这样的广泛catch语句来捕获所有异常。这非常重要,因为否则您可能会意外地捕获错误的异常并以错误的方式作出反应。

1
2
3
4
5
6
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)

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

1
2
3
4
5
6
7
8
9
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,如果abnull的话,则抛出。这意味着,你可能会得到一个NullPointerException,但是你会把它当作一个算术例外,并且可能会做错事。在最好的情况下,您仍然会错过NullPointerException。这样的东西会使调试变得更困难,所以不要这样做。

TLDR

  • 找出异常的原因并解决它,这样它就不会抛出异常。
  • 如果是1。不可能,捕获特定的异常并处理它。

    • 永远不要只添加一个try/catch,然后忽略异常!不要那样做!
    • 不要使用catch (Exception e),总是捕获特定的异常。那会减轻你的头痛。

  • 补充罗布提到的内容。在应用程序中设置断点允许对堆栈进行逐步处理。这使开发人员能够使用调试器来查看该方法在什么确切点上执行了一些出乎意料的操作。

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

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

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

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

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

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


    Throwable家族还提供了一个StackTrace特性——可以操作堆栈跟踪信息。

    标准行为:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    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();
        }
    }

    堆栈跟踪:

    1
    2
    3
    4
    5
    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)

    操作的堆栈跟踪:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    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();
        }
    }

    堆栈跟踪:

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

    要理解名称:堆栈跟踪是一个异常列表(或者您可以说是"原因来源"),从最表面的异常(例如服务层异常)到最深的异常(例如数据库异常)。正如我们称之为"stack"的原因是因为stack是first-in-last-out(filo),最深的异常发生在最开始的时候,然后一个异常链产生了一系列的结果,表面异常是最后一个及时发生的,但我们首先看到它。

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

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

    关键2:另一个棘手但重要的事情是在每个"原因由"块,第一行是最深的一层,发生在这个块的第一位。例如,

    1
    2
    3
    4
    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: 16被Author调用。Java:25被Bootstrap调用。Java:14,Boo.java:16是根本原因。这里附上一张图表,按时间顺序对跟踪堆栈进行排序。enter image description here


    除了其他示例之外,还有一些内部(嵌套的)类出现在$符号中。例如:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    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();
        }
    }

    将导致此堆栈跟踪:

    1
    2
    3
    4
    5
    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)


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

    如果获得堆栈跟踪并想跟踪异常的原因,理解它的一个好的起点是在Eclipse中使用Java堆栈跟踪控制台。如果您使用另一个IDE,可能有类似的特性,但这个答案是关于Eclipse的。

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

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

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

    Consoles button

    然后从下拉列表中选择Java堆栈跟踪控制台。

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

    这就是您可能看到的(Eclipse文档中的图像):

    Diagram from Eclipse documentation

    最新的方法调用将是堆栈的顶部,即顶行(不包括消息文本)。从烟囱往下走会及时回来。第二行是调用第一行等的方法。

    如果您使用的是开放源码软件,那么如果您想检查源代码,可能需要下载源代码并将其附加到项目中。下载源jar,在您的项目中,打开referenced libraries文件夹以查找您的开放源代码模块(具有类文件的模块)的jar,然后右键单击,选择属性并附加源jar。