阿里開源的那個牛X的問題排查工具——Arthas，推出IDEA插件了！

做者 | 汪小哥

Arthas 對於不少 Java 開發者來講，已經不可分割了，在咱們平常開發、線上問題排查中扮演了很是重要的角色。做爲小開發的我，平常須要排查線上運營同窗提的各類 bug、各類線上問題診斷、平常運維、線上問題優化等等。

在剛來公司時，我是比較恐懼運維任務的，代碼不熟悉、各類問題比較多...幾乎崩潰的狀態，運維的一週基本上沒有幹活，徹底是全身心投入到運維的任務中，排查問題效率低下。

因爲深入體驗到了這種奔潰，我一直想改變這種狀態，直到 Arthas 的開源，讓我在這種崩潰的狀態中減輕了很多負擔，同時也讓我成爲了同事們諮詢 Arthas 排查問題的小幫手~~ 雖然使用 Arthas 特別方便，但在此過程當中也遇到一些問題，做爲問題諮詢小幫手也感到有點不方便，所以才造就了 Arthas idea 插件的誕生。

目前 Arthas 官方的工具還不夠簡單，須要記住一些命令，特別是一些擴展性特別強的高級語法，好比 ognl 獲取 spring context 隨心所欲，watch、trace 不夠簡單，須要構造一些命令工具的信息，所以只須要一個可以簡單處理字符串信息的插件便可使用。

當在處理線上問題的時候須要最快速、最便捷的命令，所以 Idea Arthas plugin 插件仍是有存在的意義和價值的。---這個是最初編寫這個插件的最核心的理由。

Arthas IDEA plugin 實踐

Arthas 的功能點很是的多（詳見下方大圖），這裏就不一一的講解了，能夠參考使用文檔 ，不過最近一直在更新，使用文檔中的命令名稱可能有變化。

插件安裝

下載 arthas idea 插件：https://plugins.jetbrains.com/plugin/13581-arthas-idea

• Mac： Preferences -> Plugins
• Windows：Settings -> Plugins

Install Plugin form Disk... 導入插件

安裝以後重啓 IDEA 就能夠愉快的使用啦！

獲取 static 變量

首先要獲取 classloader 的 hash 值，而後獲取命令，這個是一個交互流程須要連貫性，後續只要是 static 的經過 static spring context 的都須要有這個交互的流程，連貫的，都在同一個界面進行操做.粘貼執行，而後獲取結果便可。

這裏的 classloader 的 hash 值緩存起來的

最後合併的腳本以下。

ognl  -x  3 '@com.wangji92.arthas.plugin.demo.controller.StaticTest@INVOKE_STATIC_NAME' -c 316bc132

反射設置 static field

經過反射進行設置 static field ，參考：https://github.com/WangJi92/arthas-idea-plugin/issues/1

填寫你想要修改的值、默認根據類型設置默認值 Str->"" Long -> 0L 等等。

ognl -x 3  '#field=@com.wangji92.arthas.plugin.demo.controller.StaticTest@class.getDeclaredField("INVOKE_STATIC_FINAL"),#modifiers=#field.getClass().getDeclaredField("modifiers"),#modifiers.setAccessible(true),#modifiers.setInt(#field,#field.getModifiers() & ~@java.lang.reflect.Modifier@FINAL),#field.setAccessible(true),#field.set(null,"設置的值")' -c 316bc132

Spring Context Invoke

經過 spring context 進行調用 bean 的方法、字段的內容。

Static Spring Context Invoke Method Field

首頁要設置一下 static spring context 的路徑。

因爲都是經過 ognl 調用 static 的 spring context 都須要 classloader，這個就是配置的 spring conetxt 的地址信息：

@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context 參考 demo 就須要配置這個地址。

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

Watch Spring Context Invoke Method Field

watch 這個是支持在 spring mvc 場景，經過 watch 間接的獲取 spring context，須要出發一次接口的調用,能夠參考 ：https://github.com/WangJi92/arthas-idea-plugin/issues/5

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

TimeTunnel Spring Context Invoke Method Field

這個是參考了橫雲斷嶺的 arthas 經過 tt 獲取 spring context 隨心所欲 ，能夠參考這個文檔：https://github.com/WangJi92/arthas-idea-plugin/issues/4 這裏作了些什麼？將整個連貫了起來，不須要記住參數信息，而後對於調用的參數進行簡單的默認封裝，複雜的參數場景不支持，須要手動拼接。

記錄獲取 spring context

tt -t org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter invokeHandlerMethod

而後根據這個 target 獲取 spring context 調用方法

tt -w 'target.getApplicationContext().getBean("commonController").getRandomInteger()' -x 3 -i 1000

獲取某個 spring 環境變量

獲取 spring 環境變量這裏依託，static spring context ，固然這個 watch 、和 tt 獲取 spring context 的場景也是支持的。在線上環境、測試環境程序多複雜，你怎麼知道環境中的變量必定是你配置的？在 nacos 等等配置中心的場景，估計手速慢了一點點，可能就沒有上去，這個時候就有這種需求獲取當前的環境變量。選中變量，而後右鍵執行命令。因爲使用靜態的 static spring context 依然須要 classloader 的值。這裏已經基本上是 arthas 的上層應用啦。

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

獲取所有的 spring 環境變量

