0%

Java-Trivial

阅读更多

1 Install JDK

From Java Downloads, you can find JDK 22, JDK 21, JDK 17, and even JDK 8

  • For JDK 8

    1
    2
    # you need to login in first, can you can download, it is stupid
    tar -zxvf jdk-8u411-linux-x64.tar.gz -C /usr/lib/jvm
  • For JDK 17

    1
    2
    wget https://download.oracle.com/java/17/latest/jdk-17_linux-x64_bin.tar.gz
    tar -zxvf jdk-17_linux-x64_bin.tar.gz -C /usr/lib/jvm
  • For JDK 22

    1
    2
    wget https://download.oracle.com/java/22/latest/jdk-22_linux-x64_bin.tar.gz
    tar -zxvf jdk-22_linux-x64_bin.tar.gz -C /usr/lib/jvm

Archived OpenJDK General-Availability Releases

2 Builtin

2.1 java

2.1.1 Execute

Use -classpath Options:

  • java -classpath /path/aaa.jar com.liuyehcf.demo.MyMain arg1 arg2
  • java -classpath /path/aaa.jar:/path/bbb.jar com.liuyehcf.demo.MyMain arg1 arg2
  • java -classpath "/path/*" com.liuyehcf.demo.MyMain arg1 arg2
  • java -classpath "/path/*":"/path2/*" com.liuyehcf.demo.MyMain arg1 arg2

Use -jar: The jar file must has record Main class in META-INF/MANIFEST.MF

  • java -jar /path/aaa.jar arg1 arg2

Use -Djava.ext.dirs= Options:

  • java -Djava.ext.dirs=/path/jar_dir/ com.liuyehcf.demo.MyMain arg1 arg2

2.1.2 Enable Debug

Java 1.4 及更早版本: -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=*:8000,suspend=n

  • -Xrunjdwp:启动JDWP, Java debug wire protocol调试器
  • transport=dt_socket:使用套接字作为传输方式
  • server=y:作为调试服务器运行
  • address=*:8000:在所有网络接口上监听8000端口。同0.0.0.0
    • 8000
    • 127.0.0.1:8000
    • 0.0.0.0:8000
  • suspend=nJVM启动后不挂起,立即运行

Java 1.5 (JDK 5): -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:8000

  • -agentlib:jdwp:使用jdwp库启动JDWP调试器,且不需要额外指定-Xdebug
  • transport=dt_socket:使用套接字作为传输方式
  • server=y:作为调试服务器运行
  • suspend=nJVM启动后不挂起,立即运行
  • address=*:8000:在所有网络接口上监听8000端口。同0.0.0.0

2.2 jps

列出正在运行的虚拟机进程,并显示虚拟机执行主类名称以及这些进程的本地虚拟机唯一ID(Local Virtual Machine Identifier, LVMID)

虽然功能比较单一,但它是使用频率最高的JDK命令行工具,因为其他JDK工具大多需要输入它查询到的LVMID来确定要监控的是哪一个虚拟机进程

对本地虚拟机来说,LVMID与操作系统的进程ID(Process Identifier,PID)是一致的,使用Windows的任务管理器或者UNIXps命令也可以查询到虚拟机进程的LVMID,如果同时启动了多个虚拟机进程,无法根据进程名称定位时,就只能依赖jps命令显示主类的功能才能区分了

格式:

  • jps [options] [hostid]

参数说明:

  • -q:只输出LVMID,省略主类的名称
  • -m:输出虚拟机进程启动时传递给主类main()函数的参数
  • -l:输出主类的全名,如果进程执行的是Jar包,输出Jar路径
  • -v:输出虚拟机进程启动时的JVM参数

2.3 jstat

jstat(JVM Statistics Monitoring Tool)是用于监视虚拟机各种运行状态信息的命令行工具

jstat可以显示本地或者远程虚拟机进程中的类装载、内存、垃圾收集、JIT编译等运行数据,在没有GUI图形界面,只提供了纯文本控制台环境的服务器上,它将是运行期定位虚拟机性能问题的首选工具

