![1594893236094-62c94d20-b801-414c-94d6-558d0003175d.png](https://ucc.alicdn.com/pic/developer-ecology/da3471cf24e043e6b6e7a4ed2ffc1201.png)
作者 | 汪吉

**【Arthas 官方社群正在舉行徵文活動，參加即有獎品拿~[點選投稿](http://alibabacloud.mikecrm.com/9khcRrs)】**

# 一、入門步驟

## 1. 安裝

[https://arthas.gitee.io/install-detail.html](https://arthas.gitee.io/install-detail.html)

上述命令會下載啟動指令碼檔案 `as.sh` 到當前目錄：

```
curl -L https://alibaba.github.io/arthas/install.sh | sh
```

or

as.sh 啟動：

```
curl -sk https://arthas.gitee.io/arthas-boot.jar -o ~/.arthas-boot.jar  && echo "alias as.sh='java -jar ~/.arthas-boot.jar --repo-mirror aliyun --use-http'" >> ~/.bashrc && source ~/.bashrc
```

## 2. 線上教程體驗

[https://alibaba.github.io/arthas/arthas-tutorials?language=cn](https://alibaba.github.io/arthas/arthas-tutorials?language=cn)

當然也可以自己本地體驗一下~自己透過下載一個 arthas-idea-plugin 的體驗 demo 直接本地上手。

[https://github.com/WangJi92/arthas-plugin-demo](https://github.com/WangJi92/arthas-plugin-demo)

### 全域性命令說明

- -x 是展示結果屬性遍歷深度，預設為 1
- -n 是執行的次數 ，q 退出
- -c classloader 的hash值
- 退出 q ，關閉 stop

## 3. 瞭解最常用的trace、watch的功能

watch和trace 是arthas 診斷中對於開發人員解決線上的問題最常用的功能！

### trace

#### 基本示例

```
trace com.wangji92.arthas.plugin.demo.controller.CommonController getRandomInteger -n 5 '1==1'
```
[https://arthas.gitee.io/trace.html](https://arthas.gitee.io/trace.html)

- 效能最佳化~
- 呼叫的這個方法，走的具體流程是咋樣的！可以透過呼叫鏈看出來。
- 有異常了可以檢視異常的堆疊。

#### 高階的功能

trace命令只會trace匹配到的函式里的子呼叫，並不會向下trace多層。因為trace是代價比較貴的，多層trace可能會導致最終要trace的類和函式非常多。

trace -E xxxClassA|xxxClassB method1 | method2

```
trace -E com.wangji92.arthas.plugin.demo.controller.CommonController|com.wangji92.arthas.plugin.demo.service.ArthasTestService traceE|doTraceE -n 5 '1==1'
```

### watch

[https://arthas.gitee.io/watch.html](https://arthas.gitee.io/watch.html)

wathc 從字面上理解就是觀察值的資訊，可以檢視入參、返回值、異常、可以執行表示式獲取靜態變數、target.xxx呼叫目標實施的欄位、方法等等都行~只要你想得到沒有做不到的~

#### 基本示例

```
watch com.wangji92.arthas.plugin.demo.controller.CommonController traceE '{params,returnObj,throwExp}' -n 5 -x 3 '1==1'
```

## 4、arthas 表示式核心變數

```
public class Advice {
    private final ClassLoader loader;
    private final Class> clazz;
    private final ArthasMethod method;
    private final Object target;
    private final Object[] params;
    private final Object returnObj;
    private final Throwable throwExp;
    private final boolean isBefore;
    private final boolean isThrow;
    private final boolean isReturn;
    // getter/setter  
}
```

從watch 和 trace 中看到 後面的 '1==1' 執行的是一個條件表示式 當值為true 的時候透過執行了一個[ognl 表示式](https://commons.apache.org/proper/commons-ognl/language-guide.html) ,watch 觀察 params,returnObj,throwExp 入參、返回值、是否異常 這個也是一個表示式，那麼這個到底是咋回事？

### spring el 表示式

沒有學習過ognl 使用多年的[spring 一定知道他的el 表示式](https://docs.spring.io/spring/docs/4.2.x/spring-framework-reference/html/expressions.html)，el 表示式中也有一種概念叫做【Context 上下文，和表示式】 如下所示，因為有了simple這個上下文 才能解析 "booleanList[0]" 這個指令碼的含義~ 這個很熟悉，很好理解，那麼ognl 表示式一樣不難了。

```
class Simple {
    public List<boolean> booleanList = new ArrayList<boolean>();
}
Simple simple = new Simple();
simple.booleanList.add(true);
StandardEvaluationContext simpleContext = new StandardEvaluationContext(simple);
// false is passed in here as a string. SpEL and the conversion service will
// correctly recognize that it needs to be a Boolean and convert it
parser.parseExpression("booleanList[0]").setValue(simpleContext, "false");
// b will be false
Boolean b = simple.booleanList.get(0);
```

### ognl 表示式

arthas 也是一樣的，只是使用了一個叫做ognl的指令碼,核心變數就是他的上下文，可以直接獲取到這些欄位。watch 觀察的這幾個欄位 params,returnObj,throwExp 也就是我們所謂的上下文的概念，觀察引數、返回值、和異常的資訊。

如下是arthas 原始碼中 表示式評估和watch 觀察值執行的程式碼！Advice 就是一個上下文，這裡還增加了一個變數 const。知道了這些那不是很簡單？？

com.taobao.arthas.core.advisor.ReflectAdviceListenerAdapter#isConditionMet

```
/**
     * 判斷條件是否滿足，滿足的情況下需要輸出結果
     * @param conditionExpress 條件表示式
     * @param advice 當前的advice物件
     * @param cost 本次執行的耗時
     * @return true 如果條件表示式滿足
     */
    protected boolean isConditionMet(String conditionExpress, Advice advice, double cost) throws ExpressException {
        return StringUtils.isEmpty(conditionExpress) ||
                ExpressFactory.threadLocalExpress(advice).bind(Constants.COST_VARIABLE, cost).is(conditionExpress);
    }
    protected Object getExpressionResult(String express, Advice advice, double cost) throws ExpressException {
        return ExpressFactory.threadLocalExpress(advice)
                .bind(Constants.COST_VARIABLE, cost).get(express);
    }
```

### 表示式實踐

arthas 群經常有人問過載方法如何判斷，無非就是評估條件？ 引數的個數、第一個引數是什麼？返回值的型別等等都可以作為你評估的條件。如下的watch 前面的一段是觀察的值、後面這一段是表示式評估 ，滿足了條件才執行。

入參長度大於0

```
watch com.wangji92.arthas.plugin.demo.controller.CommonController traceE '{params,returnObj,throwExp}' -n 5 -x 3 'params.length >0'
```

返回值為String 且長度大於5

```
watch com.wangji92.arthas.plugin.demo.controller.CommonController traceE '{params,returnObj,throwExp}' -n 5 -x 3 'returnObj instanceof java.lang.String && returnObj.length>5'
```

### 條件表示式+非同步任務

- 只有特定的場景才會有bug ，如何排查bug？
- 一天只出現一兩次如何解決？

條件表示式主要是用來過濾使用，比如某些場景只是在特定的引數才會出現，肯能會花費很多的時間去等待，這個時候可以使用條件表示式過濾 +[非同步任務](https://arthas.gitee.io/async.html)[更多參考部落格](https://wangji.blog.csdn.net/article/details/105603047)

## 5、ognl 表示式

[https://arthas.gitee.io/ognl.html](https://arthas.gitee.io/ognl.html) 從上面看，ognl 在watch、trace上面無所不能啊，其實還有[tt](https://arthas.gitee.io/tt.html) 也是 使用ognl 表示式執行邏輯的. @xxxClas@xxxStaticField 是靜態變數的語法糖 ognl的，好好看一下官方的文件。OGNL特殊用法請參考：[https://github.com/alibaba/arthas/issues/71](https://github.com/alibaba/arthas/issues/71)

### 獲取靜態變數

靜態變數由於 一個jvm 中可能被多個classloader載入，jvm 認定為一個例項是一個classloader載入哦，所以需要知道當前靜態類的hash 值（sc -d com.wangji92.arthas.plugin.demo.controller.StaticTest）可以透過這個命令獲取。

```
ognl  -x  3 '@com.wangji92.arthas.plugin.demo.controller.StaticTest@INVOKE_STATIC_DOUBLE' -c e374b99
```

### 呼叫spring 方法？

watch 執行ognl 語法中獲取spring context 然後進行呼叫bean的方法

```
watch -x 3 -n 1  org.springframework.web.servlet.DispatcherServlet doDispatch '@org.springframework.web.context.support.WebApplicationContextUtils@getWebApplicationContext(params[0].getServletContext()).getBean("commonController").getRandomInteger()'
```

ognl 執行靜態的一個spring context 然後呼叫bean 的方法

```
ognl -x 3 '#springContext=@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context,#springContext.getBean("commonController").getRandomInteger()' -c e374b99
```

有沒有起飛的感覺，無所不能！前提是你要掌握一些ognl的一些簡單的語法！

## 6、完畢

對於線上排查問題，我感覺這幾個命令夠你用了，還有一些其他的反編譯、火焰圖、.. 時間隧道、logger 等級修改，jvm環境資訊等等感覺是有頻率都沒有上面的高，畢竟jvm資訊有專門的監控~即使沒有arthas 你也可以找到更好的工具去分析堆疊，jvm故障。

一些特殊的使用者案列值得學習思考: [https://github.com/alibaba/arthas/issues?q=label%3Auser-case](https://github.com/alibaba/arthas/issues?q=label%3Auser-case)

完了？
啊？這麼多命令 記不住啊 還有一些高階的ognl的語法涼了... 讓你獲取一下所有的spring的環境變數咋辦？trace、watch 這兩個命令我還沒有體驗夠呢？更加高階的讓我如何是好啊！好了，請看下文。

# 二、進階

## 前提

前提是你對於arthas 有了大概的理解，基本上的命令都有點概念了，ognl 簡單的語法能夠看懂了.. 簡單的條件表示式會用了。 之前我們所過arthas的命令這麼多 要記住小本本少不了啊！難受想哭~ 不要急,汪小哥來給你解決問題！

目前Arthas 官方的工具還不夠足夠的簡單，需要記住一些命令，特別是一些擴充套件性特別強的高階語法，比如ognl獲取spring context 為所欲為，watch、trace 不夠簡單，需要構造一些命令工具的資訊，因此只需要一個能夠簡單處理字串資訊的外掛即可使用。當在處理線上問題的時候需要最快速、最便捷的命令，因此arthas idea 外掛還是有存在的意義和價值的。

## arthas idea plugin

[這個外掛的意義不是處理協議層面的問](https://github.com/WangJi92/arthas-idea-plugin/issues/8)題，主要解決命令生成的問題，由於工程在idea 裡面管理，你想想你要watch 哪個類，這個外掛是知道的，幫助你更方便、更加快捷的構建命令。使用arthas idea 外掛 這一點一定要理解哦！主要解決你如何構造命令的問題！ [更多檢視文件](https://www.yuque.com/docs/share/fa77c7b4-c016-4de6-9fa3-58ef25a97948?#)

![2.png](https://ucc.alicdn.com/pic/developer-ecology/087f3f582c2a4d01a8b4a8973f726f04.png)

## 解決的問題

- spring 環境變數優先順序問題
- 獲取靜態變數
- 火焰圖整合
- logger 命令整合
- 反編譯整合
- trace -E 整合
- tt 整合

....... 基本上你能夠在arths 上面看到的功能都整合到了這個上面！直接在idea 裡面搜尋arths idea 即可安裝。

## 常用特殊用法問題

### 靜態變數

可以直接獲取 ognl 獲取

```
ognl  -x  3 '@com.wangji92.arthas.plugin.demo.controller.StaticTest@INVOKE_STATIC_DOUBLE' -c e374b99
```

可以透過watch 獲取 (游標放置在欄位上)

```
watch com.wangji92.arthas.plugin.demo.controller.StaticTest * '{params,returnObj,throwExp,@com.wangji92.arthas.plugin.demo.controller.StaticTest@INVOKE_STATIC_DOUBLE}' -n 5 -x 3 '1==1'
```

### 一般的變數

可以透過spring context.getBean().field 獲取(這個是要配置一個靜態的spring context 看使用文件)

tt 、watch 也是可以的哦~ 一樣的原理

```
ognl -x 3 '#springContext=@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context,#springContext.getBean("staticTest").filedValue' -c e374b99
```

watch 獲取 放置在欄位上即可

```
watch com.wangji92.arthas.plugin.demo.controller.StaticTest * '{params,returnObj,throwExp,target.filedValue}' -n 5 -x 3 'method.initMethod(),method.constructor!=null || !@java.lang.reflect.Modifier@isStatic(method.method.getModifiers())'
```

### 選擇的配置項的值

springContext.getEnvironment() (這個是要配置一個靜態的spring context 看使用文件)

```
ognl -x 3 '#springContext=@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context,#springContext.getEnvironment().getProperty("custom.name")' -c e374b99
```

### 獲取所有的配置項的值

watch 獲取spring context tt 、static 也是可以的哦~ 一樣的原理

```
watch -x 3 -n 1  org.springframework.web.servlet.DispatcherServlet doDispatch '#springContext=@org.springframework.web.context.support.WebApplicationContextUtils@getWebApplicationContext(params[0].getServletContext()),#allProperties={},#standardServletEnvironment=#propertySourceIterator=#springContext.getEnvironment(),#propertySourceIterator=#standardServletEnvironment.getPropertySources().iterator(),#propertySourceIterator.{#key=#this.getName(),#allProperties.add("                "),#allProperties.add("------------------------- name:"+#key),#this.getSource() instanceof java.util.Map ?#this.getSource().entrySet().iterator.{#key=#this.key,#allProperties.add(#key+"="+#standardServletEnvironment.getProperty(#key))}:#{}},#allProperties'
```

## 影片

有興趣可以看一下影片~ 操作起來更流暢，基本上不用記憶啥。 [arthas 入門到精通最佳實踐](https://www.bilibili.com/video/BV12t4y197QW)

# 三、更多

還想了解更多關於arthas-idea-plugin 的內容可以聯絡我 可以透過 右鍵檢視arthas-idea-help 找到程式碼地址和使用說明文件，更重要的是提一下好的idea 讓arthas的使用更加的方便哦！外掛地址: [https://plugins.jetbrains.com/plugin/13581-arthas-idea](https://plugins.jetbrains.com/plugin/13581-arthas-idea)

# Arthas 徵文活動火熱進行中

Arthas 官方正在舉行徵文活動，如果你有：

- 使用 Arthas 排查過的問題
- 對 Arthas 進行原始碼解讀
- 對 Arthas 提出建議
- 不限，其它與 Arthas 有關的內容

歡迎參加徵文活動，還有獎品拿哦~[點選投稿](http://alibabacloud.mikecrm.com/9khcRrs)

> “[阿里巴巴雲原生](http://mp.weixin.qq.com/s?__biz=MzUzNzYxNjAzMg==&mid=2247489867&idx=1&sn=1e52e16f370541de77f84d4a3b100a2d&chksm=fae51284cd929b926bbed215cd609da749ba265693ebc08b1af1f027bf8a1b0e0d9aa682d99b&token=1335200991&lang=zh_CN#rd)關注微服務、Serverless、容器、Service Mesh 等技術領域、聚焦雲原生流行技術趨勢、雲原生大規模的落地實踐，做最懂雲原生開發者的公眾號。”</boolean></boolean>

阿里開源那個牛哄哄問題排查工具竟然不會用？最佳實踐來了！

相關文章