IDEA远程debug SpringBoot项目

2022-04-30 本文已影响0人 AC编程

一、IDEA构建SpringBoot测试Demo

新建SpringBoot测试项目springboot-test，只需要web依赖支持即可

1.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.6.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.alanchen</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot-test</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>
                <configuration>
                    <jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n</jvmArguments>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

1.2 application.yml

spring:
  profiles:
    active: dev

1.3 application-dev.yml

server:
  port: 8080

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

@RestController
@RequestMapping("test")
public class TestController {

    @GetMapping
    public String test(){
        return "Hello";
    }
}

1.5 项目截图

1.6 启动项目，用Postman测试下

二、Demo项目配置支持远程调试

2.1 pom.xml配置

pom.xml里配置jvmArguments参数

<configuration>
        <jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n</jvmArguments>
</configuration>

加了此配置后，打包后的项目发布服务器，可支持远程debug，具体参数详解。

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

2、transport指定了调试数据的传送方式，dt_socket是指用SOCKET模式，另有dt_shmem指用共享内存方式，其中，dt_shmem只适用于Windows平台。

3、address 调试服务器的端口号，客户端用来连接服务器的端口号。

4、server=y/n VM 是否需要作为调试服务器执行。

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

三、Demo项目发布到阿里云ECS

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

3.2 打包后，在target目录下，会生成一个jar包

3.3 发布到远程阿里云ECS

1、将jar包拷贝到阿里云

scp E:/code/springboot-test/target/demo-0.0.1-SNAPSHOT.jar root@47.105.xxx.74:/root/data/server/demo-0.0.1-SNAPSHOT.jar

2、登录阿里云ECS启动jar

nohup java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev > output.log 2>&1 &

启动OK，监听socket 5005端口

3、ECS安全组开放端口
需要在ECS安全组开放8080、5005端口

4、无法访问阿里云服务的问题
如果无法访问阿里云服务，可参考我另外一篇文章：阿里云服务器中Ubuntu中部署tomcat无法访问问题解决

四、IDEA远程debug Demo项目

4.1 IDEA远程debug配置

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