1.为什么要远程联调?
当我们的代码在线/测试环境运行异常时,需要定位问题时,以前的传统做法是检查异常日志,根据日志定位错误代码,然后根据相关参数和异常信息推断。然而,许多异常问题需要更详细地解决debug
只有这样,我们才能更准确地定位和解决它。在这种情况下,我们希望能像本地调试一样进行调试debug
在线/测试环境代码,可以大大提高bug
修复效率。IDEA
远程调试为我们调试远程主机上的程序提供了的解决方案,如运行本地代码BUG
或代码执行过程。
2.远程联调原理
建立本地和服务器端socket连接监控,当客户端访问服务器时,服务器端会先询问当地情况idea是否有断点,如果会停在当前断点,如果没有,返回客户端。
2.1、理论基础
JPDA(Java Platform Debugger Architecture
是Java平台调试系统结构的缩写。由三个规范组成,即JVMTI(JVM Tool Interface)
,JDWP(Java Debug Wire Protocol)
,JDI(Java Debug Interface)
。
JVMTI
定义了包括调试信息在内的虚拟机应提供的调试服务(Information
如栈信息)、调试行为(Action
例如,在客户端设置断点和通知(Notification
例如,当客户端到达一个断点时,接口由虚拟机实现者提供,并与虚拟机相结合- JDWP调试服务服务与调试器之间的通信,包括定义调试信息格式和调试请求机制
- JDI调试人员可以在语言的高层次上定义调试界面,以便于与远程调试服务交互,Java调试器实现者可以直接使用该接口访问虚拟机调试服务。
2.2.远程调试分类
- 主动连接调试:监控端口配置在服务端,本地IDE连接远程监听端口进行调试,一般调试问题用这种方式;
- 被动连接调试:本地IDE监控一个端口,等待远程连接到当地端口。一般不能用于远程服务启动,启动时连接到当地调试分析。
3.主动连接调试
3.打开远程服务debug服务
3.1.1、SpringBoot项目
# 在命令行中添加选项并重新启动。注意新参数 -jar 之前 java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005 -jar springbootfirst.jar
3.1.2、tomcat
# 在启动脚本中添加选项并重启 ## 方法1、sudo vim $CATALINA_HOME/bin/catalina.sh JAVA_OPTS="$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005" ## 方法2、使用sed命令 sed -i '$a\JAVA_OPTS=\"$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=8000\"' /opt/huawei/fce/apps/platform/bin/setenv.sh
3.2、IDEA中指定Debug服务器
- 点击主窗口菜单
Run / Edit Configurations
,打开Run/Debug Configurations
窗口; - 在工具栏上点击 在下拉菜单中选择按钮
Remote
; - 设置
Host
域名为远程服务器或IP
,保持Port=5005
无需调整; Use module classpath
程序模块名称配置;Command line arguments for remote JVM
配置:配置Debug远程服务命令行启动参数,- 形如
-Xdebug -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
,参数说明如下:- JVM在DEBUG在模式下工作;
- jvm本地装载参数lib包;其中libname默认搜索路径为环境变量
PATH
中的路径,options
为了在本地库启动时传递参数,多个参数用逗号分隔 -
Java Debug Wire Protocol
的缩写; - 用于在调试程序和VM使用过程之间的通信;
- 套接字传输;
-
VM
是否需要作为调试服务器执行; - 是否在调试客户端建立连接后启动
VM
; - 调试服务器监听的端口号。
3.3.远程服务器防火墙端口放行
# 1、直接关闭防火墙 systemctl stop firewalld.service # 2.打开端口并重新启动 firewall-cmd --zone=public --add-port=80/tcp --permanent firewall-cmd --reload
3.4、重启服务
4.被动连接调试
首先需要IDEA
配置监控,如主动连接调试IDEA
配置图片,Debugger mode
选择:
Debug
开始等待远程连接调试。
4.1、Tomcat
# 配置远程服务启动脚本
JAVA_OPTS="$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:5005,suspend=y"
4.2、Spring Boot
参数含义和主动连接调试一样,只是这里suspend=y
表示启动时就中断,需要连接本地IDE调试启动。address=ip:port
,ip需要修改为本地的对外IP
。
# 命令行添加选项,并重启,注意新参数必须在 -jar 之前
java -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:5005,suspend=y -jar springbootfirst.jar
5、开始调试
- 要求:双方代码一致,否则远程调试无法启动;
- 本地启动刚刚配置的
Remote Server
,正常时会看到日志:Connected to the target VM, address: 'xxx:5005', transport: 'socket'
- 本地
IDEA
代码中设置断点 - 浏览器或手机
HTTP
访问服务器 - IDEA 即可在断点暂停并跟踪
6、关闭调试
- 服务器上多开放个端口是不安全的,调试完毕后可恢复防火墙设置。
- Java 服务器关闭
Debug
服务器的功能,因为debug
会影响性能。