Spring Boot打的包为什么能直接运行?

开发 后端
Spring Boot 提供了一个插件 spring-boot-maven-plugin 用于把程序打包成一个可执行的jar包。

Spring Boot 提供了一个插件 spring-boot-maven-plugin 用于把程序打包成一个可执行的jar包。

在pom文件里加入这个插件即可: 

  1. <build>    
  2.  <plugins>    
  3.  <plugin>    
  4.  <groupId>org.springframework.boot</groupId>    
  5.  <artifactId>spring-boot-maven-plugin</artifactId>    
  6.  </plugin>    
  7.  </plugins>    
  8. </build>   

打包完生成的executable-jar-1.0-SNAPSHOT.jar内部的结构如下: 

  1. ├── META-INF  
  2. │   ├── MANIFEST.MF  
  3. │   └── maven  
  4. │       └── spring.study  
  5. │           └── executable-jar  
  6. │               ├── pom.properties  
  7. │               └── pom.xml  
  8. ├── lib  
  9. │   ├── aopalliance-1.0.jar  
  10. │   ├── classmate-1.1.0.jar  
  11. │   ├── spring-boot-1.3.5.RELEASE.jar  
  12. │   ├── spring-boot-autoconfigure-1.3.5.RELEASE.jar  
  13. │   ├── ...  
  14. ├── org  
  15. │   └── springframework  
  16. │       └── boot  
  17. │           └── loader  
  18. │               ├── ExecutableArchiveLauncher$1.class  
  19. │               ├── ...  
  20. └── spring  
  21.     └── study  
  22.         └── executablejar  
  23.             └── ExecutableJarApplication.class 

然后可以直接执行jar包就能启动程序了: 

  1. java -jar executable-jar-1.0-SNAPSHOT.jar 

运行 Spring Boot 应用的几种方式看这篇:运行 Spring Boot 应用的3种方式。

打包出来fat jar内部有4种文件类型:

  1.  META-INF文件夹:程序入口,其中MANIFEST.MF用于描述jar包的信息
  2.  lib目录:放置第三方依赖的jar包,比如springboot的一些jar包
  3.  spring boot loader相关的代码
  4.  模块自身的代码

MANIFEST.MF文件的内容: 

  1. Manifest-Version: 1.0  
  2. Implementation-Title: executable-jar  
  3. Implementation-Version: 1.0-SNAPSHOT  
  4. Archiver-Version: Plexus Archiver  
  5. Built-By: Format  
  6. Start-Class: spring.study.executablejar.ExecutableJarApplication  
  7. Implementation-Vendor-Id: spring.study  
  8. Spring-Boot-Version: 1.3.5.RELEASE  
  9. Created-By: Apache Maven 3.2.3  
  10. Build-Jdk: 1.8.0_20  
  11. Implementation-Vendor: Pivotal Software, Inc.  
  12. 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。

关注微信公众号:Java技术栈,在后台回复:boot,可以获取我整理的 N 篇 Spring boot 教程,都是干货。

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为: 

  1. jar:file:/Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/ 

它对应的JarFile为: 

  1. /Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar 

这个JarFile有很多Entry,比如: 

  1. META-INF/  
  2. META-INF/MANIFEST.MF  
  3. spring/  
  4. spring/study/  
  5. ....  
  6. spring/study/executablejar/ExecutableJarApplication.class  
  7. lib/spring-boot-starter-1.3.5.RELEASE.jar  
  8. lib/spring-boot-1.3.5.RELEASE.jar  
  9. ... 

JarFileArchive内部的一些依赖jar对应的URL(SpringBoot使用org.springframework.boot.loader.jar.Handler处理器来处理这些URL): 

  1. 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!/ 
  2. 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能处理,它是 Spring Boot 内部扩展出来的一种URL协议。

JarLauncher的执行过程

JarLauncher的main方法: 

  1. public static void main(String\[\] args) {    
  2.  // 构造JarLauncher,然后调用它的launch方法。参数是控制台传递的    
  3.  new JarLauncher().launch(args);    
  4. }   

JarLauncher被构造的时候会调用父类ExecutableArchiveLauncher的构造方法。

ExecutableArchiveLauncher的构造方法内部会去构造Archive,这里构造了JarFileArchive。构造JarFileArchive的过程中还会构造很多东西,比如JarFile,Entry …

