Skip to content

Commit 2355a62

Browse files
committed
tomcat classloader mechanism
1 parent 9b33675 commit 2355a62

File tree

6 files changed

+335
-0
lines changed

6 files changed

+335
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
| |-- unicodeStandard.md
2727
| |-- 计算机网络杂记.md
2828
| |-- 深入理解Java虚拟机.md
29+
| |-- 谈谈 Java 类加载机制.md
2930
| `-- 设计模式之禅.md
3031
|-- technology
3132
| |-- Mysql-clear-database.md
Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
# 谈谈 Java 类加载机制
2+
3+
最近在学习 Tomcat 架构,其中很重要的一个模块是类加载器,因为以前学习的不够深入,所以趁这个机会好好把类加载机制搞明白。
4+
5+
<!-- TOC -->
6+
7+
- [Overview](#overview)
8+
- [API for class loading](#api-for-class-loading)
9+
- [`java.lang.ClassLoader`](#javalangclassloader)
10+
- [`java.security.SecureClassLoader`](#javasecuritysecureclassloader)
11+
- [`java.net.URLClassLoader`](#javaneturlclassloader)
12+
- [Tomcat 8.5.15 class loading Mechanism](#tomcat-8515-class-loading-mechanism)
13+
- [Reference](#reference)
14+
15+
<!-- /TOC -->
16+
17+
---
18+
19+
## Overview
20+
21+
![](../res/Class-loader.png)
22+
23+
类加载器主要分为两类,一类是 JDK 默认提供的,一类是用户自定义的。
24+
JDK 默认提供三种类加载器
25+
26+
1. `Bootstrap ClassLoader`,启动类加载器,每次执行 `java` 命令时都会使用该加载器为虚拟机加载核心类。该加载器是由 `native code` 实现,而不是 Java 代码,加载类的路径为 `<JAVA_HOME>/jre/lib`。特别的 `<JAVA_HOME>/jre/lib/rj.jar` 中包含了 `sun.misc.Launcher` 类, 而 `sun.misc.Launcher$ExtClassLoader``sun.misc.Launcher$AppClassLoader` 都是 `sun.misc.Launcher` 的内部类,所以拓展类加载器和系统类加载器都是由启动类加载器加载的。
27+
1. `Extension ClassLoader`, 拓展类加载器,用于加载拓展库中的类。拓展库路径为 `<JAVA_HOME>/jre/lib/ext/`。实现类为 `sun.misc.Launcher$ExtClassLoader`
28+
1. `System ClassLoader`, 系统类加载器。用于加载 CLASSPATH 中的类。实现类为 `sun.misc.Launcher$AppClassLoader`
29+
30+
用户自定义的类加载器
31+
32+
1. `Custom ClassLoader`, 一般都是 `java.lang.ClassLoder` 的子类
33+
34+
正统的类加载机制是基于双亲委派的,也就是当调用类加载器加载类时,首先将加载任务委派给双亲,若双亲无法加载成功时,自己才进行类加载。
35+
36+
在实例化一个新的类加载器时,我们可以为其指定一个 `parent`,即双亲,若未显式指定,则 `System ClassLoader` 就作为默认双亲。
37+
38+
具体的说,类加载任务是由 `ClassLoader``loadClass()` 方法来执行的,他会按照以下顺序加载类:
39+
40+
1. 通过 `findLoadedClass()` 看该类是否已经被加载。该方法为 native code 实现,若已加载则返回。
41+
1. 若未加载则委派给双亲,`parent.loadClass()`,若成功则返回
42+
1. 若未成功,则调用 `findClass()` 方法加载类。`java.lang.ClassLoader` 中该方法只是简单的抛出一个 `ClassNotFoundException` 所以,自定义的 ClassLoader 都需要 Override `findClass()` 方法
43+
44+
## API for class loading
45+
46+
### `java.lang.ClassLoader`
47+
48+
- `ClassLoader` 是一个抽象类。
49+
- 待加载的类必须用 `The Java™ Language Specification` 定义的全类名,全类名的定义请查阅 [The Form of a Binary](https://docs.oracle.com/javase/specs/jls/se8/html/jls-13.html#jls-13.1)
50+
- 给定一个全类名,类加载器应该去定位该类所在的位置。通用的策略是将全类名转换为类文件路径,然后通过类文件路径在文件系统中定位。
51+
- 每一个加载到内存的类都由一个 Class 对象来表示,每一个 Class 对象都有一个指向加载该类的类加载器的引用。但是数组的 Class 对象是由 Java 运行时环境创建的,通过 `Class.getClassLoader()` 方法返回的是数组元素的类加载器,若数组元素是基本类型,则返回 `null`,若类是由 `Bootstrap ClassLoader` 加载的话也是返回 `null`
52+
```java
53+
public class Main {
54+
public static void main(String[] args) {
55+
// Object 类在 <java_home>/jre/lib/rt.jar 中,
56+
// 由 Bootstrap ClassLoader 加载,由于该类加载器是由 native code 编写
57+
// 所以输出为 null
58+
Object[] objects = new Object[5];
59+
System.out.println();
60+
System.out.println(objects.getClass().getClassLoader());
61+
62+
// ZipFileAttributes 类在 <java_home>/jre/lib/ext/zipfs.jar 中,
63+
// 由 Extension ClassLoader 加载,
64+
// 输出为 sun.misc.Launcher$ExtClassLoader@4b67cf4d
65+
ZipFileAttributes[] attributes = new ZipFileAttributes[5];
66+
System.out.println();
67+
System.out.println(attributes.getClass().getClassLoader());
68+
69+
// Main 类是自定义的类,
70+
// 默认由 System ClassLoader 加载,
71+
// 输出为 sun.misc.Launcher$AppClassLoader@18b4aac2
72+
Main[] array = new Main[5];
73+
array[0] = new Main();
74+
System.out.println();
75+
System.out.println(array.getClass().getClassLoader());
76+
}
77+
}
78+
```
79+
- `ClassLoader` 默认支持并行加载,但是其子类必须调用 `ClassLoader.registerAsParallelCapable()` 来启用并行加载
80+
- 一般来说,JVM 从本地文件系统加载类的行为是与平台有关的。
81+
- `defineClass()` 方法可以将字节流转换成一个 `Class` 对象。然后调用 `Class.newInstance()` 来创建类的实例
82+
83+
### `java.security.SecureClassLoader`
84+
85+
增加了一层权限验证,因为关注点不在安全,所以暂不讨论。
86+
87+
### `java.net.URLClassLoader`
88+
89+
该类加载器用来加载 URL 指定的 JAR 文件或目录中的类和资源,以 `/` 结尾的 URL 认为是目录,否则认为是 JAR 文件。
90+
91+
```java
92+
// 尝试通过 URLClassLoader 来加载桌面下的 Test 类。
93+
public class Main {
94+
public static void main(String[] args) {
95+
try {
96+
URL[] urls = new URL[1];
97+
URLStreamHandler streamHandler = null;
98+
File classPath = new File("/home/chen/Desktop/");
99+
String repository = (new URL("file", null,
100+
classPath.getCanonicalPath() + File.separator))
101+
.toString();
102+
urls[0] = new URL(null, repository, streamHandler);
103+
104+
ClassLoader loader = new URLClassLoader(urls);
105+
106+
Class testClass = loader.loadClass("Test");
107+
108+
// output: java.net.URLClassLoader@7f31245a
109+
System.out.println(testClass.getClassLoader());
110+
} catch (MalformedURLException e) {
111+
e.printStackTrace();
112+
} catch (IOException e) {
113+
e.printStackTrace();
114+
} catch (ClassNotFoundException e) {
115+
e.printStackTrace();
116+
}
117+
}
118+
}
119+
```
120+
121+
## Tomcat 8.5.15 class loading Mechanism
122+
123+
![](../res/tomcat-classloader.png)
124+
125+
Tomcat 使用正统的类加载机制(双亲委派),但部分地方做了改动。
126+
127+
- `Bootstrap classLoader``Extension classLoader` 的作用不变
128+
- `System classLoader` 正常情况下加载的是 `CLASSPATH` 下的类,但是 Tomcat 的启动脚本并未使用该变量,而是从以下仓库下加载类:
129+
130+
1. `$CATALINA_HOME/bin/bootstrap.jar` 包含了 Tomcat 的启动类。在该启动类中创建了 `Common classLoader``Catalina classLoader``shared classLoader`。因为 `$CATALINA_BASE/conf/catalina.properties` 中只对 `common.loader` 属性做了定义,`server.loader``shared.loader` 属性为空,所以默认情况下,这三个 classLoader 都是 `CommonLoader`。具体的代码逻辑可以查阅 `org.apache.catalina.startup.Bootstrap` 类的 `initClassLoaders()` 方法和 `createClassLoader()` 方法。
131+
1. `$CATALINA_BASE/bin/tomcat-juli.jar` 包含了 Tomcat 日志模块所需要的实现类
132+
1. `$CATALINA_HOME/bin/commons-daemon.jar`
133+
- `Common classLoader` 是位于 Tomcat 应用服务器顶层的公用类加载器。由其加载的类可以由 Tomcat 自身类和所有应用程序使用。扫描路径由 `$CATALINA_BASE/conf/catalina.properties` 文件中的 `common.loader` 属性定义。默认是 `$CATALINA_HOME/lib`.
134+
- `catalina classLoader` 用于加载服务器内部可见类,这些类应用程序不能访问。
135+
- `shared classLoader` 用于加载应用程序共享类,这些类服务器不会依赖。
136+
- `Webapp classLoader` 。每个应用程序都会有一个独一无二的 `webapp classloader`,他用来加载本应用程序 `/WEB-INF/classes``/WEB-INF/lib` 下的类。
137+
138+
特别的:
139+
140+
`Webapp classLoader` 的默认行为会与正常的双亲委派模式不同:
141+
142+
1.`Bootstrap classloader` 加载
143+
1. 若没有,从 `/WEB-INF/classes` 加载
144+
1. 若没有,从 `/WEB-INF/lib/*.jar` 加载
145+
1. 若没有,则依次从 `System``Common``shared` 加载(该步骤使用双亲委派)
146+
147+
当然了,我们也可以通过配置来使 `Webapp classLoader` 严格按照双亲委派模式加载类:
148+
149+
1. 通过在工程的 `META-INF/context.xml`(和 `WEB-INF/classes` 在同一目录下) 配置文件中添加 `<Loader delegate="true"/>`
150+
1. 因为 `Webapp classLoader` 的实现类是 `org.apache.catalina.loader.WebappLoader`,他有一个属性叫 `delegate`, 用来控制类加载器的加载行为,默认为 `false`,我们可以使用 `set` 方法,将其设为 `true` 来启用严格双亲委派加载模式。
151+
152+
严格双亲委派模式加载步骤:
153+
154+
1.`Bootstrap classloader` 加载
155+
1. 若没有,则依次从 `System``Common``shared` 加载
156+
1. 若没有,从 `/WEB-INF/classes` 加载
157+
1. 若没有,从 `/WEB-INF/lib/*.jar` 加载
158+
159+
## Reference
160+
161+
1. [The Java Class Loading Mechanism](https://docs.oracle.com/javase/tutorial/ext/basics/load.html)
162+
1. [Java Classloader](https://en.wikipedia.org/wiki/Java_Classloader)
163+
1. [Class Loader HOW-TO - Apache Tomcat 8](https://tomcat.apache.org/tomcat-8.5-doc/class-loader-howto.html)
164+
1. [《Tomcat 架构解析》]()
165+
1. [《深入理解 Java 虚拟机》]()

res/Class-loader.png

35 KB
Loading

res/Class-loader.xmind

47.9 KB
Binary file not shown.

res/tomcat-classloader.png

15.4 KB
Loading

res/tomcat-classloader.uxf

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<diagram program="umlet" version="14.2">
3+
<zoom_level>10</zoom_level>
4+
<element>
5+
<id>UMLClass</id>
6+
<coordinates>
7+
<x>270</x>
8+
<y>110</y>
9+
<w>210</w>
10+
<h>30</h>
11+
</coordinates>
12+
<panel_attributes>Bootstrap ClassLoader</panel_attributes>
13+
<additional_attributes/>
14+
</element>
15+
<element>
16+
<id>UMLClass</id>
17+
<coordinates>
18+
<x>270</x>
19+
<y>190</y>
20+
<w>210</w>
21+
<h>30</h>
22+
</coordinates>
23+
<panel_attributes>Extension ClassLoader</panel_attributes>
24+
<additional_attributes/>
25+
</element>
26+
<element>
27+
<id>UMLClass</id>
28+
<coordinates>
29+
<x>270</x>
30+
<y>270</y>
31+
<w>210</w>
32+
<h>30</h>
33+
</coordinates>
34+
<panel_attributes>System ClassLoader</panel_attributes>
35+
<additional_attributes/>
36+
</element>
37+
<element>
38+
<id>UMLClass</id>
39+
<coordinates>
40+
<x>270</x>
41+
<y>350</y>
42+
<w>210</w>
43+
<h>30</h>
44+
</coordinates>
45+
<panel_attributes>Common ClassLoader</panel_attributes>
46+
<additional_attributes/>
47+
</element>
48+
<element>
49+
<id>UMLClass</id>
50+
<coordinates>
51+
<x>130</x>
52+
<y>450</y>
53+
<w>210</w>
54+
<h>30</h>
55+
</coordinates>
56+
<panel_attributes>Catalina ClassLoader</panel_attributes>
57+
<additional_attributes/>
58+
</element>
59+
<element>
60+
<id>UMLClass</id>
61+
<coordinates>
62+
<x>440</x>
63+
<y>450</y>
64+
<w>210</w>
65+
<h>30</h>
66+
</coordinates>
67+
<panel_attributes>Shared ClassLoader</panel_attributes>
68+
<additional_attributes/>
69+
</element>
70+
<element>
71+
<id>Relation</id>
72+
<coordinates>
73+
<x>360</x>
74+
<y>210</y>
75+
<w>30</w>
76+
<h>80</h>
77+
</coordinates>
78+
<panel_attributes>lt=&lt;-</panel_attributes>
79+
<additional_attributes>10.0;10.0;10.0;60.0</additional_attributes>
80+
</element>
81+
<element>
82+
<id>Relation</id>
83+
<coordinates>
84+
<x>360</x>
85+
<y>130</y>
86+
<w>30</w>
87+
<h>80</h>
88+
</coordinates>
89+
<panel_attributes>lt=&lt;-</panel_attributes>
90+
<additional_attributes>10.0;10.0;10.0;60.0</additional_attributes>
91+
</element>
92+
<element>
93+
<id>Relation</id>
94+
<coordinates>
95+
<x>360</x>
96+
<y>290</y>
97+
<w>30</w>
98+
<h>80</h>
99+
</coordinates>
100+
<panel_attributes>lt=&lt;-</panel_attributes>
101+
<additional_attributes>10.0;10.0;10.0;60.0</additional_attributes>
102+
</element>
103+
<element>
104+
<id>Relation</id>
105+
<coordinates>
106+
<x>220</x>
107+
<y>370</y>
108+
<w>140</w>
109+
<h>100</h>
110+
</coordinates>
111+
<panel_attributes>lt=&lt;-</panel_attributes>
112+
<additional_attributes>120.0;10.0;10.0;80.0</additional_attributes>
113+
</element>
114+
<element>
115+
<id>Relation</id>
116+
<coordinates>
117+
<x>400</x>
118+
<y>370</y>
119+
<w>160</w>
120+
<h>100</h>
121+
</coordinates>
122+
<panel_attributes>lt=&lt;-</panel_attributes>
123+
<additional_attributes>10.0;10.0;140.0;80.0</additional_attributes>
124+
</element>
125+
<element>
126+
<id>UMLClass</id>
127+
<coordinates>
128+
<x>440</x>
129+
<y>530</y>
130+
<w>210</w>
131+
<h>30</h>
132+
</coordinates>
133+
<panel_attributes>WebApp ClassLoader</panel_attributes>
134+
<additional_attributes/>
135+
</element>
136+
<element>
137+
<id>UMLClass</id>
138+
<coordinates>
139+
<x>440</x>
140+
<y>610</y>
141+
<w>210</w>
142+
<h>30</h>
143+
</coordinates>
144+
<panel_attributes>JSP ClassLoader</panel_attributes>
145+
<additional_attributes/>
146+
</element>
147+
<element>
148+
<id>Relation</id>
149+
<coordinates>
150+
<x>530</x>
151+
<y>470</y>
152+
<w>30</w>
153+
<h>80</h>
154+
</coordinates>
155+
<panel_attributes>lt=&lt;-</panel_attributes>
156+
<additional_attributes>10.0;10.0;10.0;60.0</additional_attributes>
157+
</element>
158+
<element>
159+
<id>Relation</id>
160+
<coordinates>
161+
<x>530</x>
162+
<y>550</y>
163+
<w>30</w>
164+
<h>80</h>
165+
</coordinates>
166+
<panel_attributes>lt=&lt;-</panel_attributes>
167+
<additional_attributes>10.0;10.0;10.0;60.0</additional_attributes>
168+
</element>
169+
</diagram>

0 commit comments

Comments
 (0)