格式:

  • jstat [option <vmid> [interval [s|ms] [count] ] ]

参数说明:

  • 如果是本地虚拟机进程,VMIDLVMID是一致的,如果是远程虚拟机进程,那VMID的格式应当是
    • [protocol:] [//] lvmid [@hostname[:port]/servername]
  • intervalcount代表查询间隔和次数,如果省略这两个参数,说明只查询一次
    • jstat -gc 2764 250 20:每250毫秒查询一次进程2764垃圾收集情况,一共查询20
  • -class:监视类装载、卸载数量、总空间以及类装载所耗费的时间
  • -gc:监视Java堆状况,包括Eden区、两个survivor区、老年代、永久代等的容量、已用空间、GC时间合计等信息
  • -gccapacity:监视内容与-gc基本相同,但输出主要关注Java堆各个区域使用到的最大、最小空间
  • -gcutil:监视内容与-gc基本相同,但输出主要关注已使用空间占总空间的百分比
  • -gccause:与-gcutil功能一样,但是会额外输出导致上一次GC产生的原因
  • -gcnew:监视新生代GC状况
  • -gcnewcapacity:监视内容与-gcnew基本相同,输出主要关注使用到的最大、最小空间
  • -gcold:监视老年代GC状况
  • -gcoldcapacity:监视内容与-gcold基本相同,输出主要关注使用到的最大、最小空间
  • -gcpermcapacity:输出永久代使用到的最大、最小空间
  • -compiler:输出JIT编译器编译过的方法、耗时等信息
  • -printcompilation:输出已经被JIT编译的方法

输出内容意义:

  • E:新生代区Eden
  • S0\S1Survivor0Survivor1这两个Survivor
  • O:老年代Old
  • P:永久代Permanet
  • YGCYoung GC
  • YGCTYount GC Time
  • FGCFull GC
  • FTCGFull GC Time
  • GCTMinor GCFull GC总耗时

示例:

  • jstat -gc <vmid> 1000 1000:查看JVM内存使用
  • jstat -gcutil <vmid> 1000 1000:查看JVM内存使用(百分比)

2.4 jinfo

jinfo(Configuration Info for Java)的作用是实时地查看和调整虚拟机各项参数

使用jps命令的-v参数可以查看虚拟机启动时显示指定的参数列表,但如果想知道未被显式指定的参数的系统默认值,除了去查找资料外,就只能用jinfo-flag选项进行查询

如果JDK1.6或者以上版本,可以使用-XX:+PrintFlagsFinal查看参数默认值

jinfo还可以使用-sysprops选项把虚拟机进程的System.getProperties()的内容打印出来

格式:

  • jinfo [option] <vmid>

参数说明

  • -flag:显式默认值
    • jinfo -flags 1874:显式所有项的默认值
    • jinfo -flag CICompilerCount 1874:显示指定项的默认值
  • -sysprops:把虚拟机进程的System.getProperties()的内容打印出来

2.5 jmap

jmap(Memory Map for Java)命令用于生成堆转储快照(一般称为heapdumpdump文件)

jmap的作用并不仅仅为了获取dump文件,它还可以查询finalize执行队列、Java堆和永久代的详细信息,如空间使用率、当前用的是哪种收集器等

格式:

  • jmap [option] <vmid>

参数说明:

  • -dump:生成Java堆转储快照,格式为-dump:[live, ]format=b, file=<filename>,其中live子参数说明是否只dump出存活对象
  • -finalizerinfo:显示在F-Queue中等待Finalizer线程执行finalize方法的对象
  • -heap:显示Java堆详细信息,如使用哪种回收器,参数配置,分代状况等
  • -histo:显示堆中对象统计信息,包括类、实例数量、合计容量
  • -permstat:以ClassLoader为统计口径显示永久代内存状态
  • -F:当虚拟机进程对-dump选项没有响应时,可使用这个选项强制生成dump快照

示例

  • jmap -dump:format=b,file=<dump_文件名> <java进程号>dump进程所有对象的堆栈
  • jmap -dump:live,format=b,file=<dump_文件名> <java进程号>dump进程中存活对象的堆栈,会触发full gc
  • jmap -histo:live <vmid>:触发full gc
  • jmap -histo <vmid> | sort -k 2 -g -r | less:统计堆栈中对象的内存信息,按照对象实例个数降序打印
  • jmap -histo <vmid> | sort -k 3 -g -r | less:统计堆栈中对象的内存信息,按照对象占用内存大小降序打印

2.6 jhat

jhat是虚拟机堆转储快照分析工具

Sun JDK提供jhat(JVM Heap Analysis Tool)命令与jmap搭配使用,来分析jmap生成的堆转储快照

jhat内置了一个微型的HTTP/HTML服务器,生成dump文件的分析结果后,可以在浏览器中查看

不过在实际工作中,除非真的没有别的工具可用,否则一般不会直接使用jhat命令来分析dump文件,原因如下

  • 一般不会再部署应用程序的服务器上直接分析dump文件,即使可以这样做,也会尽量将dump文件复制到其他机器上进行分析,因为分析工作是一个耗时而且消耗硬件资源的过程,既然都要在其他机器上进行,就没有必要受到命令工具的限制了
  • jhat的分析功能相对来说比较简陋,VisualVM,以及专业用于分析dump文件的Eclipse Memory AnalyzerIBM HeapAnalyzer等工具,都能实现比jhat更强大更专业的分析功能

配合jmap的例子

  1. jmap -dump:format=b,file=dump.bin 1874
    • 文件相对路径为dump.bin
    • vmid为1874
  2. jhat dump.bin
    • 在接下来的输出中会指定端口7000
    • 在浏览器中键入http://localhost:7000/就可以看到分析结果,拉到最下面,包含如下导航:
      • All classes including platform
      • Show all members of the rootset
      • Show instance counts for all classes (including platform)
      • Show instance counts for all classes (excluding platform)
      • Show heap histogram
      • Show finalizer summary
      • Execute Object Query Language (OQL) query

2.7 jstack

jstackJava堆栈跟踪工具

jstack(Stack Trace for Java)命令用于生成虚拟机当前时刻的线程快照(一般称为trheaddump或者javacore文件)

线程快照就是当前虚拟机每一条线程正在执行的方法堆栈的集合,生成线程快照的主要目的是定位线程出现长时间停顿的原因,如线程死锁、死循环、请求外部资源导致的长时间等待都是导致线程长时间停顿的常见原因

线程出现停顿的时候通过jstack来查看各个线程的调用堆栈,就可以知道没有响应的线程到底在后台做了什么,或者等待什么资源

格式:

  • jstack [option] <vmid>

参数说明:

  • -F:当正常输出的请求不被响应时,强制输出线程堆栈
  • -l:除堆栈外,显示关于锁的附加信息
  • -m:如果调用本地方法的话,可以显示C/C++的堆栈

在JDK1.5中,java.lang.Thread类新增一个getAllStackTraces()方法用于获取虚拟机中所有线程的StackTraceElement对象,使用这个对象可以通过简单的几行代码就能完成jstack的大部分功能,在实际项目中不妨调用这个方法做个管理员页面,可以随时使用浏览器来查看线程堆栈

2.8 java_home

/usr/libexec/java_home -V:用于查看本机上所有版本java的安装目录

2.9 jar

Creating an archive file: jar cvf xxx.jar -C ${target_dir1} ${dir_or_file1} -C ${target_dir2} ${dir_or_file2} ...

  • Note that -C only applies to the argument immediately following it
  • jar cvf xxx.jar .
  • jar cvf xxx.jar org com/test/A.class
  • jar cvf xxx.jar -C classes org -C classes com

Extracting an archive file: jar xvf xxx.jar

  • jar xvf /path/xxx.jar
  • jar xvf /path/xxx.jar xxx.class

Viewing an archive file: jar tf xxx.jar

2.9.1 JAR File Specification

JAR File Specification

  • The META-INF directory
    • service: Service Provider Interface, SPI
    • MANIFEST.MF: Main-Class

2.10 jdb

Debug tool like gdb

3 Monitor

3.1 Arthas

Arthas

commands

3.2 VisualVM

All-in-One Java Troubleshooting Tool

3.2.1 Shallow Size vs. Retained Size

Shallow Size: This is the amount of memory allocated to store the object itself, not including the objects it references. This includes the memory used by the object’s fields (for primitive types) and the memory used to store the references to other objects (for reference types). It does not include the memory used by the objects those references point to. Tools like VisualVM generally show the shallow size by default.

Retained Size: This is the total amount of memory that would be freed if the object were garbage collected. This includes the shallow size of the object itself plus the shallow size of any objects that are exclusively referenced by this object (i.e., objects that would be garbage collected if this object were). The retained size provides a more complete picture of the “true” memory impact of an object but can be more complex to calculate. Some profiling tools provide this information, but it may require additional analysis or plugins.

4 Java Decompiler

Java Decompilers

4.1 CFR

Class File Reader, CFR: Another Java Decompiler, it will decompile modern Java features - including much of Java 9, 12 & 14, but is written entirely in Java 6, so will work anywhere!

1
2
wget https://github.com/leibnitz27/cfr/releases/download/0.152/cfr-0.152.jar
java -jar cfr-0.152.jar xxx.class

4.2 JD

Java Decompiler project, JD Project: Aims to develop tools in order to decompile and analyze Java 5 “byte code” and the later versions.

1
2
wget https://github.com/java-decompiler/jd-gui/releases/download/v1.6.6/jd-gui-1.6.6.jar
java -jar jd-gui-1.6.6.jar

4.3 JAD

JAD: It is dead, and yes, it was not Open Source anyway。

4.4 Fernflower

Fernflower: The first actually working analytical decompiler for Java and probably for a high-level programming language in general.

1
2
3
4
5
git clone https://github.com/fesh0r/fernflower.git
cd fernflower
gradle build

java -jar build/libs/fernflower.jar -dgs=true /path_source_dir /path_target_dir

5 Java Environment Manager

5.1 jenv

jenv

  • For mac

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    brew install jenv
    echo 'export PATH="$HOME/.jenv/bin:$PATH"' >> ~/.zshrc
    echo 'eval "$(jenv init -)"' >> ~/.zshrc

    # Export JAVA_HOME path
    jenv enable-plugin export

    # Diagnosis
    jenv doctor

    # Add java version
    jenv add /Library/Java/JavaVirtualMachines/jdk-17.jdk/Contents/Home
    jenv add /Library/Java/JavaVirtualMachines/jdk-22.jdk/Contents/Home

    # List all available versions
    jenv versions

    # Switch to specific version
    # shell has highest priority(`JENV_VERSION`) and global has lowest priority. local refers to current directory(`.java-version`)
    jenv global 17
    jenv local 22
    jenv shell 22
  • For Linux

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    git clone https://github.com/jenv/jenv.git ~/.jenv
    echo 'export PATH="$HOME/.jenv/bin:$PATH"' >> ~/.zshrc
    echo 'eval "$(jenv init -)"' >> ~/.zshrc

    # Export JAVA_HOME path
    jenv enable-plugin export

    # Diagnosis
    jenv doctor

    # Add java version
    jenv add /usr/lib/jvm/java-8-openjdk-amd64
    jenv add /usr/lib/jvm/java-17-openjdk-amd64

    # List all available versions
    jenv versions

    # Switch to specific version
    # shell has highest priority(`JENV_VERSION`) and global has lowest priority. local refers to current directory(`.java-version`)
    jenv global 17
    jenv local 1.8
    jenv shell 1.8

Tips:

  • jenv global/local/shell --unset

  • For x86 container running on OSX with M-chips, the default jenv init - will encounter strange problem, because the shell command turns out to be /run/rosetta/rosetta /usr/local/bin/zsh zsh, rather than zsh in most cases. And the shell parse step (list as below) in ~/.jenv/libexec/jenv-init cannot work correctly. So the solution is using jenv init - zsh instead of jenv init - by specifying the shell command to skip the pass step

    1
    2
    3
    4
    5
    6
    7
    8
    shell="$1"
    if [ -z "$shell" ]; then
    shell="$(ps -p "$PPID" -o 'args=' 2>/dev/null || true)"
    shell="${shell%% *}"
    shell="${shell##-}"
    shell="${shell:-$SHELL}"
    shell="${shell##*/}"
    fi
  • How to list all versions: jenv versions can only listed all the valid versions

    • ls ~/.jenv/versions

6 Class Isolation

Here’s an example of how to use module class loader to create a isolated environment.

  • module1 and module2 both have the log dependencies.
  • Each module will init its own log context in an isolated environment.

The structure of the project:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
.
├── common
│   ├── pom.xml
│   └── src
│   └── main
│   └── java
│   └── org
│   └── liuyehcf
│   └── moduleisolation
│   ├── TestMain.java
│   └── loader
│   ├── ClassFactory.java
│   └── ModuleClassLoader.java
├── module1
│   ├── pom.xml
│   └── src
│   └── main
│   ├── java
│   │   └── org
│   │   └── liuyehcf
│   │   └── moduleisolation
│   │   └── module1
│   │   ├── Function.java
│   │   └── ModuleClassFactory.java
│   └── resources
│   └── module1_log4j2.xml
├── module2
│   ├── pom.xml
│   └── src
│   └── main
│   ├── java
│   │   └── org
│   │   └── liuyehcf
│   │   └── moduleisolation
│   │   └── module2
│   │   ├── Function.java
│   │   └── ModuleClassFactory.java
│   └── resources
│   └── module2_log4j2.xml
└── pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
mkdir class_isolation_demo
cd class_isolation_demo

mkdir -p common/src/main/java/org/liuyehcf/moduleisolation/loader
mkdir -p module1/src/main/java/org/liuyehcf/moduleisolation/module1
mkdir -p module1/src/main/resources
mkdir -p module2/src/main/java/org/liuyehcf/moduleisolation/module2
mkdir -p module2/src/main/resources

cat > pom.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>org.liuyehcf</groupId>
<artifactId>ModuleIsolcation</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>pom</packaging>
<modules>
<module>common</module>
<module>module1</module>
<module>module2</module>
</modules>

<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<compiler-plugin.version>3.8.1</compiler-plugin.version>
<shade-plugin.version>3.2.4</shade-plugin.version>
</properties>

<build>
<pluginManagement>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>${compiler-plugin.version}</version>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
</configuration>
</plugin>
<plugin>
<groupId>net.revelc.code.formatter</groupId>
<artifactId>formatter-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>${shade-plugin.version}</version>
<executions>
<execution>
<configuration>
<filters>
<filter>
<artifact>*:*</artifact>
<excludes>
<exclude>META-INF/*.SF</exclude>
<exclude>META-INF/*.DSA</exclude>
<exclude>META-INF/*.RSA</exclude>
</excludes>
</filter>
</filters>
<finalName>${project.build.finalName}-jar-with-dependencies</finalName>
</configuration>
<goals>
<goal>shade</goal>
</goals>
<phase>package</phase>
</execution>
</executions>
</plugin>
</plugins>
</pluginManagement>
</build>
</project>
EOF

cat > common/pom.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.liuyehcf</groupId>
<artifactId>ModuleIsolcation</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>

<artifactId>common</artifactId>

<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<log4j.version>2.17.1</log4j.version>
<slf4j.version>1.7.32</slf4j.version>
</properties>

<dependencies>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>${slf4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
<version>${log4j.version}</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>${log4j.version}</version>
</dependency>
</dependencies>
</project>
EOF

cat > common/src/main/java/org/liuyehcf/moduleisolation/TestMain.java << 'EOF'
package org.liuyehcf.moduleisolation;

import org.liuyehcf.moduleisolation.loader.ClassFactory;

import java.lang.reflect.Method;

public class TestMain {
public static void main(String[] args) throws Exception {
runModule("module1");
runModule("module2");
}

private static void runModule(String moduleName) throws Exception {
Class<?> classFactoryClass = ClassLoader.getSystemClassLoader().loadClass(
String.format("org.liuyehcf.moduleisolation.%s.ModuleClassFactory", moduleName));
ClassFactory classFactory = (ClassFactory) classFactoryClass.newInstance();
classFactory.initModuleContext();

Class<?> clazz = classFactory.getClass(
String.format("org.liuyehcf.moduleisolation.%s.Function", moduleName));
Method run = clazz.getMethod("run");
Object function = clazz.newInstance();
run.invoke(function);
}
}
EOF

cat > common/src/main/java/org/liuyehcf/moduleisolation/loader/ClassFactory.java << 'EOF'
package org.liuyehcf.moduleisolation.loader;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.core.LoggerContext;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.ConfigurationSource;
import org.apache.logging.log4j.core.config.xml.XmlConfiguration;

import java.io.FileNotFoundException;
import java.io.IOException;
import java.net.URL;

public abstract class ClassFactory {

protected ModuleClassLoader classLoader;

protected ClassFactory() {
try {
classLoader = ModuleClassLoader.create(getModuleName());
} catch (Exception e) {
rethrow(e);
}
}

@SuppressWarnings("unchecked")
public static <T extends Throwable> void rethrow(Throwable t) throws T {
throw (T) t;
}

/**
* Name of module
*/
protected abstract String getModuleName();

/**
* Entry to get class of current module
*/
public final Class<?> getClass(String className) throws ClassNotFoundException {
return classLoader.loadClass(className);
}

/**
* Initialize the isolated context of this module
*/
public final void initModuleContext() throws Exception {
initLog4j2();
}

/**
* This method is used to initialize the isolated context of log4j2, avoiding conflict between
* different modules.
*/
private void initLog4j2() throws Exception {
Class<?> clazz = getClass(
"org.liuyehcf.moduleisolation.loader.ClassFactory$Log4jContextInitializer");
clazz.getMethod("init", String.class).invoke(null, getModuleName());
}

public static class Log4jContextInitializer {
public static void init(String moduleName) throws IOException {
URL resource = Log4jContextInitializer.class.getClassLoader()
.getResource(String.format("%s_log4j2.xml", moduleName));
if (resource == null) {
throw new FileNotFoundException(
String.format("Cannot find log4j2.xml in module %s", moduleName));
}
ConfigurationSource source = new ConfigurationSource(resource.openStream(), resource);
LoggerContext context = (LoggerContext) LogManager.getContext(false);
Configuration config = new XmlConfiguration(context, source);
context.start(config);
}
}
}
EOF

