前言

Arthas 3.0中使用ognl表达式替换了groovy来实现表达式的求值功能，解决了groovy潜在会出现内存泄露的问题。灵活运用ognl表达式，能够极大提升问题排查的效率。

ognl官方文档：https://commons.apache.org/proper/commons-ognl/language-guide.html

一个测试应用

  1. import java.util.ArrayList;
  2. import java.util.HashMap;
  3. import java.util.List;
  4. import java.util.Map;
  5. import java.util.Random;
  6.  
  7. /**
  8.  * @author zhuyong on 2017/9/13.
  9.  */
  10. public class Test {
  11.  
  12.     public static final Map m = new HashMap<>();
  13.     public static final Map n = new HashMap<>();
  14.  
  15.     static {
  16.         m.put("a", "aaa");
  17.         m.put("b", "bbb");
  18.  
  19.         n.put(Type.RUN, "aaa");
  20.         n.put(Type.STOP, "bbb");
  21.     }
  22.  
  23.     public static void main(String[] args) throws InterruptedException {
  24.         List<Pojo> list = new ArrayList<>();
  25.  
  26.         for (int i = 0; i < 40; i ++) {
  27.             Pojo pojo = new Pojo();
  28.             pojo.setName("name " + i);
  29.             pojo.setAge(i + 2);
  30.  
  31.             list.add(pojo);
  32.         }
  33.  
  34.         while (true) {
  35.             int random = new Random().nextInt(40);
  36.  
  37.             String name = list.get(random).getName();
  38.             list.get(random).setName(null);
  39.  
  40.             test(list);
  41.  
  42.             list.get(random).setName(name);
  43.  
  44.             Thread.sleep(1000l);
  45.         }
  46.     }
  47.  
  48.     public static void test(List<Pojo> list) {
  49.  
  50.     }
  51.  
  52.     public static void invoke(String a) {
  53.         System.out.println(a);
  54.     }
  55.  
  56.     static class Pojo {
  57.         String name;
  58.         int age;
  59.         String hobby;
  60.  
  61.         public String getName() {
  62.             return name;
  63.         }
  64.  
  65.         public void setName(String name) {
  66.             this.name = name;
  67.         }
  68.  
  69.         public int getAge() {
  70.             return age;
  71.         }
  72.  
  73.         public void setAge(int age) {
  74.             this.age = age;
  75.         }
  76.  
  77.         public String getHobby() {
  78.             return hobby;
  79.         }
  80.  
  81.         public void setHobby(String hobby) {
  82.             this.hobby = hobby;
  83.         }
  84.     }
  85. }
  86.  
  87. public enum Type {
  88.     RUN, STOP;
  89. }

查看第一个参数

params是参数列表，是一个数组，可以直接通过下标方式访问

  1. $ watch Test test params[0] -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 26 ms.
  4. @ArrayList[
  5.     @Pojo[Test$Pojo@6e2c634b],
  6.     @Pojo[Test$Pojo@37a71e93],
  7.     @Pojo[Test$Pojo@7e6cbb7a],
  8.     ...
  9. ]
这里的-n表示只输出一次

查看数组中的元素

第一个参数是一个List，想要看List中第一个Pojo对象，可以通过下标方式，也可以通过List的get方法访问。

  1. $ watch Test test params[0][0] -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 14 ms.
  4. @Pojo[
  5.     name=@String[name 0],
  6.     age=@Integer[2],
  7.     hobby=null,
  8. ]
  10. $ watch Test test params[0].get(0) -n 1
  11. Press Ctrl+C to abort.
  12. Affect(class-cnt:1 , method-cnt:1) cost in 14 ms.
  13. @Pojo[
  14.     name=@String[name 0],
  15.     age=@Integer[2],
  16.     hobby=null,
  17. ]

查看Pojo的属性

拿到这个Pojo可以，直接访问Pojo的属性，如age

  1. $ watch Test test params[0].get(0).age -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 21 ms.
  4. @Integer[2]

还可以通过下标的方式访问params[0][0]["age"]，这个写法等效于params[0][0].age：

  1. $ watch Test test params[0][0]["name"] -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 53 ms.
  4. watch failed, condition is: null, express is: params[0][0][age], ognl.NoSuchPropertyException: com.taobao.arthas.core.advisor.Advice.age, visit /Users/wangtao/logs/arthas/arthas.log for more details.

但这样会报错，这时候需要再加一个引号

  1. $ watch Test test 'params[0][0]["age"]' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 25 ms.
  4. @Integer[2]

集合投影

有时候我们只需要抽取对象数组中的某一个属性，这种情况可以通过投影来实现，比如要将Pojo对象列表中的name属性单独抽出来，可以通过params[0].{name}这个表达式来实现。 ognl会便利params[0]这个List取出每个对象的name属性，重新组装成一个新的数组。用法相当于Java stream中的map函数。

  1. $ watch Test test params[0].{name} -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 56 ms.
  4. @ArrayList[
  5.     @String[name 0],
  6.     @String[name 1],
  7.     @String[name 2],
  8.     @String[name 3],
  9.     null,
  10.     @String[name 5],
  11.     @String[name 6],
  12.     @String[name 7],
  13.     @String[name 8],
  14.     @String[name 9],
  15. ]

