Skip to content

Commit c5f5b46

Browse files
committed
docs: add recommended tools md (#27)
1 parent 7ea16b9 commit c5f5b46

File tree

8 files changed

+178
-0
lines changed

8 files changed

+178
-0
lines changed

docs/RecommendToolForJavaGuys.md

Lines changed: 178 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,178 @@
1+
# 学习 Java 内存马推荐工具
2+
3+
> 工欲善其事必先利其器
4+
5+
## Arthas
6+
7+
Arthas 是阿里云开源的 Java 诊断工具,其本质是一个 Java Agent,它提供了各种各样的命令,能让我们洞察 JVM 各种细节信息。所有的使用姿势 [官方文档](https://arthas.aliyun.com/) 都有,以下会列举一些常见的场景和问题
8+
9+
JDK8 以上的下载链接,https://arthas.aliyun.com/doc/download.html
10+
JDK6/7 下载链接,https://arthas.aliyun.com/3.x/doc/download.html
11+
12+
### 启动 Arthas
13+
14+
直接输入 `java -jar arthas-boot.jar` 启动,回车之后会弹出选项,输入数字选择需要调试的 Java 进程。
15+
16+
```bash
17+
❯ java -jar arthas-boot.jar
18+
[INFO] JAVA_HOME: /Users/reajason/.sdkman/candidates/java/21.0.5-oracle
19+
[INFO] arthas-boot version: 4.0.5
20+
[INFO] Found existing java process, please choose one and input the serial number of the process, eg : 1. Then hit ENTER.
21+
* [1]: 83922 /Users/reajason/.vscode/extensions/sonarsource.sonarlint-vscode-4.19.0-darwin-arm64/server/sonarlint-ls.jar
22+
[2]: 86557 com.intellij.idea.Main
23+
```
24+
25+
有时候可能没有 jps 命令或者不是 HotSpot JVM 会找不到 Java 进程,此时你需要通过 `ps` 找到你需要调试的 Java 进程 PID,并使用 `java -jar arthas-boot.jar <pid>` 启动。
26+
27+
```bash
28+
root@df393b860ae3:/opt/arthas# java -jar arthas-boot.jar
29+
[INFO] JAVA_HOME: /opt/java/openjdk
30+
[INFO] arthas-boot version: 4.0.5
31+
[INFO] Can not find java process. Try to run `jps` command lists the instrumented Java HotSpot VMs on the target system.
32+
Please select an available pid.
33+
```
34+
35+
arthas-boot 依赖 JDK 环境需要 tools.jar 才能启动,在 JRE 环境会歇菜。
36+
37+
```bash
38+
root@df393b860ae3:/opt/arthas# ps -ef | grep java
39+
root 1 0 3 14:19 ? 00:00:01 /opt/java/openjdk/bin/java -Djava.util.logging.config.file=/usr/local/tomcat/conf/logging.properties -Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005 -Djdk.tls.ephemeralDHKeySize=2048 -Djava.protocol.handler.pkgs=org.apache.catalina.webresources -Dorg.apache.catalina.security.SecurityListener.UMASK=0027 -Dignore.endorsed.dirs= -classpath /usr/local/tomcat/bin/bootstrap.jar:/usr/local/tomcat/bin/tomcat-juli.jar -Dcatalina.base=/usr/local/tomcat -Dcatalina.home=/usr/local/tomcat -Djava.io.tmpdir=/usr/local/tomcat/temp org.apache.catalina.startup.Bootstrap start
40+
root 87 50 0 14:20 pts/0 00:00:00 grep --color=auto java
41+
root@df393b860ae3:/opt/arthas# java -jar arthas-boot.jar 1
42+
[INFO] JAVA_HOME: /opt/java/openjdk
43+
[INFO] arthas-boot version: 4.0.5
44+
[INFO] arthas home: /opt/arthas
45+
[INFO] Try to attach process 1
46+
Exception in thread "main" java.lang.IllegalArgumentException: Can not find tools.jar under java home: /opt/java/openjdk, please try to start arthas-boot with full path java. Such as /opt/jdk/bin/java -jar arthas-boot.jar
47+
at com.taobao.arthas.boot.ProcessUtils.findJavaHome(ProcessUtils.java:222)
48+
at com.taobao.arthas.boot.ProcessUtils.startArthasCore(ProcessUtils.java:233)
49+
at com.taobao.arthas.boot.Bootstrap.main(Bootstrap.java:590)
50+
```
51+
52+
前面说了 Arthas 本质就是 Java Agent,因此使用 [jattach](https://github.com/jattach/jattach/releases/latest) 工具将其注入,再尝试连接即可。
53+
54+
TIP1: **注入的是 `/opt/arthas/arthas-agent.jar`**
55+
TIP2: **启动仍然用的 `arthas-boot.jar`**
56+
57+
```bash
58+
root@df393b860ae3:/opt/arthas# ./jattach-linux 1 load instrument false /opt/arthas/arthas-agent.jar
59+
Connected to remote JVM
60+
JVM response code = 0
61+
0
62+
63+
root@df393b860ae3:/opt/arthas# java -jar arthas-boot.jar 1
64+
[INFO] JAVA_HOME: /opt/java/openjdk
65+
[INFO] arthas-boot version: 4.0.5
66+
[INFO] arthas home: /opt/arthas
67+
[INFO] The target process already listen port 3658, skip attach.
68+
[INFO] arthas-client connect 127.0.0.1 3658
69+
,---. ,------. ,--------.,--. ,--. ,---. ,---.
70+
/ O \ | .--. ''--. .--'| '--' | / O \ ' .-'
71+
| .-. || '--'.' | | | .--. || .-. |`. `-.
72+
| | | || |\ \ | | | | | || | | |.-' |
73+
`--' `--'`--' '--' `--' `--' `--'`--' `--'`-----'
74+
75+
wiki https://arthas.aliyun.com/doc
76+
tutorials https://arthas.aliyun.com/doc/arthas-tutorials.html
77+
version 4.0.5
78+
main_class org.apache.catalina.startup.Bootstrap start
79+
pid 1
80+
start_time 2025-04-09 14:19:48.004
81+
currnt_time 2025-04-09 14:23:16.044
82+
83+
[arthas@1]$
84+
```
85+
86+
当看到大片上述输出,且命令提示符变成 `[arthas@1]$` 你就成功进入 Arthas 了,接下来让我们看看有哪些好用的命令吧。
87+
88+
### jad
89+
90+
> [官方文档/jad.html](https://arthas.aliyun.com/doc/jad.html)
91+
92+
jad 命令是用来查看反编译后的类源码。除了源码信息,还能查看是哪一个 classloader 加载的当前类,以及 classloader 的继承关系,还能看到当前类存在在哪个 jar 文件中(如果有的话),拖到 IDEA 里面就能进行调试啦。
93+
94+
- `jad org.apache.lESNa.EncryptionUtil`,查看类源码完整信息。
95+
- `jad org.apache.catalina.core.ApplicationFilterChain doFilter`,仅查看 doFilter 方法的源码。
96+
97+
![arthas_jad1](./images/arthas_jad1.png)
98+
99+
![arthas_jad2](./images/arthas_jad2.png)
100+
101+
如果回车之后显示找不到类的话,可能拼写错误,或类还没有被加载到 JVM 中,可以先尝试访问类依赖的业务路径,触发类加载之后再进行 jad。
102+
103+
### classloader
104+
105+
> [官方文档/classloader.html](https://arthas.aliyun.com/doc/classloader.html)
106+
107+
classloader 用来查看类加载器信息。
108+
109+
- `classloader` 查看当前有哪些类加载器,以及其类加载情况
110+
- `classloader -t` 查看类加载器继承关系
111+
- `classloader -c <hash>` 指定类加载实例 hash 查看其 urls
112+
113+
![arhtas_classloader](./images/arthas_classloader.png)
114+
115+
此处的分析将会在 Java 基础中提及,有些 ClassNotFoundException 或 ClassCastException 可以通过此种方式找到问题所在。
116+
117+
### sc
118+
119+
> [官方文档/sc.html](https://arthas.aliyun.com/doc/sc.html)
120+
121+
sc 即 search-class,用来查找 JVM 中的类信息。常用的一种方式是查看 interface 的所有实现类。
122+
123+
- `sc javax.servlet.Servlet`,查看 Servlet 实现类有哪些
124+
- `sc javax.servlet.ServletContext`,查看 ServletContext 实现类有哪些
125+
- `sc -d org.apache.catalina.core.ApplicationContext`,查看类的详细信息,这样我们能定位到 jar 拖出来进行反编译分析。
126+
127+
![arthas_sc](./images/arthas_sc.png)
128+
129+
### stop
130+
131+
执行 stop 退出当前 Arthas 命令行环境,回到 Unix shell。
132+
133+
```
134+
[arthas@1]$ stop
135+
Resetting all enhanced classes ...
136+
Affect(class count: 0 , method count: 0) cost in 2 ms, listenerId: 0
137+
Arthas Server is going to shutdown...
138+
[arthas@1]$ session (c5ee97b5-6809-48ab-bdfc-09d900087ec9) is closed because server is going to shutdown.
139+
```
140+
141+
## Jadx
142+
143+
> [skylot/jadx](https://github.com/skylot/jadx)
144+
145+
目前 Java 最强反编译器,人手一个,几乎可以反编译任何 jar 包,部分究极混淆的类,即使无法反编译成功,也可查看字节码。
146+
147+
打开之后,可以直接将 class 或 jar 拖入到左边框中就会自动进行反编译,点击 Source Code 里面就能看到反编译的结果,最下面可以选 Code、Smali 等等,一般 Code 里面反编译失败才需要切换,其他功能可查看 [记录 Rainbow Brackets 插件破解](https://reajason.eu.org/writing/rainbowbracketscracked/) 了解一下常用的操作。
148+
149+
![jadx_interface](./images/jadx_interface.png)
150+
151+
## File Expander — IDEA 插件
152+
153+
IDEA 自带反编译功能,并且使用习惯之后也是相当好用。但是有一个问题,如果 jar 包中套 jar 包,那么里面的 jar 包并不会默认展开,自然想到的办法就是解压 一次 jar,把里面的东西弄出来,但是有了 File Expander 插件之后,无论是 zip 还是 jar in jar,都轻松查看了。
154+
155+
![idea_plugins](./images/idea_plugins.png)
156+
157+
下图演示了 java-chains-1.4.0.jar,直接可以 expand 到 chains-core,开学!!!,这种情况下不比 jadx 要好用。
158+
159+
![idea_javachains](./images/idea_javachains.png)
160+
161+
## Find 命令
162+
163+
在批量查找当前目录下某个类存在于那个 jar 文件中,需要使用到 find 命令协助,由于需要用到 jar 命令,因此依赖 JDK 环境。JRE 环境下,可以将文件打包发送到 JDK 环境再继续研究。
164+
165+
在 tomcat 目录下,找到 ApplicationContext 在哪个 jar 文件中。
166+
167+
```bash
168+
░▒▓ ~/workspace/apache-tomcat-8.5.96
169+
❯ find . -name "*.jar" -type f -exec sh -c 'jar tvf "{}" | grep -q "org/apache/catalina/core/ApplicationContext" && echo "Found in: {}"' \;
170+
Found in: ./lib/catalina.jar
171+
```
172+
173+
部分环境下,例如 WAS 可能并没有设置 Java Home,此时 jar 命令使用绝对路径即可。
174+
175+
```bash
176+
[was@59385194e5aa AppServer]$ find . -name "*.jar" -type f -exec sh -c '/opt/IBM/WebSphere/AppServer/java/bin/jar tvf "{}" | grep -q "com/ibm/ws/webcontainer/webapp/WebApp" && echo "Found in: {}"' \;
177+
Found in: ./plugins/com.ibm.ws.webcontainer.jar
178+
```

docs/images/arthas_classloader.png

174 KB
Loading

docs/images/arthas_jad1.png

282 KB
Loading

docs/images/arthas_jad2.png

92.3 KB
Loading

docs/images/arthas_sc.png

130 KB
Loading

docs/images/idea_javachains.png

232 KB
Loading

docs/images/idea_plugins.png

121 KB
Loading

docs/images/jadx_interface.png

326 KB
Loading

0 commit comments

Comments
 (0)