java诊断工具-Arthas（watch命令）方法观察神器

能方便的观察到指定方法的调用情况。能观察到的范围为：返回值、抛出异常、入参。 

watch

1、得到要观察类的类属性以及值，调用类方法

2、得到类对象的属性以及值

3、得到方法调用前后的入参、出参值

4、根据调用时长，入参匹配条件，异常情况过滤方法调用情况

参数说明

watch 的参数比较多，主要是因为它能在 4 个不同的场景观察对象。

参数名称	参数说明
class-pattern	类名表达式匹配
method-pattern	方法名表达式匹配
express	观察表达式，默认值：{params, target, returnObj}
condition-express	条件表达式
[b]	在方法调用之前观察
[e]	在方法异常之后观察
[s]	在方法返回之后观察
[f]	在方法结束之后(正常返回和异常返回)观察
[E]	开启正则表达式匹配，默认为通配符匹配
[x:]	指定输出结果的属性遍历深度，默认为 1

特别说明：

• watch 命令定义了4个观察事件点，即 -b 方法调用前，-e 方法异常后，-s 方法返回后，-f 方法结束后

• 4个观察事件点 -b、-e、-s 默认关闭，-f 默认打开，当指定观察点被打开后，在相应事件点会对观察表达式进行求值并输出

• 这里要注意方法入参和方法出参的区别，有可能在中间被修改导致前后不一致，除了 -b 事件点 params 代表方法入参外，其余事件都代表方法出参

• 当使用 -b 时，由于观察事件点是在方法调用前，此时返回值或异常均不存在

• 在watch命令的结果里，会打印出location信息。location有三种可能值：AtEnter，AtExit，AtExceptionExit。对应函数入口，函数正常return，函数抛出异常。

 1、观察方法入参

watch demo.MathGame primeFactors “{params,returnObj}” -x 2 -b

执行结果如下图所示 

 result中的Object数组为入参，类型为Integer值分别为-198028，-134246，-2551等。

-b表示观察点为方法调用前。此时方法刚封装好形参，还没有进入方法执行体。

2、同时观察方法调用前和方法返回后

watch demo.MathGame primeFactors “{params,target,returnObj}” -x 2 -b -s -n 2

 以上命令可以将调用方法前（-b参数）”{params,target,returnObj}”即入参，this对象和返回参数返回。

可以将调用方法返回后（-s参数）的”{params,target,returnObj}”即入参，this对象和返回参数返回。

如果参数形式为”{params,returnObj}”只返回入参和回参。

以上所有结果均在result中体现。

• 参数里-n 2，表示只执行两次

• 这里输出结果中，第一次输出的是方法调用前的观察表达式的结果，第二次输出的是方法返回后的表达式的结果

• 结果的输出顺序和事件发生的先后顺序一致，和命令中 -s -b 的顺序无关

3、 调整-x的值，观察具体的方法参数值

watch demo.MathGame primeFactors “{params,target,returnObj}” -x 3 -b -s -n 2

• -x表示遍历深度，可以调整来打印具体的参数和结果内容，默认值是1。

可以看到MathGame类的实例中的属性和值。

4、入参条件表达式

watch demo.MathGame primeFactors “{params[0],target}” “params[0]

 过滤出来方法调用前匹配条件为参数>0的入参和this对象，只有满足条件的调用才会返回。

5、按照耗时进行过滤

watch demo.MathGame primeFactors ‘{params, returnObj}’ ‘#cost>2’ -x 2

 过滤出来时长调用大于2ms的。

6、观察异常信息

watch demo.MathGame primeFactors “{params[0],throwExp}” -e -x 2

• -e 表示抛出异常时才触发

• express中，表示异常信息的变量是throwExp

7、访问当前对象中的某个属性

watch demo.MathGame primeFactors ‘target.illegalArgumentCount’

 8、获取类的静态字段、调用类的静态方法

获取类的静态字段

 watch demo.MathGame * ‘{params,@demo.MathGame@random.nextInt(100)}’ -v -n 1 -x 2

 调用类的静态方法。

参考

arthas官方文档