Java调试技巧：step显示源码行方法

在使用Java JDB命令行调试时，你是否遇到过`step`命令执行后无法直接看到对应源码行的困扰？本文针对这一痛点，提供了一个实用的解决方案，显著提升调试效率。文章将深入解析JDB的`step`命令行为，通过实例演示默认情况下`step`命令的不足之处。重点介绍如何巧妙运用JDB的`list`命令，在单步执行过程中同步显示当前代码行，清晰追踪代码执行路径。掌握`list`命令，结合`stop at`、`run`、`step`等命令，即使在没有IDE的情况下，也能构建高效的Java命令行调试环境，快速定位并解决问题。

理解JDB的step行为

Java Debugger (JDB) 是一个命令行工具，用于调试Java应用程序。在进行单步调试时，我们通常期望在执行step命令后，不仅能看到程序输出，还能同步显示当前即将执行的源代码行，以便更好地理解程序流程。然而，JDB的step命令默认行为是执行下一行代码并报告完成，但它并不会自动打印出当前或下一行的源代码内容。这与许多集成开发环境（IDE）中的调试器体验有所不同，可能导致初学者感到困惑，难以直观地追踪代码执行。

问题示例与复现

为了更好地说明这个问题，我们使用以下简单的Java代码：

// Main.java
public class Main {
    public static void main(String[] args) {
        System.out.println("Hello world!");       // Line 3
        System.out.println("Hello world! line 2"); // Line 4
        System.out.println("Hello world! line 3"); // Line 5
    }
}

首先，我们需要使用javac -g命令编译此文件，以确保生成的.class文件中包含调试信息（如行号和局部变量信息），这是JDB正常工作的前提。

javac -g Main.java

接下来，我们启动JDB并尝试进行调试：

# 启动JDB
$ jdb Main
Initializing jdb ...
> stop at Main.main
Deferring breakpoint Main.main.
It will be set after the class is loaded.
> run
run Main
Set uncaught java.lang.Throwable
Set deferred uncaught java.lang.Throwable
>
VM Started: Set deferred breakpoint Main.main

Breakpoint hit: "thread=main", Main.main(), line=3 bci=0

main[1] step
> Hell
Step completed: o world!
"thread=main", Main.main(), line=4 bci=8

main[1] step
> Hello world! line 2

Step completed: "thread=main", Main.main(), line=5 bci=16

main[1]

从上述输出可以看到，在执行step命令后，JDB确实报告了当前线程、方法和行号（例如line=4或line=5），并且程序输出了System.out.println的内容。但是，它并没有像期望的那样直接显示源代码行，例如4 System.out.println("Hello world! line 2");。这使得在复杂代码中定位当前执行位置变得不便。

解决方案：list命令的使用

JDB提供了list命令，专门用于在调试过程中查看源代码。当你在某个断点或单步执行后需要查看当前位置的源代码时，list命令就派上用场了。

list命令的基本用法

• list: 显示当前执行位置周围的源代码行。默认会显示当前行以及前后几行（通常是5-10行）。
• list : 显示指定行号周围的源代码。
• list ,: 显示从start_line到end_line范围内的源代码。

结合step和list进行调试

让我们在之前的调试会话中加入list命令，以获得更好的调试体验：

# 继续之前的JDB会话
main[1] step
> Hell
Step completed: o world!
"thread=main", Main.main(), line=4 bci=8

# 在执行step后，立即使用list查看当前代码行
main[1] list
4       System.out.println("Hello world! line 2");
5       System.out.println("Hello world! line 3");
6   }
7}

main[1] step
> Hello world! line 2

Step completed: "thread=main", Main.main(), line=5 bci=16

# 再次使用list查看当前代码行
main[1] list
2   public class Main {
3       public static void main(String[] args) {
4           System.out.println("Hello world! line 2");
5           System.out.println("Hello world! line 3");
6       }
7   }

通过在每次step之后输入list命令，我们就能清晰地看到当前执行到的源代码行，这极大地弥补了step命令默认不显示源代码的不足，使得JDB调试过程更加直观和高效。

完整调试流程示例

以下是一个结合了stop at、run、step和list的完整JDB调试流程示例：

# 假设 Main.java 已经编译为 Main.class (包含调试信息)

# 1. 启动 JDB
$ jdb Main
Initializing jdb ...

# 2. 设置断点在 main 方法的入口
> stop at Main.main
Deferring breakpoint Main.main.
It will be set after the class is loaded.

# 3. 运行程序
> run
run Main
Set uncaught java.lang.Throwable
Set deferred uncaught java.lang.Throwable
>
VM Started: Set deferred breakpoint Main.main

Breakpoint hit: "thread=main", Main.main(), line=3 bci=0

# 4. 断点命中后，查看当前代码
main[1] list
1   public class Main {
2       public static void main(String[] args) {
3           System.out.println("Hello world!");
4           System.out.println("Hello world! line 2");
5           System.out.println("Hello world! line 3");
6       }
7   }

# 5. 单步执行下一行
main[1] step
> Hell
Step completed: o world!
"thread=main", Main.main(), line=4 bci=8

# 6. 再次查看当前代码行
main[1] list
2   public class Main {
3       public static void main(String[] args) {
4           System.out.println("Hello world! line 2");
5           System.out.println("Hello world! line 3");
6       }
7   }

# 7. 继续单步执行
main[1] step
> Hello world! line 2

Step completed: "thread=main", Main.main(), line=5 bci=16

# 8. 再次查看当前代码行
main[1] list
2   public class Main {
3       public static void main(String[] args) {
4           System.out.println("Hello world! line 2");
5           System.out.println("Hello world! line 3");
6       }
7   }

# 9. 退出 JDB
main[1] exit

注意事项与最佳实践

1. 编译时包含调试信息：务必使用javac -g命令编译Java源文件，否则JDB将无法获取行号、局部变量等调试信息，list命令也无法正常显示源代码。
2. list命令的灵活性：除了查看当前位置，你还可以使用list <行号>或list <起始行>,<结束行>来查看代码的特定部分，这在需要回顾上下文或跳转查看其他方法时非常有用。
3. 结合其他JDB命令：list命令与step、next（步过）、print（打印变量值）、locals（显示局部变量）等命令结合使用，可以构建一个强大的命令行调试环境。
4. 源代码文件位置：确保JDB在启动时能够访问到你的Java源代码文件。通常情况下，只要在编译和运行的同一目录下，JDB就能找到。
5. JDB版本：虽然list命令是JDB的基本功能，但在极少数情况下，非常老旧的JDB版本可能存在一些限制。但对于现代JDK版本，list命令的行为是稳定且一致的。

总结

尽管JDB的step命令默认不显示源代码行，但通过巧妙地结合使用list命令，开发者可以轻松地在命令行环境中实现直观的源代码追踪。掌握list命令的使用是提升JDB调试效率的关键技巧之一，它使得在没有图形界面的情况下进行Java程序调试变得更加可行和高效。

以上就是《Java调试技巧：step显示源码行方法》的详细内容，更多关于的资料请关注golang学习网公众号！