cat > common/src/main/java/org/liuyehcf/moduleisolation/loader/ModuleClassLoader.java << 'EOF'
package org.liuyehcf.moduleisolation.loader;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Collections;
import java.util.Enumeration;
import java.util.List;
import java.util.stream.Collectors;

public class ModuleClassLoader extends URLClassLoader {
private static final String MODULE_JAR_FILE_PATTERN = "%s-jar-with-dependencies.jar";

static {
ClassLoader.registerAsParallelCapable();
}

private final File jarFile;
private final ClassLoaderWrapper parent;

private ModuleClassLoader(URL[] urls) {
super(urls, null);
this.jarFile = new File(urls[0].getPath());
this.parent = new ClassLoaderWrapper(ClassLoader.getSystemClassLoader());
}

public static ModuleClassLoader create(String moduleName) throws MalformedURLException {
String jarNameSuffix = String.format(MODULE_JAR_FILE_PATTERN, moduleName);
String classpath = System.getProperty("java.class.path");
String[] moduleJarFiles = classpath.split(":");
String targetJarFile = null;
for (String jarFile : moduleJarFiles) {
if (jarFile.endsWith(jarNameSuffix)) {
targetJarFile = jarFile;
break;
}
}
if (targetJarFile == null) {
throw new RuntimeException(
String.format("Cannot find '%s' in classpath '%s'", jarNameSuffix, classpath));
}

return new ModuleClassLoader(new URL[] {new File(targetJarFile).toURI().toURL()});
}

public File getJarFile() {
return jarFile;
}

private boolean isValidParentResource(URL url) {
return url != null && !url.getPath().contains("-reader-jar-with-dependencies.jar");
}

@Override
protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
try {
return super.loadClass(name, resolve);
} catch (ClassNotFoundException cnf) {
return parent.loadClass(name, resolve);
}
}

