作者 ： 哈莫 , 来源 ： http://fangjian0423.github.io/
SpringBoot 提供了一个插件 spring-boot-maven-plugin 用于把程序打包成一个可执行的 jar 包。在 pom 文件里加入这个插件即可：
<build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins></build>
复制代码
打包完生成的 executable-jar-1.0-SNAPSHOT.jar 内部的结构如下：
├── META-INF│ ├── MANIFEST.MF│ └── maven│ └── spring.study│ └── executable-jar│ ├── pom.properties│ └── pom.xml├── lib│ ├── aopalliance-1.0.jar│ ├── classmate-1.1.0.jar│ ├── spring-boot-1.3.5.RELEASE.jar│ ├── spring-boot-autoconfigure-1.3.5.RELEASE.jar│ ├── ...├── org│ └── springframework│ └── boot│ └── loader│ ├── ExecutableArchiveLauncher$1.class│ ├── ...└── spring └── study └── executablejar └── ExecutableJarApplication.class
复制代码
然后可以直接执行 jar 包就能启动程序了：
java -jar executable-jar-1.0-SNAPSHOT.jar
复制代码
打包出来 fat jar 内部有 4 种文件类型：
MANIFEST.MF 文件的内容：
Manifest-Version: 1.0Implementation-Title: executable-jarImplementation-Version: 1.0-SNAPSHOTArchiver-Version: Plexus ArchiverBuilt-By: FormatStart-Class: spring.study.executablejar.ExecutableJarApplicationImplementation-Vendor-Id: spring.studySpring-Boot-Version: 1.3.5.RELEASECreated-By: Apache Maven 3.2.3Build-Jdk: 1.8.0_20Implementation-Vendor: Pivotal Software, Inc.Main-Class: org.springframework.boot.loader.JarLauncher
复制代码
我们看到，它的 Main-Class 是 org.springframework.boot.loader.JarLauncher，当我们使用 java -jar 执行 jar 包的时候会调用 JarLauncher 的 main 方法，而不是我们编写的 SpringApplication。
那么 JarLauncher 这个类是的作用是什么的？
它是 SpringBoot 内部提供的工具 Spring Boot Loader 提供的一个用于执行 Application 类的工具类 (fat jar 内部有 spring loader 相关的代码就是因为这里用到了)。相当于 Spring Boot Loader 提供了一套标准用于执行 SpringBoot 打包出来的 jar
# Spring Boot Loader 抽象的一些类
抽象类 Launcher：各种 Launcher 的基础抽象类，用于启动应用程序；跟 Archive 配合使用；目前有 3 种实现，分别是 JarLauncher、WarLauncher 以及 PropertiesLauncher
Archive：归档文件的基础抽象类。JarFileArchive 就是 jar 包文件的抽象。它提供了一些方法比如 getUrl 会返回这个 Archive 对应的 URL；getManifest 方法会获得 Manifest 数据等。ExplodedArchive 是文件目录的抽象
JarFile：对 jar 包的封装，每个 JarFileArchive 都会对应一个 JarFile。JarFile 被构造的时候会解析内部结构，去获取 jar 包里的各个文件或文件夹，这些文件或文件夹会被封装到 Entry 中，也存储在 JarFileArchive 中。如果 Entry 是个 jar，会解析成 JarFileArchive。
比如一个 JarFileArchive 对应的 URL 为：
jar:file:/Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/
复制代码
它对应的 JarFile 为：
/Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar
复制代码
这个 JarFile 有很多 Entry，比如：
META-INF/META-INF/MANIFEST.MFspring/spring/study/....spring/study/executablejar/ExecutableJarApplication.classlib/spring-boot-starter-1.3.5.RELEASE.jarlib/spring-boot-1.3.5.RELEASE.jar...
复制代码
JarFileArchive 内部的一些依赖 jar 对应的 URL(SpringBoot 使用 org.springframework.boot.loader.jar.Handler 处理器来处理这些 URL)：
jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-starter-web-1.3.5.RELEASE.jar!/jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-loader-1.3.5.RELEASE.jar!/org/springframework/boot/loader/JarLauncher.class
复制代码
我们看到如果有 jar 包中包含 jar，或者 jar 包中包含 jar 包里面的 class 文件，那么会使 用 !/ 分隔开，这种方式只有 org.springframework.boot.loader.jar.Handler 能处 理，它是 SpringBoot 内部扩展出来的一种 URL 协议。
# JarLauncher 的执行过程
JarLauncher 的 main 方法：
public static void main(String[] args) { // 构造JarLauncher，然后调用它的launch方法。参数是控制台传递的 new JarLauncher().launch(args);}
复制代码
JarLauncher 被构造的时候会调用父类 ExecutableArchiveLauncher 的构造方法。
ExecutableArchiveLauncher 的构造方法内部会去构造 Archive，这里构造了 JarFileArchive。构造 JarFileArchive 的过程中还会构造很多东西，比如 JarFile，Entry …
JarLauncher的launch方法：protected void launch(String[] args) { try { // 在系统属性中设置注册了自定义的URL处理器：org.springframework.boot.loader.jar.Handler。如果URL中没有指定处理器，会去系统属性中查询 JarFile.registerUrlProtocolHandler(); // getClassPathArchives方法在会去找lib目录下对应的第三方依赖JarFileArchive，同时也会项目自身的JarFileArchive // 根据getClassPathArchives得到的JarFileArchive集合去创建类加载器ClassLoader。这里会构造一个LaunchedURLClassLoader类加载器，这个类加载器继承URLClassLoader，并使用这些JarFileArchive集合的URL构造成URLClassPath // LaunchedURLClassLoader类加载器的父类加载器是当前执行类JarLauncher的类加载器 ClassLoader classLoader = createClassLoader(getClassPathArchives()); // getMainClass方法会去项目自身的Archive中的Manifest中找出key为Start-Class的类 // 调用重载方法launch launch(args, getMainClass(), classLoader); } catch (Exception ex) { ex.printStackTrace(); System.exit(1); }}
// Archive的getMainClass方法// 这里会找出spring.study.executablejar.ExecutableJarApplication这个类public String getMainClass() throws Exception { Manifest manifest = getManifest(); String mainClass = null; if (manifest != null) { mainClass = manifest.getMainAttributes().getValue("Start-Class"); } if (mainClass == null) { throw new IllegalStateException( "No 'Start-Class' manifest entry specified in " + this); } return mainClass;}
// launch重载方法protected void launch(String[] args, String mainClass, ClassLoader classLoader) throws Exception { // 创建一个MainMethodRunner，并把args和Start-Class传递给它 Runnable runner = createMainMethodRunner(mainClass, args, classLoader); // 构造新线程 Thread runnerThread = new Thread(runner); // 线程设置类加载器以及名字，然后启动 runnerThread.setContextClassLoader(classLoader); runnerThread.setName(Thread.currentThread().getName()); runnerThread.start();}
复制代码
MainMethodRunner 的 run 方法：
@Overridepublic void run() { try { // 根据Start-Class进行实例化 Class<?> mainClass = Thread.currentThread().getContextClassLoader() .loadClass(this.mainClassName); // 找出main方法 Method mainMethod = mainClass.getDeclaredMethod("main", String[].class); // 如果main方法不存在，抛出异常 if (mainMethod == null) { throw new IllegalStateException( this.mainClassName + " does not have a main method"); } // 调用 mainMethod.invoke(null, new Object[] { this.args }); } catch (Exception ex) { UncaughtExceptionHandler handler = Thread.currentThread() .getUncaughtExceptionHandler(); if (handler != null) { handler.uncaughtException(Thread.currentThread(), ex); } throw new RuntimeException(ex); }}
复制代码
Start-Class 的 main 方法调用之后，内部会构造 Spring 容器，启动内置 Servlet 容器等过程。这些过程我们都已经分析过了。
# 关于自定义的类加载器 LaunchedURLClassLoader
LaunchedURLClassLoader 重写了 loadClass 方法，也就是说它修改了默认的类加载方式 (先看该类是否已加载这部分不变，后面真正去加载类的规则改变了，不再是直接从父类加载器中去加载)。LaunchedURLClassLoader 定义了自己的类加载规则：
private Class<?> doLoadClass(String name) throws ClassNotFoundException {
// 1) Try the root class loader try { if (this.rootClassLoader != null) { return this.rootClassLoader.loadClass(name); } } catch (Exception ex) { // Ignore and continue }
// 2) Try to find locally try { findPackage(name); Class<?> cls = findClass(name); return cls; } catch (Exception ex) { // Ignore and continue }
// 3) Use standard loading return super.loadClass(name, false);}
复制代码
加载规则：
如果根类加载器存在，调用它的加载方法。这里是根类加载是 ExtClassLoader
调用 LaunchedURLClassLoader 自身的 findClass 方法，也就是 URLClassLoader 的 findClass 方法
调用父类的 loadClass 方法，也就是执行默认的类加载顺序 (从 BootstrapClassLoader 开始从下往下寻找)
LaunchedURLClassLoader 自身的 findClass 方法：
protected Class<?> findClass(final String name) throws ClassNotFoundException{ try { return AccessController.doPrivileged( new PrivilegedExceptionAction<Class<?>>() { public Class<?> run() throws ClassNotFoundException { // 把类名解析成路径并加上.class后缀 String path = name.replace('.', '/').concat(".class"); // 基于之前得到的第三方jar包依赖以及自己的jar包得到URL数组，进行遍历找出对应类名的资源 // 比如path是org/springframework/boot/loader/JarLauncher.class，它在jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-loader-1.3.5.RELEASE.jar!/中被找出 // 那么找出的资源对应的URL为jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-loader-1.3.5.RELEASE.jar!/org/springframework/boot/loader/JarLauncher.class Resource res = ucp.getResource(path, false); if (res != null) { // 找到了资源 try { return defineClass(name, res); } catch (IOException e) { throw new ClassNotFoundException(name, e); } } else { // 找不到资源的话直接抛出ClassNotFoundException异常 throw new ClassNotFoundException(name); } } }, acc); } catch (java.security.PrivilegedActionException pae) { throw (ClassNotFoundException) pae.getException(); }}
复制代码
下面是 LaunchedURLClassLoader 的一个测试：
// 注册org.springframework.boot.loader.jar.Handler URL协议处理器JarFile.registerUrlProtocolHandler();// 构造LaunchedURLClassLoader类加载器，这里使用了2个URL，分别对应jar包中依赖包spring-boot-loader和spring-boot，使用 "!/" 分开，需要org.springframework.boot.loader.jar.Handler处理器处理LaunchedURLClassLoader classLoader = new LaunchedURLClassLoader( new URL[] { new URL("jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-loader-1.3.5.RELEASE.jar!/") , new URL("jar:file:/Users/Format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/lib/spring-boot-1.3.5.RELEASE.jar!/") }, LaunchedURLClassLoaderTest.class.getClassLoader());// 加载类// 这2个类都会在第二步本地查找中被找出(URLClassLoader的findClass方法)classLoader.loadClass("org.springframework.boot.loader.JarLauncher");classLoader.loadClass("org.springframework.boot.SpringApplication");// 在第三步使用默认的加载顺序在ApplicationClassLoader中被找出classLoader.loadClass("org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration");
复制代码
# Spring Boot Loader 的作用
SpringBoot 在可执行 jar 包中定义了自己的一套规则，比如第三方依赖 jar 包在 / lib 目录下，jar 包的 URL 路径使用自定义的规则并且这个规则需要使用 org.springframework.boot.loader.jar.Handler 处理器处理。它的 Main-Class 使用 JarLauncher，如果是 war 包，使用 WarLauncher 执行。这些 Launcher 内部都会另起一个线程启动自定义的 SpringApplication 类。
这些特性通过 spring-boot-maven-plugin 插件打包完成。
评论