驚呆了！Spring?Boot?還能遠(yuǎn)程調(diào)試？

目錄

• 前言
• 什么是遠(yuǎn)程調(diào)試？
• 為什么要遠(yuǎn)程調(diào)試？
• 什么是JPDA？
• 如何開啟遠(yuǎn)程調(diào)試？
• transport
• server
• suspend
• address
• onthrow
• onuncaught
• launch
• timeout
• 常用的命令
• IDEA如何開啟遠(yuǎn)程調(diào)試？
• 總結(jié)

前言

上周末一個(gè)朋友慶生，無意間聽他說起了近況，說公司項(xiàng)目太多了，每天一堆BUG需要修復(fù)，項(xiàng)目來回切換啟動(dòng)，真是挺煩的。

隨著項(xiàng)目越來越多，特別是身處外包公司的朋友，每天可能需要切換兩三個(gè)項(xiàng)目，難道一有問題就本地啟動(dòng)項(xiàng)目調(diào)試？

今天這篇文章就來介紹一下什么是遠(yuǎn)程調(diào)試，Spring Boot如何開啟遠(yuǎn)程調(diào)試？

什么是遠(yuǎn)程調(diào)試？

所謂的遠(yuǎn)程調(diào)試就是服務(wù)端程序運(yùn)行在一臺(tái)遠(yuǎn)程服務(wù)器上，我們可以在本地服務(wù)端的代碼（前提是本地的代碼必須和遠(yuǎn)程服務(wù)器運(yùn)行的代碼一致）中設(shè)置斷點(diǎn)，每當(dāng)有請求到遠(yuǎn)程服務(wù)器時(shí)時(shí)能夠在本地知道遠(yuǎn)程服務(wù)端的此時(shí)的內(nèi)部狀態(tài)。

簡單的意思：本地?zé)o需啟動(dòng)項(xiàng)目的狀態(tài)下能夠?qū)崟r(shí)調(diào)試服務(wù)端的代碼。

為什么要遠(yuǎn)程調(diào)試？

隨著項(xiàng)目的體量越來越大，啟動(dòng)的時(shí)間的也是隨之增長，何必為了調(diào)試一個(gè)BUG花費(fèi)十分鐘的時(shí)間去啟動(dòng)項(xiàng)目呢？你不怕老大罵你?。?/p>

什么是JPDA？

JPDA(Java Platform Debugger Architecture)，即 Java 平臺(tái)調(diào)試體系，具體結(jié)構(gòu)圖如下圖所示：

其中實(shí)現(xiàn)調(diào)試功能的主要協(xié)議是JDWP協(xié)議，在 Java SE 5 以前版本，JVM 端的實(shí)現(xiàn)接口是 JVMPI(Java Virtual Machine Profiler Interface)，而在Java SE 5及以后版本，使用 JVMTI(Java Virtual Machine Tool Interface) 來替代 JVMPI。

因此，如果你使用的是Java SE 5之前的版本，則使用的調(diào)試命令格式如下：

java?-Xdebug?-Xrunjdwp:...
如果你使用的是Java SE 5之后的版本，則使用的命令格式如下：

java?-agentlib:jdwp=...


如何開啟遠(yuǎn)程調(diào)試？

由于現(xiàn)在使用的大多數(shù)都是Java SE 5之后的版本，則之前的就忽略了。

日常開發(fā)中最常見的開啟遠(yuǎn)程調(diào)試的命令如下：

java?-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9093?-jar?xxx.jar
前面的java -agentlib:jdwp=是基礎(chǔ)命令，后面的跟著的一串命令則是可選的參數(shù)，具體什么意思呢？下面詳細(xì)介紹。

transport

指定運(yùn)行的被調(diào)試應(yīng)用和調(diào)試者之間的通信協(xié)議，有如下可選值：

1. dt_socket：采用socket方式連接（常用）
2. dt_shmem：采用共享內(nèi)存的方式連接，支持有限，僅僅支持windows平臺(tái)

server

指定當(dāng)前應(yīng)用作為調(diào)試服務(wù)端還是客戶端，默認(rèn)的值為n（客戶端）。