@Override
public Enumeration<URL> getResources(String name) throws IOException {
// Load resource from current module classLoader
List<URL> urls = Collections.list(super.getResources(name));
// Load resource from parent classLoader but exclude other module resources
urls.addAll(Collections.list(parent.getResources(name)).stream()
.filter(this::isValidParentResource).collect(Collectors.toList()));
return Collections.enumeration(urls);
}

@Override
public URL getResource(String name) {
// Load resource from current module classLoader
URL url = super.getResource(name);
if (url == null) {
// Load resource from parent classLoader but exclude other module resources
url = parent.getResource(name);
if (!isValidParentResource(url)) {
return null;
}
}
return url;
}

/**
* The only function of this wrapper is changing access modifiers of loadClass from protected to
* public
*/
private static final class ClassLoaderWrapper extends ClassLoader {
static {
ClassLoader.registerAsParallelCapable();
}

public ClassLoaderWrapper(ClassLoader parent) {
super(parent);
}

@Override
public Class<?> findClass(String name) throws ClassNotFoundException {
return super.findClass(name);
}

@Override
public Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException {
return super.loadClass(name, resolve);
}
}
}
EOF

cat > module1/pom.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.liuyehcf</groupId>
<artifactId>ModuleIsolcation</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>

<artifactId>module1</artifactId>

