SpringBoot远程Debug

SpringBoot项目远程DEBUG

参考博客CSDN链接

1.Idea构建SpringBoot测试Demo

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.3.12.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>org.jumutang.com</groupId>
    <artifactId>remote_debug</artifactId>
    <version>0.0.1-SNAPSHOT</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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>


    </build>

</project>

application.yml

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

简单测试接口 TestController

package org.jumutang.com.remote_debug;

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

@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";
        }
    }

}

Idea项目启动后,通过接口工具测试：

2.测试Demo配置项目支持远程调试

具体参数详解：

-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；

pom文件bulid属性修改：

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <!---Xdebug 通知JVM工作在DEBUG模式下；-->
                <configuration>                   
                    <jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n</jvmArguments>
                </configuration>
            </plugin>
        </plugins>

		<!--打包指定输出包名-->
        <finalName>${artifactId}</finalName>

    </build>

3.Idea快速打包Jar

关闭Test测试用例打包

4.启动jar并且带启动参数支持远程调试

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

启动成功,监听5005端口

5.IDEA远程DEBUG配置

1.启动项下拉，选择 Edit Configurations...编辑配置

2.点击+，选择Remote，添加远程DEBUG配置

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

6.IDEA远程DEBUG测试

1.代码中标记断点

2.启动Idea准备远程debug调试

3.接口调用工具执行对接口的请求

点击发送执行中状态如图所示：

Idea中打印断点信息：

7.【注意】打war包方式配置远程DEBUG

修改 Tomcat/bin/startup.bat 文件，在最前面加上如下代码：

SET CATALINA_OPTS=-server -Xdebug -Xnoagent -Djava.compiler=NONE -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005

修改后截图如下：