使用Arthas的Watch命令记录Java函数参数和返回值

Arthas是Alibaba开源的Java诊断工具，它能够在不重启JVM的情况下，对运行中的Java应用程序进行诊断，包括查看JVM信息、线程信息、内存信息、方法执行情况等。其中，Watch命令是Arthas中非常实用的一个功能，它可以用来观察方法执行过程中的参数和返回值。

1. 安装Arthas

首先，确保你的Java应用程序已经运行，并且你已经安装了Arthas。Arthas可以通过在线安装或离线安装方式进行安装。在线安装只需在命令行中执行一段命令即可，而离线安装需要先下载Arthas的jar包，然后将其连接到目标Java进程。

2. 连接到目标Java进程

使用Arthas前，需要连接到目标Java进程。在命令行中执行以下命令：

java -jar arthas-boot.jar

然后选择你想要连接的Java进程编号。

3. 使用Watch命令

一旦连接到目标Java进程，就可以使用Watch命令来观察方法执行过程中的参数和返回值。Watch命令的基本语法如下：

watch [-n interval] [-x] [-e] [-s] [-i <module>] [-c <class>] [-m <method>] [-f file] [-h] [expression]

• -n interval：观察频率，单位是毫秒，默认值是2000毫秒。
• -x：是否打印方法的异常信息。
• -e：开启正则表达式匹配。
• -s：输出参数的字符串形式。
• -i <module>：指定观察的目标模块名。
• -c <class>：指定观察的目标类名。
• -m <method>：指定观察的目标方法名。
• -f file：将观察结果输出到指定文件。
• -h：打印帮助信息。
• expression：观察表达式，可以是方法的返回值、参数等。

4. 案例演示

假设我们有一个简单的Java类Demo，其中有一个方法add，该方法接受两个整数参数并返回它们的和。我们可以使用Watch命令来观察这个方法的参数和返回值。

首先，在命令行中执行以下命令来观察Demo类的add方法：

watch Demo add '{params,returnObj}'

这将会输出类似以下的结果：

Press Ctrl+C to abort.
Affect(class count: 1 , method count: 1) cost in 24 ms.
timestamp=2023-04-18T10:20:30.123456789, thread=main, class=Demo, method=add, args=[10, 20], returnObj=30
timestamp=2023-04-18T10:20:35.123456789, thread=main, class=Demo, method=add, args=[20, 30], returnObj=50
...

每一行输出都包含了时间戳、线程名、类名、方法名、参数列表和返回值。这样，我们就可以在运行时分析add方法的行为，包括参数和返回值的变化情况。

5. 总结

通过使用Arthas的Watch命令，我们可以方便地观察Java函数的参数和返回值，从而帮助我们在运行时分析函数的行为。这对于调试和优化Java应用程序非常有用。希望本文能够帮助你更好地理解和使用Arthas的Watch命令。