Spring Boot開啟遠程調(diào)試的方法
作者:不才陳某
前言
上周末一個朋友慶生,無意間聽他說起了近況,說公司項目太多了,每天一堆BUG需要修復(fù),項目來回切換啟動,真是挺煩的。
隨著項目越來越多,特別是身處外包公司的朋友,每天可能需要切換兩三個項目,難道一有問題就本地啟動項目調(diào)試?
今天這篇文章就來介紹一下什么是遠程調(diào)試,Spring Boot如何開啟遠程調(diào)試?
什么是遠程調(diào)試?
所謂的遠程調(diào)試就是服務(wù)端程序運行在一臺遠程服務(wù)器上,我們可以在本地服務(wù)端的代碼(前提是本地的代碼必須和遠程服務(wù)器運行的代碼一致)中設(shè)置斷點,每當有請求到遠程服務(wù)器時時能夠在本地知道遠程服務(wù)端的此時的內(nèi)部狀態(tài)。
簡單的意思:本地無需啟動項目的狀態(tài)下能夠?qū)崟r調(diào)試服務(wù)端的代碼。
為什么要遠程調(diào)試?
隨著項目的體量越來越大,啟動的時間的也是隨之增長,何必為了調(diào)試一個BUG花費十分鐘的時間去啟動項目呢?你不怕老大罵你啊?
什么是JPDA?
JPDA(Java Platform Debugger Architecture),即 Java 平臺調(diào)試體系,具體結(jié)構(gòu)圖如下圖所示:

其中實現(xiàn)調(diào)試功能的主要協(xié)議是JDWP協(xié)議,在 Java SE 5 以前版本,JVM 端的實現(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=...
如何開啟調(diào)試?
由于現(xiàn)在使用的大多數(shù)都是Java SE 5之后的版本,則之前的就忽略了。
日常開發(fā)中最常見的開啟遠程調(diào)試的命令如下:
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9093 -jar xxx.jar
前面的java -agentlib:jdwp=是基礎(chǔ)命令,后面的跟著的一串命令則是可選的參數(shù),具體什么意思呢?下面詳細介紹。
transport
指定運行的被調(diào)試應(yīng)用和調(diào)試者之間的通信協(xié)議,有如下可選值:
- dt_socket: 采用socket方式連接(常用)
- dt_shmem:采用共享內(nèi)存的方式連接,支持有限,僅僅支持windows平臺
server
指定當前應(yīng)用作為調(diào)試服務(wù)端還是客戶端,默認的值為n(客戶端)。
如果你想將當前應(yīng)用作為被調(diào)試應(yīng)用,設(shè)置該值為y;如果你想將當前應(yīng)用作為客戶端,作為調(diào)試的發(fā)起者,設(shè)置該值為n。
suspend
當前應(yīng)用啟動后,是否阻塞應(yīng)用直到被連接,默認值為y(阻塞)。
大部分情況下這個值應(yīng)該為n,即不需要阻塞等待連接。一個可能為y的應(yīng)用場景是,你的程序在啟動時出現(xiàn)了一個故障,為了調(diào)試,必須等到調(diào)試方連接上來后程序再啟動。
address
對外暴露的端口,默認值是8000
注意:此端口不能和項目同一個端口,且未被占用以及對外開放。
onthrow
這個參數(shù)的意思是當程序拋出指定異常時,則中斷調(diào)試。
onuncaught
當程序拋出未捕獲異常時,是否中斷調(diào)試,默認值為n。
launch
當調(diào)試中斷時,執(zhí)行的程序。
timeout
超時時間,單位ms(毫秒)
當 suspend = y 時,該值表示等待連接的超時;當 suspend = n 時,該值表示連接后的使用超時。
常用的命令
下面列舉幾個常用的參考命令,這樣更加方便理解。
以Socket 方式監(jiān)聽 8000 端口,程序啟動阻塞(suspend 的默認值為 y)直到被連接,命令如下:
-agentlib:jdwp=transport=dt_socket,server=y,address=8000
以 Socket 方式監(jiān)聽 8000 端口,當程序啟動后 5 秒無調(diào)試者連接的話終止,程序啟動阻塞(suspend 的默認值為 y)直到被連接。
-agentlib:jdwp=transport=dt_socket,server=y,address=localhost:8000,timeout=5000
選擇可用的共享內(nèi)存連接地址并使用 stdout 打印,程序啟動不阻塞。
-agentlib:jdwp=transport=dt_shmem,server=y,suspend=n
以 socket 方式連接到 myhost:8000上的調(diào)試程序,在連接成功前啟動阻塞。
-agentlib:jdwp=transport=dt_socket,address=myhost:8000
以 Socket 方式監(jiān)聽 8000 端口,程序啟動阻塞(suspend 的默認值為 y)直到被連接。當拋出 IOException 時中斷調(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如何開啟遠程調(diào)試?
首先的將打包后的Spring Boot項目在服務(wù)器上運行,執(zhí)行如下命令(各種參數(shù)根據(jù)實際情況自己配置):
java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=9193 -jar debug-demo.jar
項目啟動成功后,點擊 Edit Configurations,在彈框中點擊 + 號,然后選擇Remote。

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

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

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

總結(jié)
每天一個小知識,今天你學(xué)到了嗎?
以上就是Spring Boot開啟遠程調(diào)試的方法的詳細內(nèi)容,更多關(guān)于Spring Boot開啟遠程調(diào)試的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringBoot項目實用功能之實現(xiàn)自定義參數(shù)解析器
這篇文章主要介紹了SpringBoot項目實用功能之實現(xiàn)自定義參數(shù)解析器,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-08-08
關(guān)于Controller層和Service層的類報錯問題及解決方案
這篇文章主要介紹了關(guān)于Controller層和Service層的類報錯問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-02-02
完美解決gson將Integer默認轉(zhuǎn)換成Double的問題
下面小編就為大家?guī)硪黄昝澜鉀Qgson將Integer默認轉(zhuǎn)換成Double的問題。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2017-03-03
springboot打包JAR包瘦身lib和配置文件分離方式
本文介紹了如何通過優(yōu)化POM.xml配置來減小JAR包大小,提高傳輸速度,主要步驟包括:指定打包環(huán)境和跳過編譯單元測試、JAR打包排除配置文件和lib、提供全量包便于開發(fā)環(huán)境使用、將lib和配置文件單獨復(fù)制出來2024-11-11

