IntelliJ-IDEA远程调试

发表于 分类于

IDEA 远程调试，像运行本地代码一样调试远程主机上的程序，以排查远程程序的BUG或代码执行流程。

概述

原理：本机和远程主机的两个 VM 之间使用 Debug 协议通过 Socket 通信，传递调试指令和调试信息。 被调试程序的远程虚拟机：作为 Debug 服务端，监听 Debug 调试指令。jdwp是Java Debug Wire Protocol的缩写。 调试程序的本地虚拟机：IDEA 中配置的 Remote Server，指定 Debug 服务器的Host:Port，以供 Debug 客户端程序连接。

设置

IDEA 中指定 Debug 服务器

  • 点击主窗口菜单 Run -> Edit Configurations...，打开 Run/Debug Configurations 窗口；
  • 点击工具栏上的 + 按钮，下拉菜单中选择 Remote ；
  • 设置 Host 为远程服务器的域名或IP，保持 Port=5005 无需调整；
  • 选择 JDK 版本并复制命令行参数 Command line arguments for remote JVM， 形如 -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005，具体参数内容由 JDK 版本决定。

远程服务中开启 Debug 服务

对于 SpringBoot： 命令行添加选项，并重启：

1
2
# 注意新参数必须在 -jar 之前
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar test.jar

对于 Tomcat： 启动脚本中添加选项，并重启：

1
2
# sudo vim $CATALINA_HOME/bin/catalina.sh
JAVA_OPTS="$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005"

远程服务器防火墙端口放行

1
2
3
# sudo vim /etc/sysconfig/iptables
-A INPUT -m state --state NEW -m tcp -p tcp --dport 5005 -j ACCEPT
# 重启生效: sudo systemctl restart iptables

开始调试

  • 要求：双方代码一致，否则远程调试无法启动；
  • 本地启动刚刚配置的 Remote Server，正常时会看到日志: Connected to the target VM, address: 'localhost:5005', transport: 'socket'
  • 本地 IDEA 代码中设置断点
  • 浏览器或手机 HTTP 访问服务器
  • IDEA 即可在断点暂停并跟踪

关闭调试

服务器上多开放个端口是不安全的，调试完毕后可恢复防火墙设置。 而 Java 服务器开启 Debug 服务器的功能可以保留，以便之后再次调试。

IDEA 远程调试的细节

1、细节1：停在本地断点，关闭程序后会继续执行吗 如果远程调试在自己的断点处停下来了，此时关闭IDEA中的项目停止运行，则还会继续运行执行完剩下的逻辑吗？ 会的，这点比较不容易记住

以下面的代码为例，在第一行停住了。然后IDEA中停掉，发现停掉之后控制台还是打印了剩下的日志。 2、细节2：jar包代码和本地不一致会怎么样？ IDEA 里的代码如果不和jar包的一致，会怎么样。

结论：要保证和远程启动的代码一致。

否则你debug的时候的行数会对不上。报错抛异常倒是不会。像这种还是能对得上行数的

比如你调试test1方法，test2方法在test1下面，在test2里加代码，这样并不影响test1中的行号，这种是可以在调试的时候准确反应行号的 3、细节3：日志打印在哪里？ 日志不会打印在IDEA的控制台上。即System.out 以及 log.info 还是打印在远程的。

1
2
3
4
5
6
7
8
@GetMapping("/test1")
public String test1() {
    System.out.println("第一行");
    System.out.println("第二行");
    log.info("log 第一行");
    log.info("log 第二行");
    return "ok";
}

4、细节4：调试时其他人会不会卡住？ 远程调试的时候，打了断点，停住后会不会导致页面的请求卡住。 比如你使用远程调试，别的QA在测试这个页面，结果他们看到的结果是怎么样的？ 会卡住吗？会的，已经实际遇到过这种情况了。

5、细节5：本地代码修复bug远程调用的时候 如果在远程调试过程自己发现了bug，本地改好后重新启动IDEA里的项目，再到页面调用一次，能修复吗？ 不能，运行的还是远程部署的jar中的代码

这个直接击碎了远程页面点一点触发本地代码进行debug的梦想。如果可以的话那调试代码就方便太多。

6、细节6：当开发者计算机无权访问数据库时，可使用远程调试查看数据处理过程