1、远程DEBUG的必要性
由于部署环境的差异性,相信很多朋友都碰到过开发环境正常测试过的功能在测试环境甚至生产环境下出现bug的情况。一般情况下,生产环境可以采取的手段比较单一,即通过日志的方式获取运行中的环境上下文,分析日志文件并尝试重现bug。这会带来的问题还是不少的,首先,日志的分析是一项比较耗时的工作;其次,现有的日志记录不一定能反映出问题,你可能需要多次重复这个过程(分析日志->猜测问题->加日志->部署->获取日志)来慢慢逼近问题。倘若是测试环境,我们还多了一项可供选择的手段——远程调试——将程序在测试环境中以debug模式启动,在本机使用IDEA在工程中设置断点进行调试。
2、IDEA构建SpringBoot测试项目
这里我用的之前的测试demo,依赖基本不用引入什么东西,下面的redis依赖是我自己引入的,大家可以不用引入。
<?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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.cxk</groupId>
<artifactId>redis</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<artifactId>spring-boot-starter-parent</artifactId>
<groupId>org.springframework.boot</groupId>
<version>2.3.5.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
</dependency>
</dependencies>
</project>
yaml或者properties文件的话就随便加个端口号就行
server.port=8999
然后随便搞个接口:
package com.cxk.controller.main;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
@RequestMapping("/test2")
public String execute2() {
String s1 = 1+"";
String s2 = 2+"";
String s3 = s2+s1;
return " --- " + s3;
}
}
然后我们启动下postman测试一下
3、测试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>
<version>2.3.7.RELEASE</version>
<configuration>
<jvmArguments>-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,server=y,suspend=n </jvmArguments>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>8</source>
<target>8</target>
<encoding>utf-8</encoding>
</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;
4、IDEA打包jar
这一步可能大家都会,这里我再啰嗦一下
如果不知道怎么打包的同学仔细看,点右上角的Maven,
然后按下图顺序执行,这里我没执行test选项,如果有需要的可以执行这个选项。
执行完后,会在target目录下生成一个jar包
然后把这个复制到桌面运行,这里执行如下命令。
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -jar redis-1.0-SNAPSHOT.jar
第二行会提示正在监听5005端口。
然后接下来就是在需要打断点的地方打上断点,
然后我们去配置远程DEBUG配置。
点击Edit Configuration 会弹出一个页面,然后我们点击左上角的+号,找到Remote选项、进行如下配置。这里的5005就是上面说的监听的端口号。然后后apply。然后点击右上角的小虫子。
点击运行DEBUG后,弹出这个窗口就说明已经连接上了。
然后我们快去Postman测试一下。
注意哈:这里的请求的路径地址是你jar包部署的地址和项目中配置的端口号。然后断点进入。大功告成。