远程debug调试java代码

该系列介绍一些java开发中常用的一些小技巧，多小呢，从不会到会只需要一篇文章这么小。这一篇介绍如何使用jdk自带的扩展包配合Intellij IDEA实现远程debug。

项目中经常会有出现这样的问题，会令程序员抓狂：关键代码段没有打印日志，本地环境正常生产环境却又问题…这时候，远程debug可能会启动作用。

1 准备用于debug的代码

准备一个RestController用于接收请求，最后可以通过本地断点验证是否成功开启了远程debug

1 2 3 4 5 6 7 8 9 10 11 12 13

@RestController public class TestController {     @RequestMapping("/test")     public Integer test() {         int i = 0;         i++;         i++;         i++;         i++;         i++;         return i;     } }

项目使用springboot和maven构建，依赖就省略了，使用springboot提供的maven打包插件，方便我们打包成可运行的jar。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

<build>     <plugins>         <plugin>             <groupId>org.springframework.boot</groupId>             <artifactId>spring-boot-maven-plugin</artifactId>             <configuration>                 <executable>true</executable>             </configuration>         </plugin>         <plugin>             <artifactId>maven-compiler-plugin</artifactId>             <configuration>                 <source>1.8</source>                 <target>1.8</target>             </configuration>         </plugin>     </plugins> </build>

2 使用maven插件打包成jar

3 准备启动脚本

1	java -jar -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=64057 remote-debug-1.0-SNAPSHOT.jar

1. 使用java -jar的方式启动程序，并且添加了一串特殊的参数，这是我们能够开启远程debug的关键，以-开头的参数是jvm的标准启动参数，关于jvm启动参数相关的知识可以先去其他博客了解。
2. -agentlib:libname[=options], 用于装载本地lib包。在这条指令中便是加载了jdwp(Java Debug Wire Protocol)这个用于远程调试java的扩展包。而transport=dt_socket,server=y,suspend=n,address=64057这些便是jdwp装载时的定制参数，详细的参数作用可以搜索jdwp进行了解。我们需要关心的只有address=64057这个参数选项，本地调试程序使用64057端口与其通信，从而远程调试。

4 配置IDEA

1. 与脚本中的指令完全一致
2. 远程jar包运行的host，由于我的jar运行在本地，所以使用的是localhost，一般线上环境自然是修改为线上的地址
3. 与远程jar包进行交互的端口号，idea会根据指令自动帮我们输入
4. 选择与远程jar包一致的本地代码

请务必保证远程jar包的代码与本地代码一致！！！

5 验证

保存第4步的配置后，先执行脚本让远程的jar包跑起来，再在IDEA中运行remote-debug

如上便代表连接运行成功了

在本地打上断点，访问localhost:8080/test

可以在本地看到堆栈信息，大功告成。一行指令便完成了远程调试。

 

远程调试

远程调试分为主动连接调试，和被动连接调试。这里以Eclipse为例。

主动连接调试：服务端配置监控端口，本地IDE连接远程监听端口进行调试，一般调试问题用这种方式。

被动连接调试：本地IDE监听某端口，等待远程连接本地端口。一般用于远程服务启动不了，启动时连接到本地调试分析。

 

主动连接调试

首先需要远程服务配置启动脚本:

JAVA_OPTS="$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000"

如果是启动jar包，指令：

java -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=8000 -jar test.jar  

这里-Xdebug是通知JVM工作在DEBUG模式下，-Xrunjdwp是通知JVM使用(java debug wire protocol)来运行调试环境。transport是监听Socket端口连接方式（也可以dt_shmem共享内存方式，但限于windows机器，并且服务提供端和调试端只能位于同一台机）。server=y表示当前是调试服务端，=n表示当前是调试客户端。suspend=n表示启动时不中断（如果启动时中断，一般用于调试启动不了的问题）。address=8000表示本地监听8000端口。

远程服务（tomcat/jboss）启动成功后，本地Eclipse对需要调试的地方打上断点，然后项目右键启动远程调试：Debug as->Debug Configurations->Remote Java Application。Host为远程主机IP，Port为远程监听调试端口，Connection Type为：Standard(Socket Attach)，如图：

点击Debug，然后打断点，远程服务运行到断点处本地就会中断，然后进行调试。

 

被动连接调试

首先需要Eclipse配置监听，如主动连接调试的Eclipse配置图片，Connection Type选择：Standard(Socket Listen)，配置本地监听端口，比如默认8000。点击Debug开始等待远程连接调试。

然后配置远程服务启动脚本：

JAVA_OPTS="$JAVA_OPTS -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,suspend=y"

如果是调试jar包，指令：

java -Xdebug -Xrunjdwp:transport=dt_socket,address=127.0.0.1:8000,suspend=y -jar remoting-debug.jar

参数含义和主动连接调试一样，只是这里suspend=y表示启动时就中断，需要连接本地IDE调试启动。address=ip:port，ip需要修改为本地的对外IP。

这样远程项目启动时就连接到本地，方便调试项目启动不了的问题。

 

更多参数细节：

-XDebug               启用调试。
-Xnoagent             禁用默认sun.tools.debug调试器。
-Djava.compiler=NONE  禁止 JIT 编译器的加载。
-Xrunjdwp             加载JDWP的JPDA参考执行实例。
transport             用于在调试程序和 VM 使用的进程之间通讯。
dt_socket             套接字传输。
dt_shmem              共享内存传输，仅限于 Windows。
server=y/n            VM 是否需要作为调试服务器执行。
address=3999          调试服务器的端口号，客户端用来连接服务器的端口号。
suspend=y/n           是否在调试客户端建立连接之后启动 VM 。