Remote Debug 本地远程调试服务器运行代码

作者：小凯
沉淀、分享、成长，让自己和他人都能有所收获！

大家是否遇到过这样一种bug场景，本地没什么问题，部署到服务器上就不行了。往往遇到这样的问题，要花费大量的时间检查程序逻辑，一个个方法 mock 测试验证。那有人会问了，你怎么不在本地 debug 调试下呢？

你的代码本地没法启动！

其实并不是所有的工程代码，都能本地启动运行的。尤其复杂的工程，与外部对接非常多，甚至还有一些是风险控制的问题，本地是不能启动直接调用的。也就是控制研发人员，不允许本地程序调用其他程序的接口。那么对于这样的工程，研发的自测就要通过编写 mock (opens new window)方式进行单元化测试。

不过这里会有一个问题，单元化的测试，mock 的数据是不会随着外部所有程序的调整动态的变更的，而是随着研发编写需求，一次写好后，后续如果这个功能没有被调整，那么 mock 测试也不会在调整了。同时还因为 mock 覆盖的场景不全，不知道引入的外部那么多接口都有哪些新增的逻辑。因而，你可能本地运行没问题，但部署到测试环境，就会有一些不缺性的报错。

对于这里的报错，当你没有 debug 手段的时候，就要把前后的报错数据，都要复制到本地，通过 mock 的方式验证程序逻辑，一点点排查。不过，这个过程也要花费好长时间，尤其是一些复杂的逻辑与外部交互又非常多的时候，调试起来很耗费时间。

所以，程序员👨🏻‍💻对于实在难以调试的代码，还有一种方式就是远程调试。把代码部署到服务器，通过请求服务器的接口，本地的 IntelliJ IDEA 打开的工程，就可以调试对应的运行数据。可以非常高效的解决 bug！

一、测试工程
这里准备好了一个测试工程，你可以直接下载验证。

在这里插入图片描述

环境：JDK 1.8、SpringBoot 2.7
如图，工程提供了简单的 TestApiController 一个 http 测试入口。之后通过 Dockerfie 方式构建镜像，以及提供了 docker-compose-app.yml 启动工程。重要的是 JAVA_REMOTE_DEBUG 的配置。这是一种 JavaAgent 技术。

1. 测试接口

@Slf4j
@RestController()
@CrossOrigin("*")
@RequestMapping("/api/v1/test/")
public class TestApiController {

/**
* curl –request POST \\
* –url 'http://127.0.01:8091/xfg/api/v1/test/group_buy_notify?requestDTO=1111'
*
* 注意，yml 里配置了应用根目录；server.servlet.context-path: /xfg
*/
@RequestMapping(value = "group_buy_notify", method = RequestMethod.POST)
public String groupBuyNotify(@RequestParam String requestDTO) {
log.info("请求参数 {}", JSON.toJSONString(requestDTO));

return "success";
}

}

一个简单的测试接口，访问接口地址为；http://127.0.01:8091/xfg/api/v1/test/group_buy_notify?requestDTO=1111
你可以复制 curl 部分，导入到 apipost/apifox 等工具里使用。

2. Dockerfile

# 基础镜像
FROM openjdk:8–jre–slim

# 作者
MAINTAINER xiaofuge

# 配置
ENV PARAMS=""

# 时区
ENV TZ=PRC
RUN ln –snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

# 添加应用
ADD target/xfg–dev–tech–remote–jvm–debug–app.jar /xfg–dev–tech–remote–jvm–debug–app.jar
EXPOSE 8091 5005

ENTRYPOINT ["sh","-c","java $JAVA_REMOTE_DEBUG -jar $JAVA_OPTS /xfg-dev-tech-remote-jvm-debug-app.jar $PARAMS"]

ENTRYPOINT，添加了一个 $JAVA_REMOTE_DEBUG 的动态入参，其实这个位置要填入的就是 agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005 但并不是上线的所有程序都要做这样的事情，一般只有测试环境才需要。
EXPOSE 8091 5005 对外暴漏应用程序所需的 8091 5005 端口。

3. DockerCompose 部署脚本

# /usr/local/bin/docker–compose –f /docs/dev–ops/environment/environment–docker–compose–2.4.yml up –d
version: '3.8'
# docker–compose –f docker–compose–app.yml up –d
services:
xfg–dev–tech–remote–jvm–debug–app:
image: fuzhengwei/xfg–dev–tech–remote–jvm–debug–app:1.0
container_name: xfg–dev–tech–remote–jvm–debug–app
restart: on–failure
ports:
– "5005:5005"
– "8091:8091"
environment:
– TZ=PRC
– SERVER_PORT=8091
# 2c4g 配置，4c8g 翻倍，–Xms4096m –Xmx4096m | –Xmx –Xms：指定java堆最大值（默认值是物理内存的1/4(<1GB)）和初始java堆最小值（默认值是物理内存的1/64(<1GB))
– JAVA_OPTS=–Xms2048m –Xmx2048m
– JAVA_REMOTE_DEBUG=–agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005
volumes:
– ./log:/data/log
logging:
driver: "json-file"
options:
max–size: "10m"
max–file: "3"
networks:
– my–network

networks:
my–network:
driver: bridge

部署服务注意，要对外提供 5005、8091 两个映射端口。对于这种端口的暴漏
另外在 environment 环境中，配置 – JAVA_REMOTE_DEBUG=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005 这样就可以把远侧调试的服务给启动起来了。相当于你在自己的电脑的 IntelliJ IDEA 与服务器上的应用，通过 5005 端口进行通信完成测试debug验证。

二、部署程序
确保你自己本地已经安装好了 Docker (opens new window)Mac、Windows 电脑都可以安装。

1. 打包程序
在这里插入图片描述