JarLauncher的launch方法: 

  1. protected void launch(String\[\] args) {    
  2.  try {    
  3.  // 在系统属性中设置注册了自定义的URL处理器:org.springframework.boot.loader.jar.Handler。如果URL中没有指定处理器,会去系统属性中查询    
  4.  JarFile.registerUrlProtocolHandler();    
  5.  // getClassPathArchives方法在会去找lib目录下对应的第三方依赖JarFileArchive,同时也会项目自身的JarFileArchive    
  6.  // 根据getClassPathArchives得到的JarFileArchive集合去创建类加载器ClassLoader。这里会构造一个LaunchedURLClassLoader类加载器,这个类加载器继承URLClassLoader,并使用这些JarFileArchive集合的URL构造成URLClassPath   
  7.   // LaunchedURLClassLoader类加载器的父类加载器是当前执行类JarLauncher的类加载器   
  8.  ClassLoader classLoader = createClassLoader(getClassPathArchives());    
  9.  // getMainClass方法会去项目自身的Archive中的Manifest中找出key为Start-Class的类    
  10.  // 调用重载方法launch    
  11.  launch(args, getMainClass(), classLoader);    
  12.  }    
  13.  catch (Exception ex) {    
  14.  ex.printStackTrace();    
  15.  System.exit(1);    
  16.  }    
  17. }    
  18. // Archive的getMainClass方法    
  19. // 这里会找出spring.study.executablejar.ExecutableJarApplication这个类    
  20. public String getMainClass() throws Exception {    
  21.  Manifest manifest = getManifest();   
  22.   String mainClass = null;    
  23.  if (manifest != null) {    
  24.  mainClass = manifest.getMainAttributes().getValue("Start-Class");    
  25.  }    
  26.  if (mainClass == null) {    
  27.  throw new IllegalStateException(    
  28.  "No 'Start-Class' manifest entry specified in " \+ this);    
  29.  }    
  30.  return mainClass;    
  31. }    
  32. // launch重载方法    
  33. protected void launch(String\[\] args, String mainClass, ClassLoader classLoader)    
  34.  throws Exception {   
  35.   // 创建一个MainMethodRunner,并把args和Start-Class传递给它    
  36.  Runnable runner = createMainMethodRunner(mainClass, args, classLoader);    
  37.  // 构造新线程    
  38.  Thread runnerThread = new Thread(runner);    
  39.  // 线程设置类加载器以及名字,然后启动    
  40.  runnerThread.setContextClassLoader(classLoader);  
  41.  runnerThread.setName(Thread.currentThread().getName());    
  42.  runnerThread.start();    
  43. }   

MainMethodRunner的run方法: 

  1. @Override    
  2. public void run() {    
  3.  try {    
  4.  // 根据Start-Class进行实例化  
  5.  Class<?> mainClass = Thread.currentThread().getContextClassLoader()    
  6.  .loadClass(this.mainClassName);    
  7.  // 找出main方法    
  8.  Method mainMethod = mainClass.getDeclaredMethod("main", String\[\].class);    
  9.  // 如果main方法不存在,抛出异常    
  10.  if (mainMethod == null) {    
  11.  throw new IllegalStateException(    
  12.  this.mainClassName + " does not have a main method");    
  13.  }    
  14.  // 调用    
  15.  mainMethod.invoke(null, new Object\[\] { this.args });    
  16.  }    
  17.  catch (Exception ex) {    
  18.  UncaughtExceptionHandler handler = Thread.currentThread()    
  19.  .getUncaughtExceptionHandler();    
  20.  if (handler != null) {    
  21.  handler.uncaughtException(Thread.currentThread(), ex);    
  22.  }    
  23.  throw new RuntimeException(ex);    
  24.  }    
  25. }   

Start-Class的main方法调用之后,内部会构造Spring容器,启动内置Servlet容器等过程。这些过程我们都已经分析过了。Spring Boo主类及目录结构介绍,这篇看下。

关于自定义的类加载器LaunchedURLClassLoader

LaunchedURLClassLoader重写了loadClass方法,也就是说它修改了默认的类加载方式(先看该类是否已加载这部分不变,后面真正去加载类的规则改变了,不再是直接从父类加载器中去加载)。LaunchedURLClassLoader定义了自己的类加载规则: 

  1. private Class<?> doLoadClass(String name) throws ClassNotFoundException {   
  2.  // 1) Try the root class loader    
  3.  try {    
  4.  if (this.rootClassLoader != null) {   
  5.  return this.rootClassLoader.loadClass(name);    
  6.  }    
  7.  }    
  8.  catch (Exception ex) {    
  9.  // Ignore and continue    
  10.  }    
  11.  // 2) Try to find locally    
  12.  try {   
  13.   findPackage(name);    
  14.  Class<?> cls = findClass(name);   
  15.  return cls;    
  16.  }    
  17.  catch (Exception ex) {    
  18.  // Ignore and continue    
  19.  }    
  20.  // 3) Use standard loading    
  21.  return super.loadClass(name, false);    
  22. }   

