SpringBoot远程Debug配置-优快云博客

原文：https://blog.youkuaiyun.com/caoli201314/article/details/117914896

首先我们需要写一个SpringBoot的小Demo来模拟一下。

先来配置我们的pom文件

<?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.5.1</version>
        <relativePath/>
    </parent>
    <groupId>com.xue</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-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.ibatis</groupId>
            <artifactId>ibatis-core</artifactId>
            <version>3.0</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</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>

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

</project>

这里我们需要重点提一下这个配置

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

这里我们在pom.xml中配置了jvmArguments，参数 -Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n

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

完成这些配置之后，我们开始编写代码。代码很简单，就是一个基于SpringBoot的小Demo

package com.xue.demo.controller;

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

@RestController
@RequestMapping("/api")
public class TestController {

    @PostMapping("/sendMessage")
    public String sendMessage(Integer id, String name) {
        System.out.println("id=" + id);
        System.out.println("name=" + name);
        if (id > 0) {
            return "success " + name;
        } else {
            return "fail";
        }
    }
}

yml配置文件中的端口号随意，这里就用了8081端口号。

启动Demo使用postman测试，可以看到是没有问题的。

接下来，我们就需要进行远程DeBug操作了。首先我们也是需要配置一番的。不是那么容易就可以远程DeBug的。

首先我们进行打包操作，将我们的程序打包成一个jar包。

接下来我们将jar包放到我们将要运行的地方。任意目录下即可。然后启动jar包。

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar demo-0.0.1-SNAPSHOT.jar

这个程序已经正常启动了。并且可以看到我们监听的端口号是5005

下一步，我们需要配置一下我们的IDEA。

添加Remote

随便命名一下，然后配置一下我们的Host和Port，点击Apply，OK。

之后，我们可以在我们的代码上打个断点，然后选择我们的DeBug启动项。

使用Postman测试，就会进入我们的断点。

程序也会根据断点进行走动。