概述

在这篇短文中,我们将探讨为什么我们在Java异常堆栈跟踪中会看到未知来源,并学习如何解决这个问题。

2. 类调试信息

Java类文件包含可选的调试信息,以方便调试。我们可以在编译时选择是否以及添加哪些调试信息到类文件中。这将决定在运行时可用的调试信息。

让我们查看Java编译器的帮助文档,看看可用的各种选项:

javac -help

Usage: javac <options> <source files>
where possible options include:
  -g                         Generate all debugging info
  -g:none                    Generate no debugging info
  -g:{lines,vars,source}     Generate only some debugging info

Java编译器的默认行为是将行号和源代码信息添加到类文件中,这相当于-g:lines,source

2.1. 使用调试选项编译

现在,让我们来看看当我们使用上述选项编译Java类时会发生什么。我们有一个故意引发StringIndexOutOfBoundsExceptionMain类。

根据使用的编译机制,我们需要相应地指定编译选项。这里我们将使用Maven及其编译插件来定制编译选项:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.12.1</version>
    <configuration>
        <compilerArgs>
            <arg>-g:none</arg>
        </compilerArgs>
    </configuration>
</plugin>

我们将-g设置为none,这意味着我们的编译类将不会生成任何调试信息。运行有bug的Main类会产生堆栈跟踪,其中我们看到的是未知来源,而不是异常发生的确切行号。

Exception in thread "main" java.lang.StringIndexOutOfBoundsException: begin 0, end 10, length 5
  at java.base/java.lang.String.checkBoundsBeginEnd(String.java:3751)
  at java.base/java.lang.String.substring(String.java:1907)
  at com.baeldung.unknownsourcestacktrace.Main.getShortenedName(Unknown Source)
  at com.baeldung.unknownsourcestacktrace.Main.getGreetingMessage(Unknown Source)
  at com.baeldung.unknownsourcestacktrace.Main.main(Unknown Source)

让我们看看生成的类文件包含什么内容。我们将使用javap(Java类文件反汇编器)来查看:

javap -l -p Main.class

public class com.baeldung.unknownsourcestacktrace.Main {
    private static final org.slf4j.Logger logger;
    private static final int SHORT_NAME_LIMIT;
    public com.baeldung.unknownsourcestacktrace.Main();
    public static void main(java.lang.String[]);
    private static java.lang.String getGreetingMessage(java.lang.String);
    private static java.lang.String getShortenedName(java.lang.String);
    static {};
}

可能很难知道我们应该期望在这里看到什么样的调试信息,所以让我们改变编译选项来看看结果如何。

2.3. 解决方法

现在,我们将编译选项更改为-g:lines,vars,source,这将在类文件中添加LineNumberTableLocalVariableTableSource信息。这与仅使用-g(即添加所有调试信息)等价:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.12.1</version>
    <configuration>
        <compilerArgs>
            <arg>-g</arg>
        </compilerArgs>
    </configuration>
</plugin>

再次运行有bug的Main类,我们现在得到:

Exception in thread "main" java.lang.StringIndexOutOfBoundsException: begin 0, end 10, length 5
  at java.base/java.lang.String.checkBoundsBeginEnd(String.java:3751)
  at java.base/java.lang.String.substring(String.java:1907)
  at com.baeldung.unknownsourcestacktrace.Main.getShortenedName(Main.java:23)
  at com.baeldung.unknownsourcestacktrace.Main.getGreetingMessage(Main.java:19)
  at com.baeldung.unknownsourcestacktrace.Main.main(Main.java:15)

太好了,我们在堆栈跟踪中看到了行号信息。让我们看看类文件中发生了什么变化:

javap -l -p Main

Compiled from "Main.java"
public class com.baeldung.unknownsourcestacktrace.Main {
  private static final org.slf4j.Logger logger;

  private static final int SHORT_NAME_LIMIT;

  public com.baeldung.unknownsourcestacktrace.Main();
    LineNumberTable:
      line 7: 0
    LocalVariableTable:
      Start  Length  Slot  Name   Signature
          0       5     0  this   Lcom/baeldung/unknownsourcestacktrace/Main;

  public static void main(java.lang.String[]);
    LineNumberTable:
      line 12: 0
      line 13: 8
      line 15: 14
      line 16: 29
    LocalVariableTable:
      Start  Length  Slot  Name   Signature
          0      30     0  args   [Ljava/lang/String;
          8      22     1  user   Lcom/baeldung/unknownsourcestacktrace/dto/User;

  private static java.lang.String getGreetingMessage(java.lang.String);
    LineNumberTable:
      line 19: 0
    LocalVariableTable:
      Start  Length  Slot  Name   Signature
          0      28     0  name   Ljava/lang/String;

  private static java.lang.String getShortenedName(java.lang.String);
    LineNumberTable:
      line 23: 0
    LocalVariableTable:
      Start  Length  Slot  Name   Signature
          0       8     0  name   Ljava/lang/String;

  static {};
    LineNumberTable:
      line 8: 0
}

我们的类文件现在包含了三个关键信息:

  1. :顶部的头部指示了*.class文件是从哪个.java*文件生成的。在堆栈跟踪的上下文中,它提供了异常发生类的名称。
  2. LineNumberTable 将JVM实际运行时代码的行号映射到源代码文件中的行号。在堆栈跟踪中,它提供了异常发生的行号。我们也需要这个信息以便在调试器中使用断点。
  3. LocalVariableTable 包含获取局部变量值的详细信息。调试器可能会使用它来读取局部变量的值。在堆栈跟踪的上下文中,这并不重要。

3. 总结

现在我们熟悉了Java编译器生成的调试信息。操作它们的方式是通过-g编译选项。我们已经了解了如何使用Maven编译插件来实现这一点。

因此,如果我们发现堆栈跟踪中有未知来源,我们可以检查类文件以检查是否有调试信息。然后,我们可以根据构建工具选择正确的编译选项来解决这个问题。

如往常一样,完整的代码和Maven配置可在GitHub上找到。