<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<compiler-plugin.version>3.8.1</compiler-plugin.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencies>
<dependency>
<groupId>org.liuyehcf</groupId>
<artifactId>common</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>

<build>
<finalName>module1</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
EOF

cat > module1/src/main/java/org/liuyehcf/moduleisolation/module1/Function.java << 'EOF'
package org.liuyehcf.moduleisolation.module1;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class Function {
private static final Logger LOGGER = LoggerFactory.getLogger(Function.class);

public void run() {
LOGGER.info("This is an info log, classLoader={}, ObjectClass={}, LoggerFactoryClass={}",
getClass().getClassLoader(), getClassString(Object.class),
getClassString(LoggerFactory.class));
LOGGER.error("This is an error log");
}

private String getClassString(Class<?> clazz) {
return clazz.getName() + "@" + Integer.toHexString(System.identityHashCode(clazz));
}
}
EOF

cat > module1/src/main/java/org/liuyehcf/moduleisolation/module1/ModuleClassFactory.java << 'EOF'
package org.liuyehcf.moduleisolation.module1;

import org.liuyehcf.moduleisolation.loader.ClassFactory;

public class ModuleClassFactory extends ClassFactory {
@Override
protected String getModuleName() {
return "module1";
}
}
EOF

cat > module1/src/main/resources/module1_log4j2.xml << 'EOF'
<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
<Properties>
<Property name="LOG_DIR">${env:MODULE_LOG_DIR:-/tmp/module_isloation}</Property>
<Property name="LOG_LEVEL">${env:MODULE_LOG_LEVEL:-info}</Property>
<Property name="LOG_PATTERN">%d{yyyy-MM-dd HH:mm:ss.SSS} %style{[%thread]}{bright} %highlight{[%-5level] [%X{QueryId}] %logger{36}}{STYLE=Logback} - %msg%n
</Property>
</Properties>
<Appenders>
<RollingRandomAccessFile name="DefaultAppender" fileName="${LOG_DIR}/module1/default.log"
filePattern="${LOG_DIR}/module1/default-%d{yyyy-MM-dd}-%i.log">
<PatternLayout
pattern="${LOG_PATTERN}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="1000MB"/>
</Policies>
<DefaultRolloverStrategy max="7"/>
</RollingRandomAccessFile>
<RollingRandomAccessFile name="ErrorAppender" fileName="${LOG_DIR}/module1/error.log"
filePattern="${LOG_DIR}/module1/error-%d{yyyy-MM-dd}-%i.log">
<ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
<PatternLayout
pattern="${LOG_PATTERN}"/>
<Policies>
<TimeBasedTriggeringPolicy interval="1" modulate="true"/>
<SizeBasedTriggeringPolicy size="1000MB"/>
</Policies>
<DefaultRolloverStrategy max="7"/>
</RollingRandomAccessFile>
<Async name="AsyncDefaultAppender">
<AppenderRef ref="DefaultAppender"/>
<AppenderRef ref="ErrorAppender"/>
</Async>
</Appenders>
<Loggers>
<Root level="${LOG_LEVEL}">
<AppenderRef ref="AsyncDefaultAppender"/>
</Root>
</Loggers>
</Configuration>
EOF

