Java项目开启远程调试（tomcat、springboot）

Dear 丶 2022-06-13 14:09 299阅读 0赞

当我们运行一个项目的时候，一般都是在本地进行debug。但是如果是一个分布式的微服务，这时候我们选择远程debug是我们开发的利器。

# 环境 #

apache-tomcat-8.5.16

Linux

# 如何启用远程调试 #

## tomcat开启远程调试 ##

### 方法 ###

切换到你的tomcat的bin目录`/apache-tomcat-8.5.16/bin`下，执行:

./catalina.sh jpda start

执行上面的命令就可以开启远程debug了，如果想配置一些信息，比如端口号什么的，请参考下面的说明。

### 参数说明 ###

# JPDA_TRANSPORT (Optional) JPDA transport used when the "jpda start"
    # command is executed. The default is "dt_socket".
    #
    # JPDA_ADDRESS (Optional) Java runtime options used when the "jpda start"
    # command is executed. The default is localhost:8000.
    #
    # JPDA_SUSPEND (Optional) Java runtime options used when the "jpda start"
    # command is executed. Specifies whether JVM should suspend
    # execution immediately after startup. Default is "n".
    #
    # JPDA_OPTS (Optional) Java runtime options used when the "jpda start"
    # command is executed. If used, JPDA_TRANSPORT, JPDA_ADDRESS,
    # and JPDA_SUSPEND are ignored. Thus, all required jpda
    # options MUST be specified. The default is:
    #
    # -agentlib:jdwp=transport=$JPDA_TRANSPORT,
    # address=$JPDA_ADDRESS,server=y,suspend=$JPDA_SUSPEND

### 操作说明 ###

所以如果想修改配置，则如下操作：

1.  在catalina.sh中进行配置：
    
        JPDA_TRANSPORT=dt_socket 
        JPDA_ADDRESS=5005 
        JPAD_SUSPEND=n
2.  或者通过JPDA\_OPTS进行配置：
    
        JPDA_OPTS='-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005’

## springboot开启远程调试 ##

[远程调试maven设置][maven]

The run goal forks a process for the boot application. It is possible to specify jvm arguments to that forked process. The following configuration suspend the process until a debugger has joined on port 5005

<project>
      ...
      <build>
        ...
        <plugins>
          ...
          <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <version>1.1.12.RELEASE</version>
            <configuration>
              <jvmArguments>
                -Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005
              </jvmArguments>
            </configuration>
            ...
          </plugin>
          ...
        </plugins>
        ...
      </build>
      ...
    </project>

These arguments can be specified on the command line as well, make sure to wrap that properly, that is:

mvn spring-boot:run -Drun.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=5005"

## jar 命令开启远程调试 ##

在执行jar的时候，添加上参数。如下：

java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n -jar demo.jar

如果想深入了解Java调试，那么去看一下这个吧。[深入Java调试体系][Java]

# 问题 #

如果出现`Connection refused`。

首先检查一下端口8000的使用情况:

use:~/tomcat/logs # netstat -an|grep 8000
    cp        0      0 127.0.0.1:8000          0.0.0.0:*               LISTEN

可见当前16808端口服务被绑定了回环地址，外部无法访问。即本地调试。

办法：

修改catalina.sh中一个参数。

if [ -z "$JPDA_TRANSPORT" ]; then
        JPDA_TRANSPORT="dt_socket"
      fi
      if [ -z "$JPDA_ADDRESS" ]; then
        JPDA_ADDRESS="0.0.0.0:8000"
      fi
      if [ -z "$JPDA_SUSPEND" ]; then
        JPDA_SUSPEND="n"
      fi

对`JPDA_ADDRESS="localhost:8000"` 把默认值（localhost:8000）改成0.0.0.0:8000。默认是本地ip调试也就是无法远程调试，0.0.0.0表示所有ip地址都能调试。

远程连上后再看端口情况：

root@VM-198-217-ubuntu:/opt/apache-tomcat-8.5.16/bin# netstat -an | grep 8000
    tcp        0      0 10.133.198.217:8000     60.177.99.27:49998      ESTABLISHED

断开后是这样的：

root@VM-198-217-ubuntu:/opt/apache-tomcat-8.5.16/bin# netstat -an | grep 8000
    tcp        0      0 0.0.0.0:8000            0.0.0.0:*               LISTEN
    tcp        0      0 10.133.198.217:8000     60.177.99.27:49998      TIME_WAIT

# idea连接远程端口进行远程debug #

我已经在服务器上开启了远程调试，idea连接的步骤，直接上图。

1.  edit configurations
    
    ![edit configurations][]
2.  远程调试配置  
    ![远程调试配置][SouthEast]
3.  参数配置  
    ![参数配置][SouthEast 1]
    
    将红框内的地址和端口号改成自己的。
    
    ![参数配置][SouthEast 2]
4.  启动远程调试  
    ![启动远程调试][SouthEast 3]
5.  成功界面
    
    ![成功界面][SouthEast 4]
6.  请求一下试试
    
    ![试试][SouthEast 5]

调试的姿势和本地调试一样，开始造起来吧！

--------------------

参考资料：  
网上资料  
备注：  
转载请注明出处：[http://blog.csdn.net/wsyw126/article/details/74853680][http_blog.csdn.net_wsyw126_article_details_74853680]  
作者：WSYW126

[maven]: http://docs.spring.io/spring-boot/docs/1.1.x/maven-plugin/examples/run-debug.html
[Java]: https://www.ibm.com/developerworks/cn/views/java/libraryview.jsp?search_by=%E6%B7%B1%E5%85%A5%20Java%20%E8%B0%83%E8%AF%95%E4%BD%93%E7%B3%BB
[edit configurations]: /images/20220613/d653ae668eb74ff3b6ec6ebf4fa58d33.png
[SouthEast]: /images/20220613/7dd702e9955746ba888c7bd2827c28d2.png
[SouthEast 1]: /images/20220613/11388d536306442c9ea89cf83c65e395.png
[SouthEast 2]: /images/20220613/e6c140ef664a47edb61f55ca193b4d07.png
[SouthEast 3]: /images/20220613/763f69179ef8414abcc2012592b580da.png
[SouthEast 4]: /images/20220613/937275a5d72942bfb811ee185fc785f9.png
[SouthEast 5]: /images/20220613/9aadda5d731042818a4841262e2e9535.png
[http_blog.csdn.net_wsyw126_article_details_74853680]: http://blog.csdn.net/wsyw126/article/details/74853680