远程Debug

在项目部署运行，在测试环境中出现的问题，只能通过日志去分析判断代码那一个模块出现问题，去定位到具体出现问题的代码，而有些功能在本地又比较难对出现的问题进行重现，由此可以选择使用远程Debug去定位测试环境中的问题。

1.搭建测试环境

用spring提供的脚手架创建一个工程，选用springboot版本为2.3.2.RELEASE

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.3.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.jk</groupId>
    <artifactId>testremotedebug</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>testremotedebug</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>
            </plugin>
        </plugins>
    </build>

</project>

application.properties

server.port=8080

为了测试方便（懒）直接把控制层接口写在了启动类上

package com.jk.testremotedebug;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class TestremotedebugApplication {

    public static void main(String[] args) {
        SpringApplication.run(TestremotedebugApplication.class, args);
    }

    @GetMapping("helloBug")
    public void testDebug(){
        System.out.println("进入controller层");
    }

}

接下来启动项目进行调试看看能不能顺利进入到controller层

接口一直在运行，看idea也顺利进入到controller

2.配置项目支持远程Debug

一般项目就是使用maven打包后直接放服务器进行运行，但是项目要支持远程Debug还需要对项目进行配置

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；

然后用对项目进行打包

第二步成功之后就可以在左边三四步找到对应jar包

3.启动项目

常规启动项目都是直接java -jar xxx.jar

但是要支持远程Debug还需要带一些参数

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

启动项目

可以看到现在项目监听着5005端口

4.本地配置支持远程Debug

项目配置支持Debug之后本地代码还需要配置才能对项目进行调试

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

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

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

然后启动idea本地项目，访问远程代码的接口（远程代码接口本机运行测试）

可以看到访问远程接口也可以进到本地代码的断点里面,并且在放过断点后日志也是打印在远程代码上

5.war包配置

如果项目打包方式选择war包的情况，配置的方式一点点不一样

1.将 web 应用部署到 Tomcat 的 webapp 目录下

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

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