cp -f module1/pom.xml module2/pom.xml
cp -f module1/src/main/java/org/liuyehcf/moduleisolation/module1/Function.java module2/src/main/java/org/liuyehcf/moduleisolation/module2/Function.java
cp -f module1/src/main/java/org/liuyehcf/moduleisolation/module1/ModuleClassFactory.java module2/src/main/java/org/liuyehcf/moduleisolation/module2/ModuleClassFactory.java
cp -f module1/src/main/resources/module1_log4j2.xml module2/src/main/resources/module2_log4j2.xml
sed -i 's/module1/module2/g' module2/pom.xml
sed -i 's/module1/module2/g' module2/src/main/java/org/liuyehcf/moduleisolation/module2/Function.java
sed -i 's/module1/module2/g' module2/src/main/java/org/liuyehcf/moduleisolation/module2/ModuleClassFactory.java
sed -i 's/module1/module2/g' module2/src/main/resources/module2_log4j2.xml

mvn clean package -DskipTests
rm -rf /tmp/module_isloation
java -classpath ./module2/target/module2-jar-with-dependencies.jar:./module1/target/module1-jar-with-dependencies.jar org.liuyehcf.moduleisolation.TestMain
cat /tmp/module_isloation/module1/default.log
cat /tmp/module_isloation/module1/error.log
cat /tmp/module_isloation/module2/default.log
cat /tmp/module_isloation/module2/error.log

