![（1）.png](https://ucc.alicdn.com/pic/developer-ecology/ea75481c92ea4c289fe9e64f771bd7b2.png)

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

作者 | 楊楨棟，筆名叫蠻三刀把刀，是一名一線網際網路碼農，留美訪學一年，主要關注後端開發，資料安全，爬蟲，物聯網，邊緣計算等方向。

# 前言

當你興沖沖地開始執行自己的 Java 專案時，你是否遇到過如下問題：

- 程式在穩定執行了，可是實現的功能點了沒反應。
- 為了修復 Bug 而上線的新版本，上線後發現 Bug 依然在，卻想不通哪裡有問題？
- 想到可能出現問題的地方，卻發現那裡沒打日誌，沒法在執行中看到問題，只能加了日誌輸出重新打包——部署——上線
- 程式功能正常了，可是為啥響應時間這麼慢，在哪裡出現了問題？
- 程式不但穩定執行，而且功能完美，但跑了幾天或者幾周過後，發現響應速度變慢了，是不是記憶體洩漏了？

**以前，你碰到這些問題，解決的辦法大多是，修改程式碼，重新上線。但是在大公司裡，上線的流程是非常繁瑣的，如果為了多加一行日誌而重新發布版本，無疑是非常折騰人的。**

現在，我們有了更為優雅的線上除錯方法 - 來自阿里巴巴開源的 Arthas。

下圖是 Arthas 文件中對於為什麼要使用它的描述，我進行了精簡：

![1.png](https://ucc.alicdn.com/pic/developer-ecology/3ad9c82277ec4b1394c9534cbafb5705.png)

好了，前言已經超過字數了，哈哈，在本篇文章裡，你能夠了解：

- Arthas 使用例項：幫助你快速讓你上手，拯救你的低效率 Debug
- 使用 Arthas 解決具體問題：看一下 Arthas 幫我拯救了多少時間
- 相似工具：看看線上 Debug 還有沒有別的工具可以使用
- 原理淺談：莫在浮沙築高閣！你需要大概瞭解下 Arthas 的原理

**相信我，Arhas 絕對是你提升效率的利器，適合各種階段的開發者，尤其適合我這種剛入門的新人（天天上班寫 Bug 的人）。你不應該有這種東西是高階程式設計師才應該去使用的思想，放心大膽的去用吧！**

# 線上 Debug 神器 Arthas

## Arthas 使用例項

命令的詳細文件請參考：[alibaba.github.io/arthas/comm…](https://alibaba.github.io/arthas/commands.html)

### 快速啟動

快速啟動它，你只需要兩行命令：

```
wget https://alibaba.github.io/arthas/arthas-boot.jar
java -jar arthas-boot.jar
```
![2.png](https://ucc.alicdn.com/pic/developer-ecology/6d9c1886a32c4dfd9ca15f1ecf6d7de1.png)

隨後，在介面出現的程式中，選擇你的程式序號，比如 1

![3.png](https://ucc.alicdn.com/pic/developer-ecology/c0dfb1ebdf10460e84d8a073a22c3b38.png)

這樣你就進入了 arthas 的控制檯。

### 基本使用

**Arthas 有如下功能：**

![4.png](https://ucc.alicdn.com/pic/developer-ecology/8700c33af13046149e46c16ff3aa022e.png)

#### 1. 首先是我認為的“上帝視角”指令：Dashboard
> 當前系統的實時資料皮膚，按 ctrl+c 退出；
> 當執行在 Ali-tomcat 時，會顯示當前 tomcat 的實時資訊，如 HTTP 請求的 qps, rt, 錯誤數, 執行緒池資訊等等。

透過這些，你可以對於整個程式程式有個直觀的資料監控。

![5.png](https://ucc.alicdn.com/pic/developer-ecology/5dba4f024aeb449f95c54d92b2d93289.png)
![6.png](https://ucc.alicdn.com/pic/developer-ecology/af4c5ada52be41ffa3e6fedc94ad36d9.png)

#### 2. 類載入問題相關指令

![7.png](https://ucc.alicdn.com/pic/developer-ecology/4c7ece4714074dd78644d1640a758c5f.png)

**SC：檢視 JVM 已載入的類資訊**

透過 SC 我們可以看到我們這個類的詳細資訊，包括是從哪個 jar 包讀取的，他是不是介面/列舉類等，甚至包括他是從哪個類載入器載入的。

![8.png](https://ucc.alicdn.com/pic/developer-ecology/f75d9726342641e9a747f9f6586744dd.png)

上圖中程式碼：

```
[arthas@37]$ sc -d *MathGame
 class-info        demo.MathGame
 code-source       /home/scrapbook/tutorial/arthas-demo.jar
 name              demo.MathGame
 isInterface       false
 isAnnotation      false
 isEnum            false
 isAnonymousClass  false
 isArray           false
 isLocalClass      false
 isMemberClass     false
 isPrimitive       false
 isSynthetic       false
 simple-name       MathGame
 modifier          public
 annotation
 interfaces
 super-class       +-java.lang.Object
 class-loader      +-sun.misc.Launcher$AppClassLoader@70dea4e
                     +-sun.misc.Launcher$ExtClassLoader@69260973
 classLoaderHash   70dea4e
```

SC 也可以檢視已載入的類，幫助你看是否有沒有納入進來的類，尤其是在 Spring 中，可以判斷的你的依賴有沒有正確的進來。

![9.png](https://ucc.alicdn.com/pic/developer-ecology/e5c3a54daea749eea1aac6027c70b0a1.png)

上圖中程式碼：

```
# 檢視JVM已載入的類資訊
[arthas@37]$ sc javax.servlet.Filter
com.example.demo.arthas.AdminFilterConfig$AdminFilter
javax.servlet.Filter
org.apache.tomcat.websocket.server.WsFilter
org.springframework.boot.web.filter.OrderedCharacterEncodingFilter
org.springframework.boot.web.filter.OrderedHiddenHttpMethodFilter
org.springframework.boot.web.filter.OrderedHttpPutFormContentFilter
org.springframework.boot.web.filter.OrderedRequestContextFilter
org.springframework.web.filter.CharacterEncodingFilter
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.HiddenHttpMethodFilter
org.springframework.web.filter.HttpPutFormContentFilter
org.springframework.web.filter.OncePerRequestFilter
org.springframework.web.filter.RequestContextFilter
org.springframework.web.servlet.resource.ResourceUrlEncodingFilter
Affect(row-cnt:14) cost in 11 ms.
 
# 檢視已載入類的方法資訊
[arthas@37]$ sm java.math.RoundingMode
java.math.RoundingMode <init>(Ljava/lang/String;II)V
java.math.RoundingMode values()[Ljava/math/RoundingMode;
java.math.RoundingMode valueOf(I)Ljava/math/RoundingMode;
java.math.RoundingMode valueOf(Ljava/lang/String;)Ljava/math/RoundingMode;
Affect(row-cnt:4) cost in 6 ms.
```

**jad：反編譯某個類，或者反編譯某個類的某個方法。**

![10.png](https://ucc.alicdn.com/pic/developer-ecology/20b59580b41140fd98211b314154d58a.png)

上圖中程式碼：

```
# 反編譯只顯示原始碼
jad --source-only com.Arthas
# 反編譯某個類的某個方法
jad --source-only com.Arthas mysql
[arthas@37]$ jad demo.MathGame
ClassLoader:
+-sun.misc.Launcher$AppClassLoader@70dea4e
  +-sun.misc.Launcher$ExtClassLoader@69260973
Location:
/home/scrapbook/tutorial/arthas-demo.jar
/*
 * Decompiled with CFR.
 */
package demo;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Random;
import java.util.concurrent.TimeUnit;
public class MathGame {
    private static Random random = new Random();
    public int illegalArgumentCount = 0;
    public List<integer> primeFactors(int number) {
        if (number < 2) {
            ++this.illegalArgumentCount;
            throw new IllegalArgumentException("number is: " + number + ", need >= 2");
        }
        ArrayList<integer> result = new ArrayList<integer>();
        int i = 2;
        while (i <= number) {
            if (number % i == 0) {
                result.add(i);
                number /= i;
                i = 2;
                continue;
            }
            ++i;
        }
        return result;
    }
    public static void main(String[] args) throws InterruptedException {
        MathGame game = new MathGame();
        do {
            game.run();
            TimeUnit.SECONDS.sleep(1L);
        } while (true);
    }
    public void run() throws InterruptedException {
        try {
            int number = random.nextInt() / 10000;
            List<integer> primeFactors = this.primeFactors(number);
            MathGame.print(number, primeFactors);
        }
        catch (Exception e) {
            System.out.println(String.format("illegalArgumentCount:%3d, ", this.illegalArgumentCount) + e.getMessage());
        }
    }
    public static void print(int number, List<integer> primeFactors) {
        StringBuffer sb = new StringBuffer(number + "=");
        for (int factor : primeFactors) {
            sb.append(factor).append('*');
        }
        if (sb.charAt(sb.length() - 1) == '*') {
            sb.deleteCharAt(sb.length() - 1);
        }
        System.out.println(sb);
    }
}
Affect(row-cnt:1) cost in 760 ms.
```

#### 3. 方法執行相關指令

![11.png](https://ucc.alicdn.com/pic/developer-ecology/ff3d5260259a4fefbee694aed63053c7.png)

watch：方法執行的資料觀測

你可以透過 watch 指令，來監控某個類，監控後，執行下你的功能，復現下場景，arthas 會提供給你具體的出參和入參，幫助你排查故障。

![12.png](https://ucc.alicdn.com/pic/developer-ecology/3574b4dbf4634515bb26a2fb8906f5e4.png)

trace：輸出方法呼叫路徑，**並輸出耗時**

這個指令對於最佳化程式碼非常的有用，可以看出具體每個方法執行的時間，如果是 for 迴圈等重複語句，還能看出 n 次迴圈中的最大耗時，最小耗時，和平均耗時，完美！

![13.png](https://ucc.alicdn.com/pic/developer-ecology/a50851373ff746a7915fda6a43e5844b.png)

tt：官方名為時空隧道

這是我除錯用的最多的指令，在你對某方法開啟 tt 後，會記錄下每一次的呼叫（你需要設定最大監控次數），然後你可以在任何時候會看這裡面的呼叫，包括出參，入參，執行耗時，是否異常等。非常強大。

![14.png](https://ucc.alicdn.com/pic/developer-ecology/5fd4208367894654926878bf57db9f52.png)

#### 4. 執行緒除錯相關指令

![15.png](https://ucc.alicdn.com/pic/developer-ecology/f2be2bc7ebe940248ead196270ab16fb.png)

thread 相關命令：

![16.png](https://ucc.alicdn.com/pic/developer-ecology/3e943acf8a024c0dab0a332a0012d4da.png)

thread -n：排列出 CPU 使用率 Top N 的執行緒。

![17.png](https://ucc.alicdn.com/pic/developer-ecology/863ecbec00e843fc88859c7d8f04a6b5.png)

thread -b：排查阻塞的執行緒

我們程式碼有時候設計的不好，會引發死鎖的問題，卡住整個執行緒執行，使用這個指令可以輕鬆的找到問題執行緒，以及問題的執行語句。

![18.png](https://ucc.alicdn.com/pic/developer-ecology/81eefa0e2f51458cb6b218a02228aa25.png)
![19.png](https://ucc.alicdn.com/pic/developer-ecology/48f83597ede74235aa04c7122df870e2.png)

#### 5. 強大的 ognl 表示式

眾所周知，一般來說，表示式都是除錯工具裡最強的指令，哈哈。

![20.png](https://ucc.alicdn.com/pic/developer-ecology/9464499c4bf9426fa1bf7bba44cfc52c.png)

在 Arthas 中你可以利用 ognl 表示式語言做很多事，比如執行某個方法，獲取某個資訊，甚至進行修改。

![21.png](https://ucc.alicdn.com/pic/developer-ecology/51f6376fd75b407cb2ae150a3b2cd3bc.png)

```
[arthas@19856]$ ognl '@com.Arthas@hashSet'
@HashSet[
    @String[count1],
    @String[count2],
    @String[count29],
    @String[count28],
    @String[count0],
    @String[count27],
    @String[count5],
    @String[count26],
    @String[count6],
    @String[count25],
    @String[count3],
    @String[count24],
    
[arthas@19856]$ ognl  '@com.Arthas@hashSet.add("test")'
@Boolean[true]
[arthas@19856]$
# 檢視新增的字元
[arthas@19856]$ ognl  '@com.Arthas@hashSet' | grep test
    @String[test],
[arthas@19856]$
```

甚至你可以動態更換日誌輸出級別。

![22.png](https://ucc.alicdn.com/pic/developer-ecology/4cd1abc8ad884637825e244ec3d01f51.png)

```
$ ognl '@com.lz.test@LOGGER.logger.privateConfig'
@PrivateConfig[
    loggerConfig=@LoggerConfig[root],
    loggerConfigLevel=@Level[INFO],
    intLevel=@Integer[400],
]
$ ognl '@com.lz.test@LOGGER.logger.setLevel(@org.apache.logging.log4j.Level@ERROR)'
null
$ ognl '@com.lz.test@LOGGER.logger.privateConfig'
@PrivateConfig[
    loggerConfig=@LoggerConfig[root],
    loggerConfigLevel=@Level[ERROR],
    intLevel=@Integer[200],
  
]
```

## 使用 Arthas 解決具體問題

### 1. 響應時間異常問題

工作中遇到一個最佳化問題，系統中一個匯出表格的功能，響應時間長達 2 分鐘，雖然給內部使用，但也不能這麼誇張，用 trace 跟蹤下方法，發現是其中的手機號加解密函式佔用了非常大的時間，幾千個手機號，進行了解密後加密的精彩操作，最終導致了兩分鐘的返回時間。

![23.png](https://ucc.alicdn.com/pic/developer-ecology/eccafa2a838a488a910b70b6aa4833e1.png)

### 2. 某功能 Bug 導致伺服器返回 500

首先透過 trace 看異常報錯的方法，之後透過 tt 排查方法，發現入參進來後，居然走錯了方法（因為多型），走到了返回 null 的方法中，所以導致了 NPE 空指標錯誤。

![24.png](https://ucc.alicdn.com/pic/developer-ecology/a78c1c0d67f34abe915fbeaeadbd8137.png)
![25.png](https://ucc.alicdn.com/pic/developer-ecology/47ebccbcdf304a4bbb918ca809f3f13f.png)

### 補充

Arthas 還支援 Web Console，詳見：[alibaba.github.io/arthas/web-…](https://alibaba.github.io/arthas/web-console.html)

![26.png](https://ucc.alicdn.com/pic/developer-ecology/34c2a0d4b1dc4d8eaf4d71e80b3f595c.png)

## 相似工具

BTrace 一是個歷史比較久的工具，觀察下來 Arthas 其實和它的理念蠻相似的，相信 Arthas 也參考過 Btrace，作為一個學習樣例來開發 Arthas。詳細的優劣勢看圖：

![27.png](https://ucc.alicdn.com/pic/developer-ecology/9e9e5e7b50a54d3ebbbc4647aff71755.png)

其他的相似工具，還有 jvm-sandbox，有興趣的朋友可以去看看。

## 原理淺談

分為三個部分:

- 啟動
- arthas 服務端程式碼分析
- arthas 客戶端程式碼分析

![28.png](https://ucc.alicdn.com/pic/developer-ecology/120b20c2e6654383adcdb50c06e03ab2.png)

### 啟動

使用了阿里開源的元件 cli,對引數進行了解析：com.taobao.arthas.boot.Bootstrap

![29.png](https://ucc.alicdn.com/pic/developer-ecology/91413186aa754166a27f735b237dc6fc.png)

在傳入引數中沒有 pid,則會呼叫本地 jps 命令,列出 java 程式。

![30.png](https://ucc.alicdn.com/pic/developer-ecology/47345b431bda4bb28e911cac6a5709be.png)

進入主邏輯,會在使用者目錄下建立 .arthas 目錄,同時下載 arthas-core 和 arthas-agent 等 lib 檔案,最後啟動客戶端和服務端。

透過反射的方式來啟動字元客戶端。

![31.png](https://ucc.alicdn.com/pic/developer-ecology/3ffab59092af420393ad6557f007ccba.png)

### 服務端——前置準備

看服務端啟動命令可以知道 從 arthas-core.jar開始啟動，arthas-core 的 pom.xml 檔案裡面指定了 mainClass 為 com.taobao.arthas.core.Arthas，使得程式啟動的時候從該類的 main 方法開始執行。

![32.png](https://ucc.alicdn.com/pic/developer-ecology/5c4416441dd340e68de95553e53a5c67.png)

- 首先解析入參，生成 com.taobao.arthas.core.config.Configure 類，包含了相關配置資訊；
- 使用 jdk-tools 裡面的 VirtualMachine.loadAgent，其中第一個引數為 agent 路徑， 第二個引數向 jar 包中的 agentmain() 方法傳遞引數（此處為 agent-core.jar 包路徑和 config 序列化之後的字串），載入 arthas-agent.jar 包；
- 執行 arthas-agent.jar 包，指定了 Agent-Class為com.taobao.arthas.agent.AgentBootstrap。

![33.png](https://ucc.alicdn.com/pic/developer-ecology/4e1e21ef84bd49ba8ad77ba30f7fc472.png)

上圖中程式碼：

```
public class Arthas {
    private Arthas(String[] args) throws Exception {
        attachAgent(parse(args));
    }
    private Configure parse(String[] args) {
        // 省略非關鍵程式碼，解析啟動引數作為配置，並填充到configure物件裡面
        return configure;
    }
    private void attachAgent(Configure configure) throws Exception {
           // 省略非關鍵程式碼，attach到目標程式
          virtualMachine = VirtualMachine.attach("" + configure.getJavaPid());
          virtualMachine.loadAgent(configure.getArthasAgent(),
                            configure.getArthasCore() + ";" + configure.toString());
    }
    public static void main(String[] args) {
            new Arthas(args);
    }
}
```

![34.png](https://ucc.alicdn.com/pic/developer-ecology/6dcc60091bba42ce80e122a90087cbc4.png)

### 服務端——監聽客戶端請求

- 如果是 exit,logout,quit,jobs,fg,bg,kill 等直接執行；
- 如果是其他的命令，則建立 Job，並執行；
- 建立 Job 時，會根據具體客戶端傳遞的命令，找到對應的 Command，幷包裝成 Process, Process 再被包裝成 Job；
- 執行 Job 時，反向先呼叫 Process，再找到對應的 Command，最終呼叫 Command 的 process 處理請求。

### 服務端——Command 處理流程

1. 不需要使用位元組碼增強的命令

> 其中 JVM 相關的使用 java.lang.management 提供的管理介面，來檢視具體的執行時資料。比較簡單，就不介紹了。

2. 需要使用位元組碼增強的命令

> 位元組碼增加的命令統一繼承 EnhancerCommand 類，process 方法裡面呼叫 enhance 方法進行增強。呼叫 Enhancer 類 enhance 方法，該方法內部呼叫 inst.addTransformer 方法新增自定義的 ClassFileTransformer，這邊是 Enhancer 類。

> Enhancer 類使用 AdviceWeaver(繼承 ClassVisitor)，用來修改類的位元組碼。重寫了 visitMethod 方法，在該方法裡面修改類指定的方法。visitMethod 方法裡面使用了 AdviceAdapter（繼承了 MethodVisitor類），在 onMethodEnter 方法, onMethodExit 方法中，把 Spy 類對應的方法（ON_BEFORE_METHOD， ON_RETURN_METHOD， ON_THROWS_METHOD 等）編織到目標類的方法對應的位置。

> 在前面 Spy 初始化的時候可以看到，這幾個方法其實指向的是 AdviceWeaver 類的 methodOnBegin， methodOnReturnEnd 等。在這些方法裡面都會根據 adviceId 查詢對應的 AdviceListener，並呼叫 AdviceListener 的對應的方法，比如 before,afterReturning, afterThrowing。

### 客戶端

客戶端程式碼在 arthas-client 模組裡面，入口類是 com.taobao.arthas.client.TelnetConsole。

主要使用 apache commons-net jar 進行 telnet 連線，關鍵的程式碼有下面幾步：

1. 構造 TelnetClient 物件，並初始化
2. 構造 ConsoleReader 物件，並初始化
3. 呼叫 IOUtil.readWrite(telnet.getInputStream(), telnet.getOutputStream(), System.in, consoleReader.getOutput()) 處理各個流，一共有四個流：
   - telnet.getInputStream()
   - telnet.getOutputStream()
   - System.in
   - consoleReader.getOutput()

請求時：從本地 System.in 讀取，傳送到 telnet.getOutputStream()，即傳送給遠端服務端。 響應時：從 telnet.getInputStream() 讀取遠端服務端傳送過來的響應，並傳遞給 consoleReader.getOutput()，即在本地控制檯輸出。

關於原始碼，深入下去還有很多東西需要生啃，我也沒有消化得很好，大家可以繼續閱讀詳細資料。

# 總結

Arthas 是一個**線上 **Debug 神器，小白也可以輕鬆上手。

## 一鍵安裝並啟動 Arthas

- **方式一：透過 Cloud Toolkit 實現 Arthas 一鍵遠端診斷**

Cloud Toolkit 是阿里雲釋出的免費本地 IDE 外掛，幫助開發者更高效地開發、測試、診斷並部署應用。透過外掛，可以將本地應用一鍵部署到任意伺服器，甚至雲端（ECS、EDAS、ACK、ACR 和 小程式雲等）；並且還內建了 Arthas 診斷、Dubbo工具、Terminal 終端、檔案上傳、函式計算 和 MySQL 執行器等工具。不僅僅有 IntelliJ IDEA 主流版本，還有 Eclipse、Pycharm、Maven 等其他版本。

推薦使用 IDEA 外掛下載 Cloud Toolkit 來使用 Arthas：[http://t.tb.cn/2A5CbHWveOXzI7sFakaCw8](http://t.tb.cn/2A5CbHWveOXzI7sFakaCw8)

- **方式二：直接下載**

地址：[https://github.com/alibaba/arthas](https://github.com/alibaba/arthas)。

# 參考文獻

開源地址：
[github.com/alibaba/art…](https://github.com/alibaba/arthas)
官方文件：
[alibaba.github.io/arthas](https://alibaba.github.io/arthas)

# 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 等技術領域、聚焦雲原生流行技術趨勢、雲原生大規模的落地實踐，做最懂雲原生開發者的公眾號。”</integer></integer></integer></integer></integer></init>

Java 線上問題排查神器 Arthas 快速上手與原理淺談

相關文章