靠！我被项目经理和同事嘲笑了，因为不会远程debug调试...

￡神魔★判官ぃ 2021-09-08 08:40 242阅读 0赞

> 大家好，我是曹尼玛，刚从培训机构毕业，去一家单位上班一周了…  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70]  
> 这一周项目经理让我熟悉了项目业务，架构和设计，不算难，凭借我培训机构第一名的成绩，还是很顺溜。  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 1]  
> 今天项目经理把同事们叫到一起，说线上438x6项目出现奇葩问题，但是开发环境初步测试没问题，需要配合测试部的小姐姐们在测试环境远程debug跟踪下，排查下问题，以及正式环境日志也会提供，重现下问题，解决下bug；  
> ![在这里插入图片描述][20210615001319168.png]  
> 项目经理见我这几天比较悠闲  
> 所以就对我说，“曹尼玛，这个小任务就交给你了”  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 2]  
> “我，我，我，我不会远程debug，没听过什么是远程debug”；  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 3]  
> 我看到同事都忍不住笑出来了，项目经理也鄙视的笑了。  
> 哎，培训机构只教了debug本地调试，何况还没练熟呢，远程debug都没听过。  
> 后来散会，项目经理单独找我训话；  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 4]  
> “简历2年开发经验，远程debug都不会，你是干什么吃的，明天下班前把bug找到，否则直接滚蛋”  
> ![在这里插入图片描述][20210615002618723.gif_pic_center]  
> 靠，包装简历和经验，露馅了  
> 赶紧学吧，加班熬夜学习了下，第二天上午通过远程debug，配合线上日志，最终找到了问题；  
> 顺便总结了下，写了篇远程debug调试文章分享给大家，以及录制了一个远程debug视频教程；希望大家早日学会，不要被他人嘲笑和鄙视！

这里正式开始笔记内容；**文末附上视频教程下载地址（白嫖0积分下载）**

## 1，远程DEBUG的必要性 ##

--------------------

由于部署环境的差异性，相信很多朋友都碰到过开发环境正常测试过的功能在测试环境甚至生产环境下出现bug的情况。一般情况下，生产环境可以采取的手段比较单一，即通过日志的方式获取运行中的环境上下文，分析日志文件并尝试重现bug。这会带来的问题还是不少的，首先，日志的分析是一项比较耗时的工作；其次，现有的日志记录不一定能反映出问题，你可能需要多次重复这个过程(分析日志->猜测问题->加日志->部署->获取日志)来慢慢逼近问题。倘若是测试环境，我们还多了一项可供选择的手段——远程调试——将程序在测试环境中以debug模式启动，在本机使用IDEA在工程中设置断点进行调试。

## 2，IDEA构建SpringBoot测试Demo ##

--------------------

新建SpringBoot测试项目remote-debug，只需要web依赖支持即可；版本选用2.2.6.RELEASE（注意，别用2.5.1版本，有坑，亲测）

pom.xml：

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    	<modelVersion>4.0.0</modelVersion>
    	<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.2.6.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.java1234</groupId>
    	<artifactId>remote-debug</artifactId>
    	<version>v1.0</version>
    	<name>remote-debug</name>
    	<description>Demo project for Spring Boot</description>
    	<properties>
    		<java.version>1.8</java.version>
    	</properties>
    	<dependencies>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
    		</dependency>
    	</dependencies>
    
    	<build>
    		<plugins>
    			<plugin>
    				<groupId>org.springframework.boot</groupId>
    				<artifactId>spring-boot-maven-plugin</artifactId>
    			</plugin>
    		</plugins>
    	</build>
    
    </project>

application.yml:

server:
      port: 80
      servlet:
        context-path: /
      tomcat:
        uri-encoding: utf-8

简单搞个TestController，提供一个Rest接口

package com.java1234.controller;
    
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * @author java1234_小锋 * @site www.java1234.com * @company Java知识分享网 * @create 2021-06-12 15:37 */
    @RestController
    public class TestController { 
    
        @PostMapping("/test")
        public String test(Integer id,String name){ 
            System.out.println("id="+id);
            System.out.println("name="+name);
            if(id>0){ 
                return "success "+name;
            }else{ 
                return "fail";
            }
        }
    
    }

我们启动项目，用postman测试下：

测试接口：http://localhost/test 加入Body form-data 参数 id=1，name=marry，Send 测试，返回 success marry，测试OK；

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qPf6tyol-1623688298210)(image-20210613222730931.png)\]][img-qPf6tyol-1623688298210_image-20210613222730931.png]