加载规则:

  1.  如果根类加载器存在,调用它的加载方法。这里是根类加载是ExtClassLoader
  2.  调用LaunchedURLClassLoader自身的findClass方法,也就是URLClassLoader的findClass方法
  3.  调用父类的loadClass方法,也就是执行默认的类加载顺序(从BootstrapClassLoader开始从下往下寻找)

LaunchedURLClassLoader自身的findClass方法: 

  1. protected Class<?> findClass(final String name)  
  2.  throws ClassNotFoundException    
  3. {    
  4.  try {    
  5.  return AccessController.doPrivileged(    
  6.  new PrivilegedExceptionAction<Class<?>>() {    
  7.  public Class<?> run() throws ClassNotFoundException {    
  8.  // 把类名解析成路径并加上.class后缀    
  9.  String path = name.replace('.', '/').concat(".class");    
  10.  // 基于之前得到的第三方jar包依赖以及自己的jar包得到URL数组,进行遍历找出对应类名的资源    
  11.  // 比如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!/中被找出   
  12.   // 那么找出的资源对应的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   
  13.   Resource res = ucp.getResource(path, false);    
  14.  if (res != null) { // 找到了资源    
  15.  try {    
  16.  return defineClass(name, res);    
  17.  } catch (IOException e) {    
  18.  throw new ClassNotFoundException(name, e); 
  19.  }    
  20.  } else { // 找不到资源的话直接抛出ClassNotFoundException异常    
  21.  throw new ClassNotFoundException(name);    
  22.  }    
  23.  }    
  24.  }, acc);    
  25.  } catch (java.security.PrivilegedActionException pae) {
  26.   throw (ClassNotFoundException) pae.getException();   
  27.  }    
  28. }   

 下面是LaunchedURLClassLoader的一个测试: 

  1. // 注册org.springframework.boot.loader.jar.Handler URL协议处理器    
  2. JarFile.registerUrlProtocolHandler();    
  3. // 构造LaunchedURLClassLoader类加载器,这里使用了2个URL,分别对应jar包中依赖包spring-boot-loader和spring-boot,使用 "!/" 分开,需要org.springframework.boot.loader.jar.Handler处理器处理   
  4. LaunchedURLClassLoader classLoader = new LaunchedURLClassLoader(    
  5.  new URL\[\] {    
  6.  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!/")   
  7.   , 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!/")   
  8.   },   
  9.  LaunchedURLClassLoaderTest.class.getClassLoader());    
  10. // 加载类    
  11. // 这2个类都会在第二步本地查找中被找出(URLClassLoader的findClass方法)    
  12. classLoader.loadClass("org.springframework.boot.loader.JarLauncher");    
  13. classLoader.loadClass("org.springframework.boot.SpringApplication");    
  14. // 在第三步使用默认的加载顺序在ApplicationClassLoader中被找出    
  15. classLoader.loadClass("org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration");   

Spring Boot Loader的作用

Spring Boot 在可执行jar包中定义了自己的一套规则,比如第三方依赖jar包在/lib目录下,jar包的URL路径使用自定义的规则并且这个规则需要使用org.springframework.boot.loader.jar.Handler处理器处理。

它的Main-Class使用JarLauncher,如果是war包,使用WarLauncher执行。这些Launcher内部都会另起一个线程启动自定义的SpringApplication类。

这些特性通过spring-boot-maven-plugin插件打包完成。 

 

责任编辑:庞桂玉 来源: Java技术栈
相关推荐

2022-02-13 20:31:26

SpringBootjarmanifests

2024-04-03 09:01:34

SpringTomcat容器

2023-11-30 08:16:19

SpringjarTomcat

2015-08-17 10:16:00

CentOSDocker命令root

2023-04-04 22:23:09

2009-06-29 18:35:41

操作系统服务器软件

2019-03-06 13:45:20

Windows 10Xbox微软

2020-06-30 14:25:28

MavenGradle Spring

2020-08-27 11:35:36

Python 开发编程语言

2022-05-07 07:47:23

SpringJava开发

2020-11-11 16:46:35

苹果macOS操作系统

2020-08-14 10:40:35

RestTemplatRetrofitJava

2023-07-31 07:45:12

Spring项目Jakarta

2020-10-22 14:20:39

Parallels

2023-05-29 08:43:46

SpringJava

2020-08-24 15:56:49

AndroidWindows 10三星

2024-05-29 10:43:31

2015-05-12 10:34:45

2024-04-07 00:00:00

服务器浏览器AI

2023-12-20 07:36:58

GoLinux语言
点赞
收藏

51CTO技术栈公众号