快捷導航

一篇文章詳解JAVA遠程debug

更新時間：2023年08月15日 09:11:20 作者：_BugMan

這篇文章主要給大家介紹了關(guān)于JAVA遠程debug的相關(guān)資料,日常我們debug是經(jīng)常用的,但是本地還好說,遠程debug就有點難度,需要的朋友可以參考下

1.什么是遠程debug？

遠程debug，也就是可以在本地debug遠端部署的程序，這對于定位遠端環(huán)境中的問題非常有用，之所以我們說是遠端環(huán)境，而不說是對定位生產(chǎn)環(huán)境中的bug很有用，是因為遠程調(diào)試通常在開發(fā)和測試階段使用，而不建議在生產(chǎn)環(huán)境中使用，因為可能會對性能產(chǎn)生影響。當然，在沒有辦法的時候使用遠程debug，是最高效的定位生產(chǎn)問題的手段之一。

遠程debug可以理解為一種JVM規(guī)范，當然其不是單獨的一個規(guī)范，它是屬于JDWP（Java Debug Wire Protocol）協(xié)議中的一部分，該協(xié)議定義了 Java 虛擬機（JVM）與調(diào)試器之間的交互方式。通過 JDWP，開發(fā)者可以在開發(fā)工具中設(shè)置斷點、查看變量、執(zhí)行代碼等操作，以便對運行中的 Java 程序進行調(diào)試。說直白點就是遵循了該協(xié)議的JVM，就支持debug，也支持遠程debug。

2.遠程debug普通JAVA程序

2.1.環(huán)境

JDK:1.8
編譯器:IDEA

2.2.測試程序

這里我們寫了很簡單一個測試程序，每1秒，i自加1，然后將其打包成jar包

public static void main(String[] args) throws InterruptedException {
        int i=0;
        while (true){
            Thread.sleep(1000);
            i++;
        }
    }

我估計很多同學一下會忘了這么在IDEA中將普通java se程序如何打包成jar了，這里貼心一點，給出打包方法，用打包jar包的maven插件，指定好main入口，然后install即可：

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.eryi.Test</mainClass>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

2.3.程序啟動指令

要遠程debug，首先在程序啟動時就要用參數(shù)開啟遠程debug，完成參數(shù)指令如下：

-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<host>:<port>

transport：指定調(diào)試信息傳輸?shù)姆绞剑话闶褂?nbsp;dt_socket。
server：指定是否為調(diào)試服務(wù)端，使用 y 表示是。
suspend：指定是否在啟動時暫停，使用 n 表示不暫停。
address：指定調(diào)試監(jiān)聽的主機和端口，也就是通過該端口來進行遠程debug的。

以我們上面的程序為例，完成的啟動命令為：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=127.0.0.1:5005 -jar test-1.0-SNAPSHOT.jar

啟動成功會顯示正在監(jiān)聽debug的端口：

2.4.編譯器配置

我們想要在IDEA中遠程debug，需要進行配置：

add configurations

add new configuration—>remote

配置：

開始debug：

可以看到程序進入了斷點。

3.遠程debug JAVA Web程序

tomcat作為常用的web server為了方便使用，自然也支持了遠程debug的功能。普通java程序是用java -jar啟動，tomcat是用啟動腳本啟動，啟動腳本里記錄的就是tomcat啟動要執(zhí)行的所有命令，遠程debug也寫在里面。

Windows環(huán)境下修改start.sh，在第一行加上以下命令：

export CATALINA_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,address=<host>:<port>,server=y,suspend=n"

Linux環(huán)境下修改start.bat，在第一行加上以下命令：

set "CATALINA_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,address=<host>:<port>,server=y,suspend=n"

4.遠程debug spring boot程序

spring boot項目作為一個jar，是可以用java -jar然后跟參數(shù)這種啟動普通Java程序debug的方式來進行debug的，除此之外，spring boot還提供了一個更方便的遠程debug的方式，就是將參數(shù)配置在spring boot的打包插件中。

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <jvmArguments>-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=<host>:<port></jvmArguments>
            </configuration>
        </plugin>
    </plugins>
</build>