快捷導(dǎo)航

java實現(xiàn)線上環(huán)境遠(yuǎn)程debug調(diào)試過程

更新時間：2025年02月14日 10:20:25 作者：趙廣陸

本文介紹了在Docker容器中配置Tomcat和Spring Boot進(jìn)行遠(yuǎn)程調(diào)試的方法,通過配置`CATALINA_OPTS`或`JPDA`參數(shù),可以在測試環(huán)境中啟動Tomcat或Spring Boot應(yīng)用的debug模式,然后在本地IDEA中設(shè)置斷點進(jìn)行調(diào)試,從而更高效地定位和解決問題

docker中tomcat實現(xiàn)遠(yuǎn)程調(diào)試配置

由于部署環(huán)境的差異性，相信很多朋友都碰到過開發(fā)環(huán)境正常測試過的功能在測試環(huán)境甚至生產(chǎn)環(huán)境下出現(xiàn)bug的情況。

一般情況下，生產(chǎn)環(huán)境可以采取的手段比較單一，即通過日志的方式獲取運行中的環(huán)境上下文，分析日志文件并嘗試重現(xiàn)bug。

這會帶來的問題還是不少的，首先，日志的分析是一項比較耗時的工作；其次，現(xiàn)有的日志記錄不一定能反映出問題，你可能需要多次重復(fù)這個過程(分析日志->猜測問題->加日志->部署->獲取日志)來慢慢逼近問題。

倘若是測試環(huán)境，我們還多了一項可供選擇的手段——遠(yuǎn)程調(diào)試——將程序在測試環(huán)境中以debug模式啟動，在本機(jī)使用IDEA在工程中設(shè)置斷點進(jìn)行調(diào)試。

配置docker-compose.yml

CATALINA_OPTS參數(shù)配置啟動遠(yuǎn)程調(diào)試功能

version: '2.2'

services:
  test:
    container_name: test
    image: tomcat:8.5.32

    ports:
      - "5005:5005"

    volumes:
      - "./target/test:/usr/local/tomcat/webapps/ROOT"

    environment:
        # tomcat啟動遠(yuǎn)程調(diào)試
        CATALINA_OPTS: "-Xdebug -Xrunjdwp:transport=dt_socket,address=5005,suspend=n,server=y"

    command: ["catalina.sh", "run"]

JPDA參數(shù)配置啟動遠(yuǎn)程調(diào)試功能

version: "3"
services:
  tomcat:
    image: tomcat:8.5.27
    ports:
      - "8080:8080"
      - "5005:5005"
    volumes:
      - ./www:/www:rw
      - ./conf/server.xml:/usr/local/tomcat/conf/server.xml:ro
    environment:
      JPDA_ADDRESS: 5005
      JPDA_TRANSPORT: dt_socket
    command: ["catalina.sh", "jpda", "run"]
    networks:
      - default

  # 需要nginx、mysql、redis、activemq配置都可以在這里加上

networks:
  default:

docker中spring boot實現(xiàn)遠(yuǎn)程調(diào)制配置

首先，我們要讓要讓遠(yuǎn)程服務(wù)器支持遠(yuǎn)程調(diào)試功能，在項目啟動項上追加特定的 JVM 參數(shù)即可，參數(shù)如下：

晚于 JDK 1.4.X 版本

-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=4001

配置docker-compose.yml

app.jar指打包后的spring boot包

version: '2.2'

services:
  test:
    container_name: test

    ports:
      - "8080:8080"
      - "5005:5005"

    CMD ["java","-jar","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005","-Dspring.profiles.active=sit","app.jar"]