## 3，测试Demo项目配置支持远程调试 ##

--------------------

pom.xml里配置jvmArguments参数 -Xdebug -Xrunjdwp:transport=dt\_socket,address=5005,server=y,suspend=n：

<build>
    	<plugins>
    		<plugin>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-maven-plugin</artifactId>
    			<configuration>
    				<jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n</jvmArguments>
    			</configuration>
    		</plugin>
    	</plugins>
    </build>

加了此配置后，打包后的项目发布服务器，可支持远程DEBUG；

具体参数详解：

**-Xdebug** 通知JVM工作在DEBUG模式下；

**-Xrunjdwp** 通知JVM使用(Java debug wire protocol)运行调试环境。该参数同时包含了一系列的调试选项；

\*\*transport \*\*指定了调试数据的传送方式，dt\_socket是指用SOCKET模式，另有dt\_shmem指用共享内存方式，其中，dt\_shmem只适用于Windows平台；

**address** 调试服务器的端口号，客户端用来连接服务器的端口号；

**server=y/n** VM 是否需要作为调试服务器执行；

**suspend=y/n** 是否在调试客户端建立连接之后启动 VM；

## 4，IDEA打包jar ##

--------------------

我们打包jar包；

右侧Maven工具，双击 package打包工具；

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3t35X1S1-1623688298215)(image-20210613224738500.png)\]][img-3t35X1S1-1623688298215_image-20210613224738500.png]

一般打包跳过test，可以点击箭头所指闪电图标，这样打包速度会快很多；

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gjGv5k7R-1623688298218)(image-20210613224828589.png)\]][img-gjGv5k7R-1623688298218_image-20210613224828589.png]

打包后，在target目录下，会生成一个jar包；我们把它复制出来即可；

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-K5FN6ULx-1623688298222)(image-20210613224918420.png)\]][img-K5FN6ULx-1623688298222_image-20210613224918420.png]

## 5，启动jar并且带启动参数支持远程调试 ##

--------------------

我们把`remote-debug-v1.0.jar`放D盘根目录；

我们启动jar，并且支持远程DEBUG；

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar remote-debug-v1.0.jar

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-RERGHClm-1623688298225)(image-20210613225414441.png)\]][img-RERGHClm-1623688298225_image-20210613225414441.png]

启动OK，监听socket 5005端口

## 6，IDEA远程DEBUG配置 ##

--------------------

IDEA要进行远程DEBUG，需要进行配置；

1，启动项下拉，选择 `Edit Configurations...`编辑配置  
![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3UGDXNMD-1623688298228)(image-20210613225801811.png)\]][img-3UGDXNMD-1623688298228_image-20210613225801811.png]

2，点击`+`，选择`Remote`，添加远程DEBUG配置  
![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-3rzwtdYm-1623688298229)(image-20210613230023399.png)\]][img-3rzwtdYm-1623688298229_image-20210613230023399.png]

3，添加远程DEBUG配置项，Host和Port，配置后，点击`Apply`和`OK`按钮

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-l0edF9KU-1623688298231)(image-20210613230200362.png)\]][img-l0edF9KU-1623688298231_image-20210613230200362.png]

## 7，IDEA远程DEBUG测试 ##

--------------------

1，打测试断点

我们直接在TestController类里的test方法上打点断；

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2MqDENbp-1623688298232)(image-20210613230809384.png)\]][img-2MqDENbp-1623688298232_image-20210613230809384.png]

2，选择远程debug启动项，然后点击测试调试按钮启动；  
![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HWmN2f6b-1623688298234)(image-20210613230646749.png)\]][img-HWmN2f6b-1623688298234_image-20210613230646749.png]

3，postman测试

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-VJrvld2D-1623688298236)(image-20210613231151240.png)\]][img-VJrvld2D-1623688298236_image-20210613231151240.png]

4，成功进入断点

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-BeCKrJS3-1623688298238)(image-20210613231235544.png)\]][img-BeCKrJS3-1623688298238_image-20210613231235544.png]

我们走完断点；

5，启动的jar包打印信息，测试OK

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-waIbt2vf-1623688298241)(image-20210613231336792.png)\]][img-waIbt2vf-1623688298241_image-20210613231336792.png]

## 8，eclipse远程DEBUG实现 ##

--------------------

1，右击项目 -> Debug As -> Debug Configurations…

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-NCIa03JQ-1623688298243)(image-20210613232154571.png)\]][img-NCIa03JQ-1623688298243_image-20210613232154571.png]

