IDEA远程调试

大家好，欢迎来到IT知识分享网。

注意事项： 进行远程调试时，非常重要的一点是必须确保本地代码和线上代码的版本完全一致。如果版本不一致，断点可能无法正确触发，从而导致调试失败。

添加一个用于远程调试的接口

添加一个简单的REST控制器，用于触发调试点。例如：

@RestController @RequestMapping("/Demo") public class RemoteDebugController { @GetMapping("/exec") public String exec(@RequestParam String param){ System.out.println(param); param = param + param; return param; } } #提供了一个简单的方法来触发调试，并检查传递的参数。

将代码打成jar包

使用Maven或类似工具将应用打包，确保所有依赖都正确包含。

mvn clean package

生成一个jar包，排除了测试代码，准备用于部署。

IDEA设置远程调试启动项

在IntelliJ IDEA中设置远程调试配置：

• 打开 Run -> Edit Configurations
• 点击左上角的+添加一个新的配置，选择Remote
• 配置名称和远程连接设置（端口、主机等）

部署好远程应用并设置完IDEA后，就可以启动远程调试会话。只要远程应用在运行，且调试端口被正确映射和开放，就可以在本地IDE中像处理本地应用一样调试远程应用

启动项目

以下是在终端窗口下启动测试项目的命令，确保使用了上述生成的JVM参数：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar demo-0.0.1-SNAPSHOT.jar

启动日志中出现Listening for transport dt_socket at address: 5005表明远程调试配置正确且已经启动监听。

进行调试

测试过程

jar包运行的控制台+IDEA的调试界面+postman模拟客户端请求

当客户端发起请求时，IDEA将自动进入断点。执行通过后，控制台将打印出相应的日志。

执行成功

注意： 在线上环境中进行调试时，务必给断点设置条件，例如只有特定测试账号才触发断点，以避免影响真实用户的请求和体验。

重要参数

Name

• 此参数为配置的名称，主要用于标识不同的远程调试配置，内容可以随意填写。

Host

• 指定远端服务所处的机器IP地址 在本地测试时，可以填写127.0.0.1 在实际应用中，应填写远端服务所处的真实IP地址。

Port

• 指定远端调试的端口，该端口将用于远程调试会话的连接。

远端服务运行时的JVM参数

这些参数由IDEA工具提供，需要在远程应用启动时加入到JVM启动参数中，以便开启远程调试功能。

-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 这个配置示例中，transport=dt_socket表示使用socket通信，server=y表示作为服务器监听，suspend=n表示启动时不暂停，address=5555指定监听端口。

-agentlib:jdwp

这是 JVM 的启动参数，表示使用 Java Debug Wire Protocol (JDWP) 进行调试。-agentlib 是一个通用选项，用于在 JVM 中加载本地库。jdwp 是 Java 调试接口的实现。

transport=dt_socket

• transport: 指定调试通信的传输机制
• dt_socket: 调试器通过 TCP/IP 套接字与目标 JVM 进行通信

server=y

• server: 指定 JVM 是以服务器模式还是客户端模式进行调试会话。
• y: 将 JVM 作为调试服务器运行。JVM 将监听一个指定的端口，等待调试器连接。

如果设置为 server=n，则表示 JVM 将作为客户端模式运行，需要调试器先启动，然后 JVM 连接到调试器。

suspend=n

• suspend: 指定 JVM 在启动时是否暂停等待调试器连接。
• n: JVM 启动后立即运行，不等待调试器连接。

如果设置为 suspend=y，JVM 将在启动时暂停，直到调试器连接并开始调试。这对于在应用程序初始化之前设置断点非常有用。

address=5555

• address: 指定 JVM 监听的地址或端口。
• 5555: 监听端口号为 5555。调试器连接到 JVM 所需的端口。

在服务器模式下，这表示 JVM 将在 TCP/IP 端口 5555 上监听调试器连接请求。如果是在客户端模式下（server=n），则表示调试器的主机名或 IP 地址和端口，JVM 将连接到这个地址。