比較優先級，最前面的必定優先級最高，你必定被 spring 的各類優先級順序搞暈了，那麼怎麼辦呢？arthas idea plugin 支持獲取當前的所有的環境變量，依次打印出來，這樣就能夠了解優先級，特別是接入了 nacos、diamond 等遠程的配置中心，實現不同確定更暈了。

參考文檔：https://blog.csdn.net/xunjiushi9717/article/details/94050139

ognl -x 3 '#springContext=@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context,#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' -c 316bc132

TimeTunnel Tt

方法執行數據的時空隧道，記錄下指定方法每次調用的入參和返回信息，並能對這些不一樣的時間下調用進行觀測(能夠從新觸發，週期觸發，惟一缺點對於 ThreadLocal 信息丟失[隱含參數]、引用對象數據變動無效),這個方便二次觸發，特別是本身調試不方便的狀況下記錄下來，二次觸發、週期觸發，不過自從段嶺大神 tt 隨心所欲以後都被帶偏了。這裏 arthas 插件作了一些什麼？增長了二次觸發的一些經常使用的命令，不讓使用者愁於記憶，整個過程更加的具備連貫性。

stack 堆棧

獲取方法從哪裏執行的調用棧(用途：源碼學習調用堆棧，瞭解調用流程) 這個是很是好用的功能，對於喜歡樂於排查問題的小夥伴真是福音，arthas idea 插件只是修改的命令的集成，以前也處理本身編碼過程當中的問題，源碼、問題排查技巧-Java Debug and Arthas：https://blog.csdn.net/u012881904/article/details/104591529

stack com.wangji92.arthas.plugin.demo.controller.CommonController getRandomInteger -n 5

Decompile Class Jad

反編譯方法、類的源碼, 有時候須要查看提交的代碼是否上線呢？這個功能就很是的友好。

參考文檔：[https://github.com/WangJi92/a...
as-idea-plugin/issues/2](https://github.com/WangJi92/a...

jad --source-only com.wangji92.arthas.plugin.demo.controller.CommonController getRandomInteger

watch、trace

增長了默認參數、默認展開的層級限制次數,使用者不用知道這些核心的參數，簡單的使用就行了，要使用更加的高級的本身help 一下就知道了。

watch com.wangji92.arthas.plugin.demo.controller.CommonController getRandomInteger '{params,returnObj,throwExp}' -n 5 -x 3
trace com.wangji92.arthas.plugin.demo.controller.CommonController getRandomInteger -n 5

trace -E（層級的打印 trace）

trace -E 本身構造起來很是的麻煩，經過界面操做簡化了一下，須要觀察多個類、多個方法的場景。選擇你須要的場景繼續添加便可。

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

Heap Dump

打印堆棧,有點相似 jmap -dump:format=b,file=/temp/dump.hprof pid 下載下來使用 MAT 分析便可。

heapdump  /tmp/dump.hprof 打印堆棧信息

特殊用法連接

這個必需要說一下，這個特殊用法的連接在線上本身束手無措的時候能夠查看一下，很是有用。

對於經過 spring context 調用方法說明

經過 spring context 調用複雜的方法實際上是不支持的，因爲這個操做起來不方便，仍是必須手工處理一下。

好比這裏的 Map names 的處理方式能夠借鑑一會兒。

更多能夠參考 demo：https://github.com/WangJi92/arthas-plugin-demo

/**
     * 複雜參數調用 場景
     * static spring context
     * ognl -x 3 '#user=new com.wangji92.arthas.plugin.demo.controller.User(),#user.setName("wangji"),#user.setAge(27L),#springContext=@com.wangji92.arthas.plugin.demo.common.ApplicationContextProvider@context,#springContext.getBean("commonController").complexParameterCall(#{"wangji":#user})' -c e374b99
     *
     * watch get spring context 備註 須要調用一次方法
     * watch -x 3 -n 1  org.springframework.web.servlet.DispatcherServlet doDispatch '#user=new com.wangji92.arthas.plugin.demo.controller.User(),#user.setName("wangji"),#user.setAge(27L),@org.springframework.web.context.support.WebApplicationContextUtils@getWebApplicationContext(params[0].getServletContext()).getBean("commonController").complexParameterCall(#{"wangji":#user})'
     *
     * tt get spring context ，only first get time index ok
     * tt -w '#user=new com.wangji92.arthas.plugin.demo.controller.User(),#user.setName("wangji"),#user.setAge(27L),target.getApplicationContext().getBean("commonController").complexParameterCall(#{"wangji":#user})' -x 3 -i 1000
     * @return
     */
    @RequestMapping("complexParameterCall")
    @ResponseBody
    public String complexParameterCall(@RequestBody  Map<String, User> names) {
        if (names == null) {
            return "EMPTY";
        }
        return names.toString();
    }

總結

本文簡單介紹了 Arthas IDEA 插件的安裝與使用技巧，該插件解放了你們對於 Arthas 使用的一些記憶、機械性的重複工做，歡迎你們試用！

Arthas 官方舉行了徵文活動，於 3 月 26 日—— 4 月 26 日舉辦，若是你有：

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

 歡迎參加徵文活動，還有獎品拿哦~點擊瞭解詳情。

「 阿里巴巴雲原生關注微服務、Serverless、容器、Service Mesh 等技術領域、聚焦雲原生流行技術趨勢、雲原生大規模的落地實踐，作最懂雲原生開發者的技術圈。」