远程debug调试项目

布满荆棘的人生 2022-08-31 00:49 223阅读 0赞

# 一、远程调试 #

将程序在测试环境中以debug模式启动，在本机使用IDEA在工程中设置断点进行调试。

# 二、环境搭建 #

## 2.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.4.5</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.example</groupId>
    	<artifactId>demo</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>demo</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-thymeleaf</artifactId>
    		</dependency>
    		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    		</dependency>
    
    		<dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
    			<optional>true</optional>
    		</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>
    				<configuration>
    					<jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=8081,server=y,suspend=n</jvmArguments>
    				</configuration>
    			</plugin>
    		</plugins>
    	</build>
    </project>

其中配置jvmArguments参数 -Xdebug -Xrunjdwp:transport=dt\_socket,address=8081,server=y,suspend=n  
加了此配置后，打包后的项目发布服务器，可支持远程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

application.yml

server:
      port: 8080

productController

package com.example.demo;
    
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class productController { 
        @PostMapping("/product")
        public String Controller(Integer id,String name){ 
            System.out.println("productId="+id);
            System.out.println("productName="+name);
            if(id>0){ 
                return "product sell success "+name;
            }else{ 
                return "product sell fail";
            }
        }
    }

## 2.2 IDEA打包jar ##

测试IDEA项目，利用postman验证能否正常访问![请添加图片描述][8f9c5e44d8f45d9dd2be1e15bf24f239.png]  
![请添加图片描述][5e55e07ef2eb111f272110ebc8199850.png]

## 2.3 本地命令窗口启动项目 ##

将打出的jar包放到本地磁盘D盘根目录，利用命令窗口启动本地项目  
![请添加图片描述][db95bf4d39b8663aa8267f00e56008d7.png]

## 2.4 IDEA配置远程debug ##

2.4.1启动项下拉，选择 Edit Configurations…编辑配置  
![请添加图片描述][28ef51c643979bad39f35d1e641c7fcb.png]  
2.4.2 点击+，选择Remote，添加远程DEBUG配置  
![在这里插入图片描述][40563ee7e497348d0b84c23602575001.png]  
2.4.3 添加远程DEBUG配置项，Host和Port，配置后，点击Apply和OK按钮  
![请添加图片描述][2c21e62d9d8d54dc556c85665af5147d.png]

# 三、IDEA远程DEBUG测试 #

## 3.1 打断点，并启动RemoteDebug ##

![请添加图片描述][2679f3fddb60c5aea6b9b36930ac140f.png]

## 3.2 利用postman测试 ##

访问http://localhost:8080/product  
发现进入断点![请添加图片描述][b39bc01b05aee77a91acc70f4af9559b.png]

## 3.3 调试完成，cmd窗口显示执行结果 ##

![请添加图片描述][87e29ba402cb341a32768f4538d06d34.png]

**参考文章**  
https://blog.csdn.net/caoli201314/article/details/117914896

[8f9c5e44d8f45d9dd2be1e15bf24f239.png]: /images/20220829/189cd597d50749cf9d6a87777f709c33.png
[5e55e07ef2eb111f272110ebc8199850.png]: /images/20220829/1910ec0d0d4c429db788836add138df5.png
[db95bf4d39b8663aa8267f00e56008d7.png]: /images/20220829/a03aef27dfec49caa1ad304829ab22fc.png
[28ef51c643979bad39f35d1e641c7fcb.png]: /images/20220829/bf45d954f58b42a6a1c064b739943dc9.png
[40563ee7e497348d0b84c23602575001.png]: /images/20220829/758d0bda39e141a59c4a95e7a037b963.png
[2c21e62d9d8d54dc556c85665af5147d.png]: /images/20220829/944d8a379c1d493a9f3faf907ef4bcb9.png
[2679f3fddb60c5aea6b9b36930ac140f.png]: /images/20220829/9380f8f7017d4cdcba5c83b32e249d90.png
[b39bc01b05aee77a91acc70f4af9559b.png]: /images/20220829/fdf8e33afee048fe92057b3295edc6e5.png
[87e29ba402cb341a32768f4538d06d34.png]: /images/20220829/675be798639d4181ad99623743a41500.png