前言 本文将探讨如何处理和调试那些仅在生产环境(或其他远程环境)中发生,而本地开发环境无法重现的“问题”。任何遇到这种情况的人都必须承认,试图找出这种“问题”原因的过程,很可能以一堆无根据的猜测告终:这是一个非常耗时且效率低下的过程。
还有一种情况,你得到了一个可以部署的war/jar包,只有class文件而没有java源代码,而应用在本地/远程部署后,是否可以调试?读完本文,你将明白如何操作。
配置远程调试包括两个步骤:
- 启动Tomcat并启用远程调试
- 使用IDE(这里使用IntelliJ IDEA)调试远程Tomcat应用
Tomcat启用远程调试 有多种方法可以实现这一点,根据Tomcat运行的操作系统略有不同。然而,无论使用哪种方法,这些配置的背后都是传递特定的启动参数给JVM,让它启用远程调试(remote debugging)。JVM激活远程调试的启动参数有JPDA_OPTS、CATALINA_OPTS和JAVA_OPTS。其中,JAVA_OPTS通常不建议使用,因为基于JAVA_OPTS的参数设置会暴露给所有JVM应用,而CATALINA_OPTS定义的设置值仅限于Tomcat内部。
- 使用JPDA_OPTS 在CATALINA_HOME/bin目录下创建可执行脚本文件setenv.sh(Windows下创建setenv.bat),并加入以下内容:
Linux setenv.sh
Windows setenv.bat
立即学习“Java免费学习笔记(深入)”;
这些参数的作用是启用远程调试并配置有效的选项:
- 指定调试应用和调试者之间的通信协议(例如:transport=dt_socket)
- 远程被调试应用开启的端口(例如:address=1043),可定义其他端口,如9999
- server=y表示这个JVM即将被调试
- suspend=n告知JVM立即执行,不要等待未来将要附着的调试者。如果设置为y,应用将暂停运行,直到有调试者连接
当然,上面的设置也可以直接放到catalina.sh(catalina.bat)内,但使用setenv.*配置文件是更好的选择,因为Tomcat会自动读取。
需要注意的是,有些人可能会使用另一种配置方法来启用远程调试:
-Xdebug和-Xrunjdwp与我们推荐的设置不同之处在于,它是一种旧方式,适用于JVM小于JAVA 5.0的版本(包括5.0),而agentlib:jdwp适用于JAVA 5.0及以后版本。
最后,通过以下命令行启动Tomcat,即可完成Tomcat启用远程调试:
- 使用JAVA_OPTS/CATALINA_OPTS 如果你是在Windows系统上将Tomcat作为系统服务来运行的,直接打开Apache Tomcat的属性对话框,在Java选项卡中添加启动参数:
但如果Tomcat没有作为Windows系统服务,启用方法与前面类似,在setenv.bat文件中写入:
如果运行在Linux上,在setenv.sh中写入:
按照普通的方式启动Tomcat即可:
- 使用JPDA启动 最后一种启用远程调试的方式是使用JPDA切换,使用以下启动命令将使用默认值自动启用远程调试:
该命令默认使用的设置是:
如果你想要修改默认设置中的选项,可以通过修改Tomcat需要的这些环境变量来实现:
然后再运行catalina jpda start,远程调试的端口将变成8080。
配置IntelliJ IDEA 确定远程Tomcat启动的应用已经开启了远程调试,接下来就是配置IntelliJ IDEA了。这里有两种方式:Remote Tomcat或Remote。
- 使用Remote Tomcat配置 首先确保IDEA中已经打开了需要远程调试的工程源码,然后点击Run Edit Configurations +按钮 Tomcat Server Remote。
输入必要的远程IP地址和端口(Tomcat http端口);
然后转到Startup/Connection选项卡页,选择“Debug”,输入远程调试端口,我们的例子是1043。
保存后,开始调试启动远程调试,如果运行成功会显示如下的界面,然后在源码中加断点开始调试。
- 使用Remote配置(推荐) 第一个方法有一个缺陷,你打开的工程源码必须是编译通过的工程,否则会启动时报错;而介绍的这第二种方法可以在你的工程目录乱七八糟,不是一个完整的可以部署的工程,甚至是一个解压缩的war/jar的情况下都可以调试。
同上步骤,只是选择“Remote”,然后输入Name,修改Host,Port(1043)即可,保存后开始Debug。
设置比Remote Tomcat更简单,这里介绍一个实际案例。
我手上有一个可部署的war包,没有源码,在远程已经部署完毕。这时我想调试那个远程应用,怎么做呢?
解压缩war包到一个文件夹,然后用IntelliJ IDEA打开这个文件夹,如图的结构,编译的Class都在WEB-INF/classes目录下。
找到我要调试的那个class,这里示例Handler.class,通过Idea反编译出来的类代码,拷贝到一个新的文件Handler.java。
虽然如图可以看到各种编译错误,但完全不影响你启动,代码中加断点和调试哦。
远程JVM调试的工作原理源于被称为Agents的东西。
运行各种编译后的.class文件的JVM,有一种特性,可以允许外部的库(Java或C++写的libraries)在运行时注入到JVM中。这些外部的库就称为Agents,它们有能力修改运行中的.class文件的内容。
这些Agents拥有的这些JVM的功能权限,是在JVM内运行的Java Code所无法获取的,它们能用来做一些有趣的事情,比如修改运行中的源码,性能分析等。像JRebel工具就是利用这些功能达到魔术般的效果。
通过添加-agentlib:libname[=options]格式的启动参数,可以将一个Agent Lib传递给JVM。像上面的远程调试我们用的就是-agentlib:jdwp=…来引入jdwp这个Agent的。
jdwp是一个JVM特定的JDWP(Java Debug Wire Protocol)可选实现,用来定义调试者与运行JVM之间的通信,它是通过JVM本地库的jdwp.so或者jdwp.dll支持实现的。
它到底是如何工作的呢?简单来说,jdwp agent会建立运行应用的JVM和调试者(本地或远程)之间的桥梁。既然它是一个Agent Library,它就有能力拦截运行的代码。
在JVM架构中,调试功能在JVM本身的内部是找不到的,它是一种抽象到外部工具的方式(也称为调试者debugger)。这些调试工具可以运行在JVM的本地或远程。这是一种解耦,模块化的架构。
更多关于远程部署相关,以及JDWP的深入说明,大家有兴趣可以自己研究一下。