You can find each module share the same Object.class instance, but has unique instance of LoggerFactory.class

7 Tips

7.1 Find JDK Install Path

For linux, the directory usually is: /usr/lib/jvm

  1. readlink -f $(which java)
  2. update-alternatives --config java
  3. update-alternatives --display java

For MacOS, the directory usually is: /Library/Java/JavaVirtualMachines

  1. readlink -f $(which java)

7.2 How to check whether jar file contains specific class file

  • unzip -l <jar> | grep xxx.class
  • jar tf <jar> | grep xxx.class

7.3 How to extract jar file to specific directory

  • cd <target_dir>; jar -xf <jar>
  • unzip <jar> -d <target_dir>

7.4 How to breakthrough checked exception limitation

If you want to throw an checked exception, but you don’t want to add throws clause to the method signature, there are several ways can make it happen:

  1. Use Type Erasure

    1
    2
    3
    4
    @SuppressWarnings("unchecked")
    private static <T extends Throwable> void throwException(Throwable exception) throws T {
    throw (T) exception;
    }
  2. Use Unsafe.throwException

7.5 How JVM use classpath

Assume the classpath is: /path/to/a.jar:/path/to/b.jar, and a.jar exists while b.jar doesn’t exist.

The following steps can work well:

  1. Load some class A from a.jar
  2. Put b.jar to the right place, i.e /path/to/b.jar
  3. Load some class B from b.jar

And the same process won’t work if the classpath is reverted, i.e. /path/to/b.jar:/path/to/a.jar, because when JVM load class A it already searched b.jar and remember it’s not existed.

8 参考