深入理解SpringBoot加载FatJar原理
csdh11 2025-01-10 12:44 33 浏览
本文将从源码角度介绍SpringBoot是如何自定义ClassLoader去加载FatJar的,以及FatJar又是如何读取jar里面嵌套jar中的类,中间会涉及到一些ClassLoader的知识。
类加载器基础知识
双亲委托机制
双亲委托指的是加载一个类的时候,先由父类加载器去加载,如果父类加载器在加载的目录加载不到,再由子加载器加载,这样做的目的是保证同一个类只加载一次。
- BootStrap Classloader : 启动类加载器,主要加载核心的类库
- Extension ClassLoader : 扩展类加载器,在java.ext.dirs或jre/lib/ext下
- Application ClassLoader : 即AppClassLoader,应用程序类加载器,普通的Java启动项目就是AppClassLoader加载
一些容器都是基于AppClassLoader去扩展自定义的ClassLoader,以AppClassLoader作为父类加载器做的扩展,比如Tomcat使用的是WebAppClassLoader,SpringBoot使用的是LaunchedURLClassLoader。
另外我们自定义的ClassLoader,一般都是基于AppClassLoader去扩展的。
双亲委托指的是ClassLoader对象(ClassLoader实例),而不是ClassLoader类的继承,它是一种对象成员来实现双亲委托的,ClassLoader加载类的源码loadClass方法如下:
java
复制代码
protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException { synchronized (getClassLoadingLock(name)) { // 加载过的类不再加载 Class<?> c = findLoadedClass(name); if (c == null) { long t0 = System.nanoTime(); //从父类加载器加载 try { if (parent != null) { c = parent.loadClass(name, false); } else { c = findBootstrapClassOrNull(name); } } catch (ClassNotFoundException e) { } if (c == null) { //父类加载器找不到,调用findClass方法 long t1 = System.nanoTime(); c = findClass(name); // this is the defining class loader; record the stats sun.misc.PerfCounter.getParentDelegationTime().addTime(t1 - t0); sun.misc.PerfCounter.getFindClassTime().addElapsedTimeFrom(t1); sun.misc.PerfCounter.getFindClasses().increment(); } } if (resolve) { resolveClass(c); } return c; } }
首先判断是否加载过类,如果没有加载过,由父类加载,如果父类加载不到,会调用findClass方法。
URLClassLoader
URLClassLoader类如其名,主要是加载一些URL资源比如class和jar包等,可以复用URLClassLoader去扩展自己的ClassLoader,事实上Tomcat和SpringBoot也是这样做的。
URL是什么?
指一种资源,包括但不限为class文件,jar包,甚至是自定义的文件。
URL是怎么处理字节流的呢?
既然URL可以是任意文件或者资源,那读取的文件的方式也不一样
我们翻开URL.openConnection函数,可以看到是由URLStreamHandler handler处理的逻辑
java
复制代码
public URLConnection openConnection() throws java.io.IOException { return handler.openConnection(this); }
这样扩展的URL就可以通过重写URLStreamHandler类实现URL的自定义加载逻辑,事实上SpringBoot的FatJAR也是这样做的。
而URLConnection中有一个getInputStream函数
public InputStream getInputStream() throws IOException;
返回的是二进制字节流,有了InputStream就能构建资源和类了。
URLClassLoader的来龙去脉
URLClassLoader是ClassLoader的一个派生类,通过addURL可以加载jar包
java
复制代码
protected void addURL(URL url) { ucp.addURL(url); }
而ucp就是URLClassPath,管理着所有添加的URL。
URLClassLoader符合双亲委托机制,重写了findClass方法来查找Class。
java
复制代码
protected Class<?> findClass(final String name) throws ClassNotFoundException { final Class<?> result; try { result = AccessController.doPrivileged( new PrivilegedExceptionAction<Class<?>>() { public Class<?> run() throws ClassNotFoundException { String path = name.replace('.', '/').concat(".class"); Resource res = ucp.getResource(path, false); if (res != null) { try { return defineClass(name, res); } catch (IOException e) { throw new ClassNotFoundException(name, e); } } else { return null; } } }, acc); } catch (java.security.PrivilegedActionException pae) { throw (ClassNotFoundException) pae.getException(); } if (result == null) { throw new ClassNotFoundException(name); } return result; }
里面是从Resource res = ucp.getResource(path, false);获取到资源类的,ucp就是上文的就是URLClassPath。
进去 ucp.getResource 方法,可以看到getResource的实现细节,就是我上面说的URL的加载
SpringBoot加载FatJar的原理
FatJar结构
解压一个SpringBoot项目的的jar包,可以看到FatJar结构
BOOT-INF 是工程打包的文件,BOOT-INF/classes存放的是工程的代码和配置文件,BOOT-INF/lib存放的是依赖的嵌套jar包(即jar in jar)。
org.springframework.boot.* 是SpringBoot启动类
打开META-INF/MANIFEST.MF,可以看到jar包的启动类
properties
复制代码
Manifest-Version: 1.0 Implementation-Title: LittleBoy Implementation-Version: 1.0-SNAPSHOT Archiver-Version: Plexus Archiver Built-By: liubs Implementation-Vendor-Id: com.thanple.little.boy Spring-Boot-Version: 1.5.1.RELEASE Implementation-Vendor: Pivotal Software, Inc. Main-Class: org.springframework.boot.loader.JarLauncher Start-Class: com.thanple.little.boy.web.WebApplication Spring-Boot-Classes: BOOT-INF/classes/ Spring-Boot-Lib: BOOT-INF/lib/ Created-By: Apache Maven 3.6.3 Build-Jdk: 1.8.0_191 Implementation-URL: http://projects.spring.io/spring-boot/LittleBoy/
Main-Class是Jar包的启动类,org.springframework.boot.loader.JarLauncher
Start-Class就是你写的项目启动的主函数
FatJar并不是一个标准的jar包结构,只有org.springframework.boot才是符合jar包标准的,BOOT-INF目录下的都是无法加载的,因此SpringBoot需要自定义加载器。
SpringBoot启动加载类流程
刚才提到的org.springframework.boot.loader.JarLauncher,就是SpringBoot真正的启动主函数,那跟本地写的main函数类(假设为WebApplication)有什么区别呢?
普通的本地main函数,没有嵌套的Jar,是由AppClassLoader直接加载启动,而SpringBoot则是自己写了一套类加载器LaunchedURLClassLoader。
JarLauncher的main函数作为入口,创建实例调用了Launcher.launch函数
java
复制代码
public static void main(String[] args) throws Exception { new JarLauncher().launch(args); }
Launcher.launch进入可以看到创建了一个LaunchedURLClassLoader,由LaunchedURLClassLoader去加载FatJar中的class和jar嵌套的jar(即jar in jar)。
java
复制代码
protected void launch(String[] args) throws Exception { if (!this.isExploded()) { JarFile.registerUrlProtocolHandler(); } //加载URL,由LaunchedURLClassLoader加载 ClassLoader classLoader = this.createClassLoader(this.getClassPathArchivesIterator()); String jarMode = System.getProperty("jarmode"); String launchClass = jarMode != null && !jarMode.isEmpty() ? "org.springframework.boot.loader.jarmode.JarModeLauncher" : this.getMainClass(); this.launch(args, launchClass, classLoader); } //创建LaunchedURLClassLoader protected ClassLoader createClassLoader(URL[] urls) throws Exception { return new LaunchedURLClassLoader(this.isExploded(), this.getArchive(), urls, this.getClass().getClassLoader()); }
然后在this.launch(args, launchClass, classLoader);里面使用LaunchedURLClassLoader调用自己写的主函数WebApplication
java
复制代码
public class MainMethodRunner { //... public void run() throws Exception { Class<?> mainClass = Class.forName(this.mainClassName, false, Thread.currentThread().getContextClassLoader()); Method mainMethod = mainClass.getDeclaredMethod("main", String[].class); mainMethod.setAccessible(true); mainMethod.invoke((Object)null, this.args); } }
这里反射调用自己写的主函数WebApplication的main函数,这样就完成了一套加载的流程。
完整的流程链路如图所示:
LaunchedURLClassLoader
LaunchedURLClassLoader作为SpringBoot加载FatJar的主要类加载器,继承了URLClassLoader,重写了loadClass方法,但是这个类里面看不到多少核心的逻辑。
java
复制代码
@Override protected Class<?> loadClass(String name, boolean resolve) throws ClassNotFoundException { if (name.startsWith("org.springframework.boot.loader.jarmode.")) { try { Class<?> result = loadClassInLaunchedClassLoader(name); if (resolve) { resolveClass(result); } return result; } catch (ClassNotFoundException ex) { } } if (this.exploded) { return super.loadClass(name, resolve); } Handler.setUseFastConnectionExceptions(true); try { try { definePackageIfNecessary(name); } catch (IllegalArgumentException ex) { // Tolerate race condition due to being parallel capable if (getPackage(name) == null) { // This should never happen as the IllegalArgumentException indicates // that the package has already been defined and, therefore, // getPackage(name) should not return null. throw new AssertionError("Package " + name + " has already been defined but it could not be found"); } } return super.loadClass(name, resolve); } finally { Handler.setUseFastConnectionExceptions(false); } }
里面区分了org.springframework.boot.loader.jarmode和其他jar区别,定义了包名,
核心的逻辑还是调用了super.loadClass,就是URLClassLoader.loadClass。
URLClassLoader.loadClass就是上面的加载的URL的流程,那么FatJar和普通的Jar是怎么区分逻辑的呢?
所有的不同在于Launcher.launch中的加载URL的流程中:
kotlin
复制代码
ClassLoader classLoader = this.createClassLoader(this.getClassPathArchivesIterator());
ExecutableArchiveLauncher中可以看到getClassPathArchivesIterator的逻辑
java
复制代码
protected Iterator<Archive> getClassPathArchivesIterator() throws Exception { Archive.EntryFilter searchFilter = this::isSearchCandidate; Iterator<Archive> archives = this.archive.getNestedArchives(searchFilter, (entry) -> { return this.isNestedArchive(entry) && !this.isEntryIndexed(entry); }); if (this.isPostProcessingClassPathArchives()) { archives = this.applyClassPathArchivePostProcessing(archives); } return archives; }
其中getNestedArchives获取了FatJar中的jar包(jar in jar)中的归档信息,BOOT-INF/classes和BOOT-INF/lib/*.jar,每个元素都作为一个Archive,返回一个迭代器列表。
FatJar的加载
SpringBoot在org.springframework.boot.loader.jar中重新定义了(确切的说应该是扩展)jar的实现,包括JavaFile,JavaEntry,JarURLConnection等。
this.archive.getNestedArchives一路深入进去查看源码,可以看到JarFile里面有个函数
java
复制代码
private JarFile createJarFileFromEntry(org.springframework.boot.loader.jar.JarEntry entry) throws IOException { return entry.isDirectory() ? this.createJarFileFromDirectoryEntry(entry) : this.createJarFileFromFileEntry(entry); }
BOOT-INF/classes作为一个目录会构造一个JavaFile,而BOOT-INF/lib/*.jar则作为嵌套jar(jar in jar)则会构造另一个JavaFile
那么这个嵌套Jar(jar in jar)又是如何读取数据的呢?
我们在JavaFile.createJarFileFromFileEntry中可以找到逻辑
java
复制代码
private JarFile createJarFileFromFileEntry(org.springframework.boot.loader.jar.JarEntry entry) throws IOException { if (entry.getMethod() != 0) { throw new IllegalStateException("Unable to open nested entry '" + entry.getName() + "'. It has been compressed and nested jar files must be stored without compression. Please check the mechanism used to create your executable jar file"); } else { RandomAccessData entryData = this.entries.getEntryData(entry.getName()); return new JarFile(this.rootFile, this.pathFromRoot + "!/" + entry.getName(), entryData, JarFile.JarFileType.NESTED_JAR); } }
其中entries就是指的外层FatJar的每一条数据,比如BOOT-INF/lib/a.jar,BOOT-INF/lib/b.jar,作为jar in jar,先获取这个jar in jar中的RandomAccessData数据流。
然后通过RandomAccessData数据流再构造一个JavaFile,这样就可以将构造的Jar in jar进行数据读取和访问了。
jar in jar 的路径大概长这样:
LittleBoy-1.0.jar!/BOOT-INF/lib/a.jar
LittleBoy-1.0.jar!/BOOT-INF/lib/b.jar
LittleBoy-1.0.jar!/BOOT-INF/lib/c.jar
而JavaFile获取到的URL就是可以由URLClassLoader加载的URL
java
复制代码
public URL getUrl() throws MalformedURLException { if (this.url == null) { String file = this.rootFile.getFile().toURI() + this.pathFromRoot + "!/"; file = file.replace("file:////", "file://"); this.url = new URL("jar", "", -1, file, new Handler(this)); } return this.url; }
这里返回URL的时候 new 了一个Handler来实现URLStreamHandler处理URL的逻辑。
我们打开这个Handler的源码,org.springframework.boot.loader.jar.Handler
可以看到获取URLConnection的处理逻辑
java
复制代码
protected URLConnection openConnection(URL url) throws IOException { if (this.jarFile != null && this.isUrlInJarFile(url, this.jarFile)) { return JarURLConnection.get(url, this.jarFile); } else { try { return JarURLConnection.get(url, this.getRootJarFileFromUrl(url)); } catch (Exception var3) { return this.openFallbackConnection(url, var3); } } }
获取到的JarURLConnection中有getInputStream方法返回查找的字节流。
返回这个字节流是如何加载到LaunchedURLClassLoader中的呢?
前面已经说了LaunchedURLClassLoader继承了URLClassLoader,根据URL返回的字节流,就可以根据ClassName获取到Resource,
以下是URLClassLoader.getResource方法
而这个Resource,就可以defineClass,即定义一个类
以下代码摘自URLClassLoader.findClass
java
复制代码
protected Class<?> findClass(final String name) throws ClassNotFoundException { //省略部分代码 ... String path = name.replace('.', '/').concat(".class"); Resource res = ucp.getResource(path, false); if (res != null) { try { return defineClass(name, res); } catch (IOException e) { throw new ClassNotFoundException(name, e); } } else{ return null; } }
原文链接:https://juejin.cn/post/7275225948453437480
相关推荐
- SpringBoot+LayUI后台管理系统开发脚手架
-
源码获取方式:关注,转发之后私信回复【源码】即可免费获取到!项目简介本项目本着避免重复造轮子的原则,建立一套快速开发JavaWEB项目(springboot-mini),能满足大部分后台管理系统基础开...
- Spring Boot+Vue全栈开发实战,中文版高清PDF资源
-
SpringBoot+Vue全栈开发实战,中文高清PDF资源,需要的可以私我:)SpringBoot致力于简化开发配置并为企业级开发提供一系列非业务性功能,而Vue则采用数据驱动视图的方式将程序...
- 2021年超详细的java学习路线总结—纯干货分享
-
本文整理了java开发的学习路线和相关的学习资源,非常适合零基础入门java的同学,希望大家在学习的时候,能够节省时间。纯干货,良心推荐!第一阶段:Java基础...
- 探秘Spring Cache:让Java应用飞起来的秘密武器
-
探秘SpringCache:让Java应用飞起来的秘密武器在当今快节奏的软件开发环境中,性能优化显得尤为重要。SpringCache作为Spring框架的一部分,为我们提供了强大的缓存管理能力,让...
- 3,从零开始搭建SSHM开发框架(集成Spring MVC)
-
目录本专题博客已共享在(这个可能会更新的稍微一些)https://code.csdn.net/yangwei19680827/maven_sshm_blog...
- Spring Boot中如何使用缓存?超简单
-
SpringBoot中的缓存可以减少从数据库重复获取数据或执行昂贵计算的需要,从而显著提高应用程序的性能。SpringBoot提供了与各种缓存提供程序的集成,您可以在应用程序中轻松配置和使用缓...
- 我敢保证,全网没有再比这更详细的Java知识点总结了,送你啊
-
接下来你看到的将是全网最详细的Java知识点总结,全文分为三大部分:Java基础、Java框架、Java+云数据小编将为大家仔细讲解每大部分里面的详细知识点,别眨眼,从小白到大佬、零基础到精通,你绝...
- 1,从零开始搭建SSHM开发框架(环境准备)
-
目录本专题博客已共享在https://code.csdn.net/yangwei19680827/maven_sshm_blog1,从零开始搭建SSHM开发框架(环境准备)...
- 做一个适合二次开发的低代码平台,把程序员从curd中解脱出来-1
-
干程序员也有好长时间了,大多数时间都是在做curd。现在想做一个通用的curd平台直接将我们解放出来;把核心放在业务处理中。用过代码生成器,在数据表设计好之后使用它就可以生成需要的controller...
- 设计一个高性能Java Web框架(java做网站的框架)
-
设计一个高性能JavaWeb框架在当今互联网高速发展的时代,构建高性能的JavaWeb框架对于提升用户体验至关重要。本文将从多个角度探讨如何设计这样一个框架,让我们一起进入这段充满挑战和乐趣的旅程...
- 【推荐】强&牛!一款开源免费的功能强大的代码生成器系统!
-
今天,给大家推荐一个代码生成器系统项目,这个项目目前收获了5.3KStar,个人觉得不错,值得拿出来和大家分享下。这是我目前见过最好的代码生成器系统项目。功能完整,代码结构清晰。...
- Java面试题及答案总结(2025版持续更新)
-
大家好,我是Java面试分享最近很多小伙伴在忙着找工作,给大家整理了一份非常全面的Java面试场景题及答案。...
- Java开发网站架构演变过程-从单体应用到微服务架构详解
-
Java开发网站架构演变过程,到目前为止,大致分为5个阶段,分别为单体架构、集群架构、分布式架构、SOA架构和微服务架构。下面玄武老师来给大家详细介绍下这5种架构模式的发展背景、各自优缺点以及涉及到的...
- 本地缓存GuavaCache(一)(guava本地缓存原理)
-
在并发量、吞吐量越来越大的情况下往往是离不开缓存的,使用缓存能减轻数据库的压力,临时存储数据。根据不同的场景选择不同的缓存,分布式缓存有Redis,Memcached、Tair、EVCache、Aer...
- 一周热门
- 最近发表
- 标签列表
-
- mydisktest_v298 (34)
- document.appendchild (35)
- 头像打包下载 (61)
- acmecadconverter_8.52绿色版 (39)
- word文档批量处理大师破解版 (36)
- server2016安装密钥 (33)
- mysql 昨天的日期 (37)
- parsevideo (33)
- 个人网站源码 (37)
- centos7.4下载 (33)
- mysql 查询今天的数据 (34)
- intouch2014r2sp1永久授权 (36)
- 先锋影音源资2019 (35)
- jdk1.8.0_191下载 (33)
- axure9注册码 (33)
- pts/1 (33)
- spire.pdf 破解版 (35)
- shiro jwt (35)
- sklearn中文手册pdf (35)
- itextsharp使用手册 (33)
- 凯立德2012夏季版懒人包 (34)
- 冒险岛代码查询器 (34)
- 128*128png图片 (34)
- jdk1.8.0_131下载 (34)
- dos 删除目录下所有子目录及文件 (36)