update watch.md

This commit is contained in:
hengyunabc
2021-10-20 10:58:47 +08:00
parent 6c56c9eed3
commit 8c0e080ed8
+18 -18
View File
@@ -3,9 +3,9 @@ watch
[`watch`在线教程](https://arthas.aliyun.com/doc/arthas-tutorials.html?language=cn&id=command-watch)
> 方法执行数据观测
> 函数执行数据观测
让你能方便的观察到指定方法的调用情况。能观察到的范围为:`返回值``抛出异常``入参`,通过编写 OGNL 表达式进行对应变量的查看。
让你能方便的观察到指定函数的调用情况。能观察到的范围为:`返回值``抛出异常``入参`,通过编写 OGNL 表达式进行对应变量的查看。
### 参数说明
@@ -14,13 +14,13 @@ watch 的参数比较多,主要是因为它能在 4 个不同的场景观察
|参数名称|参数说明|
|---:|:---|
|*class-pattern*|类名表达式匹配|
|*method-pattern*|方法名表达式匹配|
|*method-pattern*|函数名表达式匹配|
|*express*|观察表达式,默认值:`{params, target, returnObj}`|
|*condition-express*|条件表达式|
|[b]|在**方法调用之前**观察|
|[e]|在**方法异常之后**观察|
|[s]|在**方法返回之后**观察|
|[f]|在**方法结束之后**(正常返回和异常返回)观察|
|[b]|在**函数调用之前**观察|
|[e]|在**函数异常之后**观察|
|[s]|在**函数返回之后**观察|
|[f]|在**函数结束之后**(正常返回和异常返回)观察|
|[E]|开启正则表达式匹配,默认为通配符匹配|
|[x:]|指定输出结果的属性遍历深度,默认为 1|
@@ -33,10 +33,10 @@ watch 的参数比较多,主要是因为它能在 4 个不同的场景观察
**特别说明**
* watch 命令定义了4个观察事件点,即 `-b` 方法调用前,`-e` 方法异常后,`-s` 方法返回后,`-f` 方法结束后
* watch 命令定义了4个观察事件点,即 `-b` 函数调用前,`-e` 函数异常后,`-s` 函数返回后,`-f` 函数结束后
* 4个观察事件点 `-b``-e``-s` 默认关闭,`-f` 默认打开,当指定观察点被打开后,在相应事件点会对观察表达式进行求值并输出
* 这里要注意`方法入参``方法出参`的区别,有可能在中间被修改导致前后不一致,除了 `-b` 事件点 `params` 代表方法入参外,其余事件都代表方法出参
* 当使用 `-b` 时,由于观察事件点是在方法调用前,此时返回值或异常均不存在
* 这里要注意`函数入参``函数出参`的区别,有可能在中间被修改导致前后不一致,除了 `-b` 事件点 `params` 代表函数入参外,其余事件都代表函数出参
* 当使用 `-b` 时,由于观察事件点是在函数调用前,此时返回值或异常均不存在
* 在watch命令的结果里,会打印出`location`信息。`location`有三种可能值:`AtEnter``AtExit``AtExceptionExit`。对应函数入口,函数正常return,函数抛出异常。
### 使用参考
@@ -44,7 +44,7 @@ watch 的参数比较多,主要是因为它能在 4 个不同的场景观察
启动[快速入门](quick-start.md)里的`math-game`
#### 观察方法出参、this对象和返回值
#### 观察函数调用返回时的参数、this对象和返回值
> 观察表达式,默认值是`{params, target, returnObj}`
@@ -84,7 +84,7 @@ ts=2021-08-31 15:22:58; [cost=1.020982ms] result=@ArrayList[
* 在第二次结果里是`location=AtExit`,说明函数正常返回,因此可以看到`returnObj`结果是一个ArrayList
#### 观察方法入参
#### 观察函数调用入口的参数和返回值
```bash
$ watch demo.MathGame primeFactors "{params,returnObj}" -x 2 -b
@@ -98,10 +98,10 @@ ts=2018-12-03 19:23:23; [cost=0.0353ms] result=@ArrayList[
]
```
* 对比前一个例子,返回值为空(事件点为方法执行前,因此获取不到返回值)
* 对比前一个例子,返回值为空(事件点为函数执行前,因此获取不到返回值)
#### 同时观察方法调用前和方法返回后
#### 同时观察函数调用前和函数返回后
```bash
$ watch demo.MathGame primeFactors "{params,target,returnObj}" -x 2 -b -s -n 2
@@ -140,11 +140,11 @@ ts=2018-12-03 19:29:54; [cost=4.277392ms] result=@ArrayList[
* 参数里`-n 2`,表示只执行两次
* 这里输出结果中,第一次输出的是方法调用前的观察表达式的结果,第二次输出的是方法返回后的表达式的结果
* 这里输出结果中,第一次输出的是函数调用前的观察表达式的结果,第二次输出的是函数返回后的表达式的结果
* 结果的输出顺序和事件发生的先后顺序一致,和命令中 `-s -b` 的顺序无关
#### 调整`-x`的值,观察具体的方法参数值
#### 调整`-x`的值,观察具体的函数参数值
```bash
$ watch demo.MathGame primeFactors "{params,target}" -x 3
@@ -234,7 +234,7 @@ ts=2018-12-03 19:40:28; [cost=2112.168897ms] result=@ArrayList[
#### 观察当前对象中的属性
如果想查看方法运行前后,当前对象中的属性,可以使用`target`关键字,代表当前对象
如果想查看函数运行前后,当前对象中的属性,可以使用`target`关键字,代表当前对象
```bash
$ watch demo.MathGame primeFactors 'target'
@@ -256,7 +256,7 @@ ts=2018-12-03 20:04:34; [cost=131.303498ms] result=@Integer[8]
ts=2018-12-03 20:04:35; [cost=0.961441ms] result=@Integer[8]
```
#### 获取类的静态字段、调用类的静态方法的例子
#### 获取类的静态字段、调用类的静态函数的例子
```bash
watch demo.MathGame * '{params,@demo.MathGame@random.nextInt(100)}' -v -n 1 -x 2