2，找到 `Remote Java Application` 然后右击 `New`

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-o1TZdUQg-1623688298245)(image-20210613232409021.png)\]][img-o1TZdUQg-1623688298245_image-20210613232409021.png]

3，配置`Host`和`Port`，点击`Debug`按钮，即可实现远程DEBUG

![\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-pDNULzPO-1623688298248)(image-20210613232629335.png)\]][img-pDNULzPO-1623688298248_image-20210613232629335.png]

## 9，打war包方式配置远程DEBUG ##

--------------------

如果打的是war包，需要两个步骤：

1.  将 web 应用部署到 Tomcat 的 webapp 目录下
2.  修改 Tomcat/bin/startup.bat 文件，在最前面加上如下代码：
    
    SET CATALINA\_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt\_socket,server=y,suspend=n,address=5005

## 10，远程debug视频教程+文档+源码下载 ##

链接：[https://pan.baidu.com/s/1Xd75eAOXcvAnBax7VFsnjQ][https_pan.baidu.com_s_1Xd75eAOXcvAnBax7VFsnjQ]  
提取码：**1234**

假如链接失效，请加锋哥WX： java3459

> 微信搜一搜【java1234】关注这个放荡不羁的程序员，关注后回复【资料】有我准备的一线大厂笔试面试资料以及简历模板。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70]: /images/20210901/59afbd43364d4f8f8d4d60895c3f691f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 1]: /images/20210901/d6b386d6dcc8443baab41672fa564ef9.png
[20210615001319168.png]: /images/20210901/c37ddd56afd14157a2833ffff6d427b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 2]: /images/20210901/ef22da95a1ca4f169075cf1f2ebe7d97.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 3]: /images/20210901/75e4821aa06341088bbd605d1cec0173.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2Nhb2xpMjAxMzE0_size_16_color_FFFFFF_t_70 4]: /images/20210901/468534f20be14c26b070eff2e758fc00.png
[20210615002618723.gif_pic_center]: /images/20210901/5dddd28cc65b46a08642a4c5f9fc1eb4.png
[img-qPf6tyol-1623688298210_image-20210613222730931.png]: /images/20210901/75015e059dab4454a1d91acf97c9b8af.png
[img-3t35X1S1-1623688298215_image-20210613224738500.png]: /images/20210901/5d0142eedb9442f6bcb6a17f10218881.png
[img-gjGv5k7R-1623688298218_image-20210613224828589.png]: /images/20210901/909298ede5874f38bd73005972f78bd0.png
[img-K5FN6ULx-1623688298222_image-20210613224918420.png]: /images/20210901/349e728173074f3596aa34a924475a9f.png
[img-RERGHClm-1623688298225_image-20210613225414441.png]: /images/20210901/347dd618db6d4f39aaed3731de18cb80.png
[img-3UGDXNMD-1623688298228_image-20210613225801811.png]: /images/20210901/044d8281bd3841d1b5927ad8f42f2b12.png
[img-3rzwtdYm-1623688298229_image-20210613230023399.png]: /images/20210901/663bf7ab743c4ee3beff1551a1bc93c6.png
[img-l0edF9KU-1623688298231_image-20210613230200362.png]: /images/20210901/8a9dd1df2e2b4cbeade432ca9a20f2b3.png
[img-2MqDENbp-1623688298232_image-20210613230809384.png]: /images/20210901/e1eeff57b5dd4221a05d410a419aa67c.png
[img-HWmN2f6b-1623688298234_image-20210613230646749.png]: /images/20210901/260ddaa5a9314ffe95700b0554e9a91d.png
[img-VJrvld2D-1623688298236_image-20210613231151240.png]: /images/20210901/91cab059d239409f93864bb631add77f.png
[img-BeCKrJS3-1623688298238_image-20210613231235544.png]: /images/20210901/2952674dd6824978bf793150105c8bbe.png
[img-waIbt2vf-1623688298241_image-20210613231336792.png]: /images/20210901/436661e0da874aca93cd8d5ff626789c.png
[img-NCIa03JQ-1623688298243_image-20210613232154571.png]: /images/20210901/eeee027e06dc481b80567e558d99433f.png
[img-o1TZdUQg-1623688298245_image-20210613232409021.png]: /images/20210901/d549f6b11f524b1687cb4defe97786c5.png
[img-pDNULzPO-1623688298248_image-20210613232629335.png]: /images/20210901/ad44bc51677a4544abe88a5dd2949071.png
[https_pan.baidu.com_s_1Xd75eAOXcvAnBax7VFsnjQ]: https://pan.baidu.com/s/1Xd75eAOXcvAnBax7VFsnjQ