Java 小技巧 ( 一 ) : 远程 debug

该系列介绍一些java开发中常用的一些小技巧,多小呢,从不会到会只需要一篇文章这么小。这一篇介绍如何使用jdk自带的扩展包配合Intellij IDEA实现远程debug。

项目中经常会有出现这样的问题,会令程序员抓狂:关键代码段没有打印日志,本地环境正常生产环境却又问题…这时候,远程debug可能会启动作用。

1 准备用于debug的代码

准备一个RestController用于接收请求,最后可以通过本地断点验证是否成功开启了远程debug

@RestController
public class TestController {
    @RequestMapping("/test")
    public Integer test() {
        int i = 0;
        i++;
        i++;
        i++;
        i++;
        i++;
        return i;
    }
}

项目使用springboot和maven构建,依赖就省略了,使用springboot提供的maven打包插件,方便我们打包成可运行的jar。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <executable>true</executable>
            </configuration>
        </plugin>
        <plugin>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
            </configuration>
        </plugin>
    </plugins>
</build>

2 使用maven插件打包成jar

3 准备启动脚本

java -jar -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=64057 remote-debug-1.0-SNAPSHOT.jar
  1. 使用java -jar的方式启动程序,并且添加了一串特殊的参数,这是我们能够开启远程debug的关键,以-开头的参数是jvm的标准启动参数,关于jvm启动参数相关的知识可以先去其他博客了解。
  2. -agentlib:libname[=options], 用于装载本地lib包。在这条指令中便是加载了jdwp(Java Debug Wire Protocol)这个用于远程调试java的扩展包。而transport=dt_socket,server=y,suspend=n,address=64057这些便是jdwp装载时的定制参数,详细的参数作用可以搜索jdwp进行了解。我们需要关心的只有address=64057这个参数选项,本地调试程序使用64057端口与其通信,从而远程调试。

4 配置IDEA

  1. 与脚本中的指令完全一致
  2. 远程jar包运行的host,由于我的jar运行在本地,所以使用的是localhost,一般线上环境自然是修改为线上的地址
  3. 与远程jar包进行交互的端口号,idea会根据指令自动帮我们输入
  4. 选择与远程jar包一致的本地代码

请务必保证远程jar包的代码与本地代码一致!!!

5 验证

保存第4步的配置后,先执行脚本让远程的jar包跑起来,再在IDEA中运行remote-debug

如上便代表连接运行成功了

在本地打上断点,访问localhost:8080/test

可以在本地看到堆栈信息,大功告成。一行指令便完成了远程调试。



可能感兴趣的文章

发表评论

Comment form

(*) 表示必填项

还没有评论。

跳到底部
返回顶部