驚呆了！Spring Boot 還能開啟遠程調試？

2020 年 10 月 29 日
筆記
JAVA, springboot, 碼猿技術專欄

持續原創輸出，點擊上方藍字關注我

前言

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

隨着項目越來越多，特別是身處外包公司的朋友，每天可能需要切換兩三個項目，難道一有問題就本地啟動項目調試？

今天這篇文章就來介紹一下什麼是遠程調試，Spring Boot如何開啟遠程調試？

什麼是遠程調試？

所謂的遠程調試就是服務端程序運行在一台遠程服務器上，我們可以在本地服務端的代碼（前提是本地的代碼必須和遠程服務器運行的代碼一致）中設置斷點，每當有請求到遠程服務器時時能夠在本地知道遠程服務端的此時的內部狀態。

簡單的意思：本地無需啟動項目的狀態下能夠實時調試服務端的代碼。

為什麼要遠程調試？

隨着項目的體量越來越大，啟動的時間的也是隨之增長，何必為了調試一個BUG花費十分鐘的時間去啟動項目呢？你不怕老大罵你啊？

什麼是JPDA？

JPDA(Java Platform Debugger Architecture)，即 Java 平台調試體系，具體結構圖如下圖所示：

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

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

java -Xdebug -Xrunjdwp:...

如果你使用的是Java SE 5之後的版本，則使用的命令格式如下：

java -agentlib:jdwp=...

如何開啟調試？

由於現在使用的大多數都是Java SE 5之後的版本，則之前的就忽略了。

日常開發中最常見的開啟遠程調試的命令如下：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9093 -jar xxx.jar

前面的java -agentlib:jdwp=是基礎命令，後面的跟着的一串命令則是可選的參數，具體什麼意思呢？下面詳細介紹。

transport

指定運行的被調試應用和調試者之間的通信協議，有如下可選值：

dt_socket：採用socket方式連接（常用）
dt_shmem：採用共享內存的方式連接，支持有限，僅僅支持windows平台

server

指定當前應用作為調試服務端還是客戶端，默認的值為n（客戶端）。

如果你想將當前應用作為被調試應用，設置該值為y;如果你想將當前應用作為客戶端，作為調試的發起者，設置該值為n。

suspend

當前應用啟動後，是否阻塞應用直到被連接，默認值為y（阻塞）。

大部分情況下這個值應該為n，即不需要阻塞等待連接。一個可能為y的應用場景是，你的程序在啟動時出現了一個故障，為了調試，必須等到調試方連接上來後程序再啟動。

address

對外暴露的端口，默認值是8000

注意：此端口不能和項目同一個端口，且未被佔用以及對外開放。

onthrow

這個參數的意思是當程序拋出指定異常時，則中斷調試。

onuncaught

當程序拋出未捕獲異常時，是否中斷調試，默認值為n。

launch

當調試中斷時，執行的程序。

timeout

超時時間，單位ms（毫秒）

當 suspend = y 時，該值表示等待連接的超時；當 suspend = n 時，該值表示連接後的使用超時。

常用的命令

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

以Socket 方式監聽 8000 端口，程序啟動阻塞（suspend 的默認值為 y）直到被連接，命令如下：

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

以 Socket 方式監聽 8000 端口，當程序啟動後 5 秒無調試者連接的話終止，程序啟動阻塞（suspend 的默認值為 y）直到被連接。

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

選擇可用的共享內存連接地址並使用 stdout 打印，程序啟動不阻塞。

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

以 socket 方式連接到 myhost:8000上的調試程序，在連接成功前啟動阻塞。

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

以 Socket 方式監聽 8000 端口，程序啟動阻塞（suspend 的默認值為 y）直到被連接。當拋出 IOException 時中斷調試，轉而執行 usr/local/bin/debugstub程序。

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

IDEA如何開啟遠程調試？

首先的將打包後的Spring Boot項目在服務器上運行，執行如下命令（各種參數根據實際情況自己配置）：

java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9193 -jar debug-demo.jar

項目啟動成功後，點擊 Edit Configurations，在彈框中點擊 + 號，然後選擇Remote。

然後填寫服務器的地址及端口，點擊 OK 即可。

以上步驟配置完成後，點擊DEBUG調試運行即可。

配置完畢後點擊保存即可，因為我配置的 suspend=n，因此服務端程序無需阻塞等待我們的連接。我們點擊 IDEA 調試按鈕，當我訪問某一接口時，能夠正常調試。

總結

每天一個小知識，今天你學到了嗎？

另外作者為大家準備接近10M的麵筋，涵蓋後端的各個層面，老規矩，公號內回復Java面試寶典即可獲取。

Tags: JAVA springboot 碼猿技術專欄