集合过滤

有时候还需要针对集合对象按某种条件进行过滤，比如想找出所有age大于5的Pojo的name，可以这样写

  1. $ watch Test test "params[0].{? #this.age > 5}.{name}" -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 25 ms.
  4. @ArrayList[
  5.     @String[name 4],
  6.     @String[name 5],
  7.     @String[name 6],
  8.     null,
  9.     @String[name 8],
  10.     @String[name 9],
  11. ]

其中{? #this.age > 5} 相当于stream里面的filter，后面的name相当于stream里面的map

那如果要找到第一个age大于5的Pojo的name，怎么办呢？可以用^或$来进行第一个或最后一个的匹配，像下面这样:

  1. $ watch Test test "params[0].{^ #this.age > 5}.{name}" -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 24 ms.
  4. @ArrayList[
  5.     @String[name 4],
  6. ]
  7. Command hit execution time limit 1, therefore will be aborted.
  8. $ watch Test test "params[0].{$ #this.age > 5}.{name}" -n 1
  9. Press Ctrl+C to abort.
  10. Affect(class-cnt:1 , method-cnt:1) cost in 43 ms.
  11. @ArrayList[
  12.     @String[name 9],
  13. ]

多行表达式

有些表达式一行之内无法表达，需要多行才能表达，应该怎么写的？比如，假设我们要把所有Pojo的name拿出来，再往里面新加一个新的元素，在返回新的列表，应该如何写？可以通过中括号将多个表达式串联起来，最后一个表达式的返回值代表整个表达式的最终结果。临时变量可以用#来表示。

  1. $ watch Test test '(#test=params[0].{name}, #test.add("abc"), #test)' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 28 ms.
  4. @ArrayList[
  5.     @String[name 0],
  6.     @String[name 1],
  7.     @String[name 2],
  8.     @String[name 3],
  9.     @String[name 4],
  10.     @String[name 5],
  11.     @String[name 6],
  12.     @String[name 7],
  13.     @String[name 8],
  14.     null,
  15.     @String[abc],
  16. ]

调用构造函数

调用构造函数，必须要指定要创建的类的全类名。比如下面的例子中，创建一个新的list，然后添加一个新的元素，然后返回添加后的list。

  1. $ watch Test test '(#test=new java.util.ArrayList(), #test.add("abc"), #test)' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 37 ms.
  4. @ArrayList[
  5.     @String[abc],
  6. ]

访问静态变量

可以通过@class@filed方式访问，注意需要填写全类名

  1. $ watch Test test '@Test@m' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 35 ms.
  4. @HashMap[
  5.     @String[a]:@String[aaa],
  6.     @String[b]:@String[bbb],
  7. ]

调用静态方法

可以通过@class@method(args)方式访问，注意需要填写全类名

  1. $ watch Test test '@java.lang.System@getProperty("java.version")' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 42 ms.
  4. @String[1.8.0_51]

静态方法和非静态方法结合，例如想要获取当前方法调用的TCCL，可以像下面这样写：

  1. $ watch Test test '@java.lang.Thread@currentThread().getContextClassLoader()' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 84 ms.
  4. @AppClassLoader[
  5.     ucp=@URLClassPath[sun.misc.URLClassPath@4cdbe50f],
  6.     $assertionsDisabled=@Boolean[true],
  7. ]

访问Map中的元素

Test.n是一个HashMap，假设要获取这个Map的所有key，ongl针对Map接口提供了keys, values这两个虚拟属性，可以像普通属性一样访问。

  1. $ watch Test test '@Test@n.keys' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 57 ms.
  4. @KeySet[
  5.     @Type[RUN],
  6.     @Type[STOP],
  7. ]

因为这个Map的Key是一个Enum，假设要把key为RUN这个值的value取出来应该怎么写呢？可以通过Enum的valueOf方法来创建一个Enum，然后get出来，比如下面一样

  1. $ watch Test test '@Test@n.get(@Type@valueOf("RUN"))' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 168 ms.
  4. @String[aaa]

或者是下面这样，通过迭代器+过滤的方式：

  1. $ watch Test test '@Test@n.entrySet().iterator.{? #this.key.name() == "RUN"}' -n 1
  2. Press Ctrl+C to abort.
  3. Affect(class-cnt:1 , method-cnt:1) cost in 72 ms.
  4. @ArrayList[
  5.     @Node[RUN=aaa],
  6. ]

附录: ognl内置的ognl的虚拟属性

  • Collection:
    • size
    • isEmpty
  • List:
    • iterator
  • Map:
    • keys
    • values
  • Set:
    • iterator
  • Iterator:
    • next
    • hasNext
  • Enumeration:
    • next
    • hasNext
    • nextElement
    • hasMoreElements

最后

欢迎在留言区分享你的牛逼用法，互相交流进步~

原文: https://github.com/alibaba/arthas/issues/11