當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

IDEA 开启远程调试

發布時間：2023/12/31 编程问答 49 豆豆

生活随笔收集整理的這篇文章主要介紹了 IDEA 开启远程调试小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

idea 遠程調試

背景

在編寫代碼時, 總會遇到這樣或者那樣的bug. 這有些bug 特別是業務邏輯的bug .
在生產或測試環境好復現而在開發環境不好復現. 現在提供的一種思路, 就是遠程調試:
我們可以在本地直接調試生產環境或者測試環境的代碼. 只需我們本地代碼和遠程部署的代碼一致.
遠程主機就會通過socket 將程序執行情況同步到本地

操作

下面以idea 為例

設置遠程啟動配置
在我們平時啟動項目的坐邊, 有一個 edit configuration的選項, 然后點擊 + , 選擇 Remote JVM Debug 選項
Name 為之后啟動的名稱,
Host 是遠程服務器的 ip,
port: 用于遠程socket 連接的端口, 注意不要和項目端口一致, 否則可能會導致項目啟動失敗
然后idea 會為我們自動生成一條命令行參數:
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10010

遠程項目啟動參數
如果是使用的 java -jar xxx.jar 啟動, 只需要在原來的啟動方式加入第1步生成的參數即可. 例如

## 注意socket端口(address) 需要根據第一步自己設置的端口來配置java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10010 -jar xxx.jar

重新啟動項目
本地代碼要和遠程的代碼保持一致, 否則有可能會導致調試失敗
在遠程項目啟動成功后, 在本地運行第一步的遠程配置

注意事項

如果服務器配置了 iptables/防火墻 , 需要放開對應的端口

如果使用的是云服務器, 則也需要放開對應socket端口的安全組

如果使用開發工具的是eclipse , 遠程調試見這位大佬的博客傳送門

如果使用docker 部署的jar, 則需要進行如下配置

docker 項目進行遠程調試

本質和上面步驟差不多, 但是需要在docker 中, 添加一個內部端口和外部端口的映射
以便我們本地能夠通過這個映射訪問docker 項目部署的容器

步驟:

修改 DockerFile 文件
在DockerFile 中的項目啟動參數的位置添加idea 生成的參數
(也可以復制下面參數, 只需修改為自己設置的socket 連接端口)
-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10010

部分DockerFile文件展示

FROM java:8COPY xxx.jar xxx.jarEXPOSE 8081ENTRYPOINT ["java","-Duser.timezone=GMT+8","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=10010","-jar","/xxx.jar"]

配置Docker 鏡像啟動參數
利用 -p hostPort:containerPort 參數將 docker 容器內部 10010 端口映射到項目部署服務器的 10010 端口;
xxx 為項目名

docker run -d --restart=always --name xxx -p 8081:8081 -p 10010:10010 \ -v /home:/home \ -v /home/szhyyt-logs/xxx/:/logs \ -v /home/xxx/upload:/upload \xxx:0.0.1 --spring.profiles.active=prod

啟動docker 鏡像, 本地運行 Remote Jvm Debug 配置

關于遠程調試原理和配置參數解釋. 如果還想了解更多請見這里