如果你想將當(dāng)前應(yīng)用作為被調(diào)試應(yīng)用，設(shè)置該值為y;如果你想將當(dāng)前應(yīng)用作為客戶端，作為調(diào)試的發(fā)起者，設(shè)置該值為n。

suspend

當(dāng)前應(yīng)用啟動(dòng)后，是否阻塞應(yīng)用直到被連接，默認(rèn)值為y（阻塞）。

大部分情況下這個(gè)值應(yīng)該為n，即不需要阻塞等待連接。一個(gè)可能為y的應(yīng)用場景是，你的程序在啟動(dòng)時(shí)出現(xiàn)了一個(gè)故障，為了調(diào)試，必須等到調(diào)試方連接上來后程序再啟動(dòng)。

address

對外暴露的端口，默認(rèn)值是8000

注意：此端口不能和項(xiàng)目同一個(gè)端口，且未被占用以及對外開放。

onthrow

這個(gè)參數(shù)的意思是當(dāng)程序拋出指定異常時(shí)，則中斷調(diào)試。

onuncaught

當(dāng)程序拋出未捕獲異常時(shí)，是否中斷調(diào)試，默認(rèn)值為n。

launch

當(dāng)調(diào)試中斷時(shí)，執(zhí)行的程序。

timeout

超時(shí)時(shí)間，單位ms（毫秒）

當(dāng) suspend = y 時(shí)，該值表示等待連接的超時(shí)；當(dāng) suspend = n 時(shí)，該值表示連接后的使用超時(shí)。

常用的命令

下面列舉幾個(gè)常用的參考命令，這樣更加方便理解。

1. 以Socket 方式監(jiān)聽 8000 端口，程序啟動(dòng)阻塞（suspend 的默認(rèn)值為 y）直到被連接，命令如下：

-agentlib:jdwp=transport=dt_socket,server=y,address=8000


2. 以 Socket 方式監(jiān)聽 8000 端口，當(dāng)程序啟動(dòng)后 5 秒無調(diào)試者連接的話終止，程序啟動(dòng)阻塞（suspend 的默認(rèn)值為 y）直到被連接。

-agentlib:jdwp=transport=dt_socket,server=y,address=localhost:8000,timeout=5000


3. 選擇可用的共享內(nèi)存連接地址并使用 stdout 打印，程序啟動(dòng)不阻塞。

-agentlib:jdwp=transport=dt_shmem,server=y,suspend=n


4. 以 socket 方式連接到 myhost:8000上的調(diào)試程序，在連接成功前啟動(dòng)阻塞。

-agentlib:jdwp=transport=dt_socket,address=myhost:8000


5. 以 Socket 方式監(jiān)聽 8000 端口，程序啟動(dòng)阻塞（suspend 的默認(rèn)值為 y）直到被連接。當(dāng)拋出 IOException 時(shí)中斷調(diào)試，轉(zhuǎn)而執(zhí)行 usr/local/bin/debugstub程序。

-agentlib:jdwp=transport=dt_socket,server=y,address=8000,onthrow=java.io.IOException,launch=/usr/local/bin/debugstub


IDEA如何開啟遠(yuǎn)程調(diào)試？

首先的將打包后的Spring Boot項(xiàng)目在服務(wù)器上運(yùn)行，執(zhí)行如下命令（各種參數(shù)根據(jù)實(shí)際情況自己配置）：

java?-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9193?-jar?debug-demo.jar
項(xiàng)目啟動(dòng)成功后，點(diǎn)擊 Edit Configurations，在彈框中點(diǎn)擊 號(hào)，然后選擇Remote。

然后填寫服務(wù)器的地址及端口，點(diǎn)擊 OK 即可。

以上步驟配置完成后，點(diǎn)擊DEBUG調(diào)試運(yùn)行即可。

配置完畢后點(diǎn)擊保存即可，因?yàn)槲遗渲玫?suspend=n，因此服務(wù)端程序無需阻塞等待我們的連接。我們點(diǎn)擊 IDEA 調(diào)試按鈕，當(dāng)我訪問某一接口時(shí)，能夠正常調(diào)試。