Java应用程序远程调试

1. 概述

在不止一种情况下，调试远程 Java 应用程序会很方便。 在本教程中，我们将了解如何使用 JDK 的工具来做到这一点。

2. 申请

让我们从编写一个应用程序开始。我们将在远程位置运行它并通过本文在本地调试它：

public class OurApplication {
    private static String staticString = "Static String";
    private String instanceString;
    public static void main(String[] args) {
        for (int i = 0; i < 1_000_000_000; i++) {
            OurApplication app = new OurApplication(i);
            System.out.println(app.instanceString);
        }
    }
    public OurApplication(int index) {
        this.instanceString = buildInstanceString(index);
    }
    public String buildInstanceString(int number) {
        return number + ". Instance String !";
    }
}

3. JDWP：Java Debug Wire 协议

Java Debug Wire Protocol 是 Java 中用于调试器和调试器之间通信的协议。被调试者是被调试的应用程序，而调试器是连接到被调试应用程序的应用程序或进程。

这两个应用程序要么在同一台机器上运行，要么在不同的机器上运行。我们将专注于后者。

3.1. JDWP 的选项

启动调试对象应用程序时，我们将在 JVM 命令行参数中使用 JDWP。 它的调用需要一个选项列表：

• transport是唯一完全需要的选项。它定义了要使用的传输机制。dt_shmem仅适用于 Windows，并且如果两个进程都在同一台机器上运行，而dt_socket与所有平台兼容并允许进程在不同的机器上运行**
• server不是强制选项。此标志打开时，定义它附加到调试器的方式。它要么通过地址选项中定义的地址公开进程。否则，JDWP 会公开一个默认值
• pause定义JVM是否应该暂停并等待调试器附加或不
• address是包含地址的选项，通常是一个端口，由调试器公开。它还可以表示翻译为字符串的地址（如javadebug，如果我们在 Windows 上使用server=y而不提供address）

3.2. 启动命令

让我们从启动远程应用程序开始。我们将提供前面列出的所有选项：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000 OurApplication

在 Java 5 之前，JVM 参数runjdwp必须与其他选项**debug一起使用：

java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000

这种使用 JDWP 的方式仍然受支持，但在未来的版本中将被删除。如果可能，我们会更喜欢使用较新的符号。

3.3. 从 Java 9 开始

最后，随着 Java 版本 9 的发布，JDWP 的选项之一发生了变化。这是一个很小的更改，因为它只涉及一个选项，但如果我们尝试调试远程应用程序，它会有所作为。

此更改会影响远程应用程序的address行为方式。旧的表示法address=8000仅适用于localhost。为了实现旧的行为，我们将使用带有冒号的星号作为地址的前缀（例如address=*:8000）。

根据文档，这是不安全的，建议尽可能指定调试器的 IP 地址：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=127.0.0.1:8000

4. JDB：Java 调试器

JDB，即 Java 调试器，是 JDK 中包含的一个工具，旨在从命令行提供一个方便的调试器客户端。

要启动 JDB，我们将使用attach模式。此模式将 JDB 附加到正在运行的 JVM。存在其他运行模式，例如listen或run，但在调试本地运行的应用程序时最方便：

jdb -attach 127.0.0.1:8000
> Initializing jdb ...

4.1. 断点

让我们继续在第 1 节中介绍的应用程序中放置一些断点。 我们将在构造函数上设置断点：

> stop in OurApplication.<init>

我们将在静态方法main中设置另一个，使用String类的完全限定名称：

> stop in OurApplication.main(java.lang.String[])

最后，我们将在实例方法buildInstanceString上设置最后一个：

> stop in OurApplication.buildInstanceString(int)

我们现在应该注意到服务器应用程序停止并且在我们的调试器控制台中打印以下内容：

> Breakpoint hit: "thread=main", OurApplication.<init>(), line=11 bci=0

现在让我们在特定行上添加一个断点，即打印变量app.instanceString的行：

> stop at OurApplication:7

我们注意到at在stop之后使用，而不是at特定行上定义断点时使用。

4.2. 导航和评估

现在我们已经设置了断点，让我们使用cont继续执行我们的线程，直到我们到达第 7 行的断点。

我们应该在控制台中看到以下内容：

> Breakpoint hit: "thread=main", OurApplication.main(), line=7 bci=17

提醒一下，我们已经停在包含以下代码的行：

System.out.println(app.instanceString);

也可以通过在main方法上停止并键入step两次来完成在此行上的停止。step执行当前代码行并直接在下一行停止调试器。 现在我们已经停止了，被调试者正在评估我们的staticString、应用程序的instanceString、局部变量i，最后看看如何评估其他表达式。

让我们将staticField打印到控制台：

> eval OurApplication.staticString
OurApplication.staticString = "Static String"

我们明确地将类的名称放在静态字段之前。 现在让我们打印app的实例字段：

> eval app.instanceString
app.instanceString = "68741. Instance String !"

接下来，让我们看看变量i：

> print i
i = 68741

与其他变量不同，局部变量不需要指定类或实例。我们还可以看到print具有与eval完全相同的行为：它们都计算表达式或变量。

我们将评估OurApplication的一个新实例，我们已为其传递了一个整数作为构造函数参数：

> print new OurApplication(10).instanceString
new OurApplication(10).instanceString = "10. Instance String !"

现在我们已经评估了所有需要的变量，我们想要删除之前设置的断点，让线程继续处理。为此，我们将使用命令clear后跟断点的标识符。

该标识符与之前使用命令stop的标识符完全相同：

> clear OurApplication:7
Removed: breakpoint OurApplication:7

为了验证断点是否被正确删除，我们将使用不带参数的clear。这将显示现有断点列表，而没有我们刚刚删除的断点：

> clear
Breakpoints set:
        breakpoint OurApplication.<init>
        breakpoint OurApplication.buildInstanceString(int)
        breakpoint OurApplication.main(java.lang.String[])