我们在使用 IDEA DEBUG调试代码的时候,常常见到控制台会输出一句这样的话:「Connected to the target VM, address: '127.0.0.1:62981', transport: 'socket'」,所以即使代码不在本地运行,只要JVM打开调试模式,并且网络能够用过 socket 连接到JVM,使用 Debug 协议通过 Socket 通信就可以传递调试指令和调试信息。
IDEA配置启动环境(远程Debug服务器)
打开Intellij IDEA,在顶部靠右的地方选择”Edit Configurations”,进去之后点击左上角的+号,选择”Remote”,见下图,其中Name填写名称,可以随便起一个名字,host是你要远程调试代码的机器ip/hostname,port是调试监听端口,如果远端服务器已经开启了远程调试端口就填远程端口,如果没开,那么先选默认的5005端口,Use Module classpath 是选择远程运行的代码模块是哪个模块下的。
在Command line arguments for remote JVM,右侧选择JDK版本,这个是根据你远程服务器上运行的JDK版本选的,我这里选择 JDK5-8,就会给你一条命令,我这里得到的是:
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005
这条命令就是启动远程调试的命令,有好奇的同学,咱们解释一下什么意思:
- jdwp是Java Debug Wire Protocol的缩写
- transport:有两种形式,分别是socket和shared memory,需要跨机器,只能用socket;
- server:JVM是否需要作为调试服务器执行
- suspend:是否调试客户端建立连接之后启动虚拟机。如果是y,则需要等调试端机器上的debugger开启后,程序才会开始运行。否则,程序启动时候不会挂起,直接运行。
- address:监听端口5005作为调试端口
服务端调试环境
Jar包方式启动的程序
以Jar包方式启动的程序,例如SpringBoot,可以在启动的时候添加这个命令,例如:
java -jar -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 web.jar
Tomcat(war包)项目
以Tomcat(war包)运行的项目需要修改Tomcat启动脚本,Linux 的是 catalina.sh,Windows 的是 catalina.bat,将这个命令添加进去:
JAVA_OPTS="$JAVA_OPTS -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005"
服务器端的JVM参数添加好,等到程序启动,你就可以开始运行你电脑上的DEBUG了。如果连接失败,记得检查网络防火墙是否放行了端口。
探究原理
核心是JPDA(Java Platform Debugger Architecture)框架。IBM有非常详细的介绍:
- https://www.ibm.com/developerworks/cn/java/j-lo-jpda1/
- https://www.ibm.com/developerworks/cn/java/j-lo-jpda2/
- https://www.ibm.com/developerworks/cn/java/j-lo-jpda3/
- https://www.ibm.com/developerworks/cn/java/j-lo-jpda4/
关键摘抄如下:
- JPDA是JVM的调试标准,任何JDK都必须实现。
- 调试Java程序,本质是向JVM请求当前状态。这需要对JVM发送一定指令,设置一定回调。
- JPDA的三个层次:Java 虚拟机工具接口(JVMTI),Java 调试线协议(JDWP)以及 Java 调试接口(JDI)。它们之间的角色图:
- JVMTI(Java Virtual Machine Tool Interface):通向JVM的native的接口,处于体系最底层。所有的调试功能都需要该接口提供。是debug和profiler的接口,是线程分析、监听和代码覆盖率检查的基础。会有个紧耦合的Agent来实现JVMTI。该Agent的加载时间是出于JVM初始化早期或者运行时加载(对应于上文中的suspend参数)。
- JDWP(Java Debug Wire Protocol):交互的通讯协议。定义了交互中的命令、回应数据和错误代码。不包含传输层具体实现。主要分为握手和应答两个阶段。
- JDI(Java Debug Interface):对JDWP进行解析,为JDWP提供队列、缓存等服务。分为数据模块,将虚拟机上的所有数据、状态映射为Java的数据对象;链接模块,调试器向虚拟机发起链接,以获得各种状态,分为主动和被动形式。事件请求和处理模块。
- 由于JVM神一般的存在,使得Java的运行是先天可控的,因此其调试程序的开发,也远容易与C++。
- 类似工具:Apache harmony