IDEA远程调试

原创已于 2022-09-21 15:37:41 修改 · 1.3k 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#intellij-idea #java #ide

于 2022-07-14 14:31:39 首次发布

Java 专栏收录该内容

11 篇文章

订阅专栏

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

概述

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

build tar包

如果有太多警告，可以直接用命令行 gradle -x test clean build，这样不用 test了，build成功会生成***/build/libs/***.jar。

如果gradle出问题（比如都找不到gradle窗口或者gradle只有目录没有子目录），可以重新设置gradle user home[java环境配置：安装jdk和集成开发环境]，apply后就会出现gradle import页面，重新import一下。

如果命令出错，可以尝试直接点gradle窗口中的

上传tar包

专业版idea才能用上传jar包

Tools > HTTP Client > Test RESTful Web Service > 弹出窗口中点击顶部提示中的convert request to the new format

POST http://1.1.1.1:12345/load
Content-Type: multipart/form-data; boundary=WebAppBoundary

--WebAppBoundary
Content-Disposition: form-data; name="jarFile"; filename="scene_abc@***.jar"

< ./***/build/libs/common_scene@common_solution.jar
--WebAppBoundary--

注意修改端口和filename。

是否上传成功需要看“success”:true。

如果debug时断点没有打勾，也可能是jar包没上传成功

debug设置

2.1 IDEA 中指定 Debug 服务器
点击主窗口菜单 Run / Edit Configurations，打开“Run/Debug Configurations”窗口；
点击工具栏上的“+”按钮，下拉菜单中选择“Remote”；
设置 Host 为远程服务器的域名或IP（与jar包上传地址相同），设置Port，如5005；
会生成命令行参数形如 -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005

复制命令行参数

2.2 远程服务中开启 Debug 服务
2.2.1 对于 SpringBoot
命令行添加选项，并重启：

## 注意新参数必须在 -jar 之前
jar -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar test.jar
2.2.2 对于 Tomcat
启动脚本中添加选项，并重启：

## sudo vim $CATALINA_HOME/bin/catalina.sh
JAVA_OPTS="$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005"
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
3 开始调试
要求：双方代码一致，否则远程调试无法启动；
本地启动刚刚配置的 Remote Server，正常时会看到日志: Connected to the target VM, address: 'xxx:5005', transport: 'socket'
本地 IDEA 代码中设置断点
浏览器或手机 HTTP 访问服务器
IDEA 即可在断点暂停并跟踪
4 关闭调试
服务器上多开放个端口是不安全的，调试完毕后可恢复防火墙设置。
而 Java 服务器开启 Debug 服务器的功能可以保留，以便之后再次调试。