驚呆了！Spring Boot 還能開啟遠端除錯？

愛撒謊的男孩發表於2020-10-29
Spring Boot除錯

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

目錄

  • 前言
  • 什麼是遠端除錯？
  • 為什麼要遠端除錯？
  • 什麼是JPDA？
  • 如何開啟除錯？
    • transport
    • server
    • suspend
    • address
    • onthrow
    • onuncaught
    • launch
    • timeout
  • 常用的命令
  • IDEA如何開啟遠端除錯？
  • 總結

前言

上週末一個朋友慶生，無意間聽他說起了近況，說公司專案太多了，每天一堆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

指定執行的被除錯應用和除錯者之間的通訊協議，有如下可選值：

  1. dt_socket： 採用socket方式連線（常用）
  2. dt_shmem：採用共享記憶體的方式連線，支援有限，僅僅支援windows平臺

server

指定當前應用作為除錯服務端還是客戶端，預設的值為n（客戶端）。

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

suspend

當前應用啟動後，是否阻塞應用直到被連線，預設值為y（阻塞）。

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

address

對外暴露的埠，預設值是8000

注意：此埠不能和專案同一個埠，且未被佔用以及對外開放。

onthrow

這個引數的意思是當程式丟擲指定異常時，則中斷除錯。

onuncaught

當程式丟擲未捕獲異常時，是否中斷除錯，預設值為n。

launch

當除錯中斷時，執行的程式。

timeout

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

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

常用的命令

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

  1. 以Socket 方式監聽 8000 埠，程式啟動阻塞（suspend 的預設值為 y）直到被連線，命令如下：
-agentlib:jdwp=transport=dt_socket,server=y,address=8000
  1. 以 Socket 方式監聽 8000 埠，當程式啟動後 5 秒無除錯者連線的話終止，程式啟動阻塞（suspend 的預設值為 y）直到被連線。
-agentlib:jdwp=transport=dt_socket,server=y,address=localhost:8000,timeout=5000
  1. 選擇可用的共享記憶體連線地址並使用 stdout 列印，程式啟動不阻塞。
-agentlib:jdwp=transport=dt_shmem,server=y,suspend=n
  1. 以 socket 方式連線到 myhost:8000上的除錯程式，在連線成功前啟動阻塞。
-agentlib:jdwp=transport=dt_socket,address=myhost:8000
  1. 以 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面試寶典即可獲取。

相關文章