SpringBoot Debug调试

骑猪看日落 2023-06-30 01:59 144阅读 0赞

### **背景：** ###

Spring Boot 项目在使用 Spring Boot Maven 插件执行启动命令 `spring-boot:run` 的时候，如果设置的断点进不去，要进行以下的设置。

### **官方解决方案：** ###

> By default, the run goal runs your application in a forked process. If you need to debug it, you should add the necessary JVM arguments to enable remote debugging. The following configuration suspend the process until a debugger has joined on port 5005:

### 1、添加 JVM 参数 ###

在插件 `spring-boot-maven-plugin` 里面加上 `jvmArguments` 配置。

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

或者在命令行指定：

mvn spring-boot:run -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"

![format_png][]

最新配置可以参考官方说明：

> https://docs.spring.io/spring-boot/docs/current/maven-plugin/examples/run-debug.html

### 2、添加一个Remote ###

在开发工具里面新增一个 Remote 配置：

![format_png 1][]

只需要确定 Host、Port 参数即可。

*  Host：地址

localhost：本地启动地址；

*  Port：端口

5005：上面命令行指定的端口；

### 3、开始调试 ###

先启动加了 `jvmArguments` 参数的 Spring Boot 项目：

![format_png 2][]

程序停在监听端口：5005，再 debug 启动Remote：

![format_png 3][]

再回到项目，开始启动输出日志，然后就可以进行断点调试了。

这就是远程调试了，也能帮你 debug 远程 Spring Boot 应用，但在本地调试要操作两次，略显麻烦。

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9UTlV3S2hWMEpwUk1ueHhna2ljbXJzckt4aWNrclRlaHZTNnBpY3drWXVYUng2aWFpYzFFU2dadkxIYURsVElxU0dsejNSenFyTEoxbUJJSVc5R09QMThoMVBRLzY0MA?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9UTlV3S2hWMEpwUk1ueHhna2ljbXJzckt4aWNrclRlaHZTaWJVa1lPUWlhQXl6MnBRRm5ET2ljRzZwYzMzTE9MTnZ4Q0JyeElCc2lhbGZHU3dFQTdvTGFvek1RUS82NDA?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9UTlV3S2hWMEpwUk1ueHhna2ljbXJzckt4aWNrclRlaHZTcU11SmF2dHhKUEJ3TEJTSGJGU1FSc0Z1c0Ywb1o2R1BCWkZoeXBMTkxrUDRVOGJUY2ljZElxUS82NDA?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy9UTlV3S2hWMEpwUk1ueHhna2ljbXJzckt4aWNrclRlaHZTOFp6RE9vY25yYWJVRnl2NEZRN2dQODZMQlRwd1hnN1NvMHlhVzU0RGphZ2lhMmlhWHEzRUdQaWJRLzY0MA?x-oss-process=image/format,png