远程Debug

IDEA构建SpringBoot测试Demo

新建SpringBoot测试项目remote-debug，只需要web依赖支持即可；版本选用2.2.6.RELEASE




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.2.6.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>v1.0</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.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>

application.yml:

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

TestController:

package com.example.demo.controller;

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


@RestController
public class TestController {

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

}

我们启动项目，用postman测试下：

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

pom.xml里配置jvmArguments参数 -Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n：

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

加了此配置后，打包后的项目发布服务器，可支持远程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；

IDEA打包jar

我们打包jar包；

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

打包后，在target目录下，会生成一个jar包；我们把它复制出来即可；

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

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

启动OK，监听socket 5005端口

IDEA远程DEBUG配置

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

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

2，点击+，选择Remote，添加远程DEBUG配置,添加远程DEBUG配置项，Host和Port，配置后，点击Apply和OK按钮

IDEA远程DEBUG测试

1，打测试断点

我们直接在TestController类里的test方法上打点断；

2，选择远程debug启动项，然后点击测试调试按钮启动；

3，postman测试

4，成功进入断点

我们走完断点；

5，启动的jar包打印信息，测试OK