Spring Boot 启动类真的是XXApplication?

 2022-08-16
原文地址:https://blog.51cto.com/u_15486212/5284275

1. 引言

SpringBoot项目中的启动类,一般都是XXApplication,例如StatsApplication,UnionApplication。

每个项目的启动类名称都不一样。

但是它的启动类真的是XXApplication吗?

202208162332425671.png

2. META-INF/Manifest.mf文件

jar文件实际上是class文件的zip压缩存档。jar并不能表达应用程序的便签信息.

META-INF/Manifest.mf文件提供存档的便签信息,Manifest.mf有 Main-Class,用来标明jar文件的入口类。

解压jar包,查看META-INF/Manifest.mf过程如下:

202208162332436022.png

重要信息如下

    
    Main-Class: org.springframework.boot.loader.JarLauncher
    Start-Class: com.shanyuan.StatsApplication

也就是说:org.springframework.boot.loader.JarLauncher 才是 Spring Boot 的启动类!

不熟悉 Spring BooMain-Class: org.springframework.boot.loader.JarLauncher Start-Class: com.shanyuan.StatsApplicationt 的可以看下这个仓库:https://github.com/javastacks/spring-boot-best-practice

下面浏览下JarLauncher

3. 浏览JarLauncher

3.1 找到JarLauncher

进入IDEA,Ctrl+N查找JarLauncher,竟然找不到!!

202208162332448793.png

进入 https://search.maven.org/classic/#advancedsearch 查询JarLauncher

202208162332458884.png

在查询结果找到spring下的项目

202208162332469805.png

确定JarLauncher位于spring-boot-loader下。为了方便查看源码,在pom中引入

    ​​<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-loader</artifactId>
        <scope>provided</scope>
    </dependency>

3.2.JarLauncher说明

JarLauncher作为引导类 ,当调用java -jar 命令时,将调用main方法,实际上调用的是 JarLauncher#launch方法,该方法继承与org.springframework.boot.loader.Launcher

简化层次关系为:

202208162332482546.png

JarLauncher#launch代码如下

    ​​protected void launch(String[] args) throws Exception {
       JarFile.registerUrlProtocolHandler();
       ClassLoader classLoader = createClassLoader(getClassPathArchives());
       launch(args, getMainClass(), classLoader);
    }

聚句解析

1,.JarFile.registerUrlProtocolHandler();

Spring Boot生成的FAT jar,在被java -jar 引导时,其内部的jar文件无法被sun.net. www.protocol .jar.Handler处理。

所以SpringBoot实现了,org.springframework.boot.loader.jar.Handler

JarFile.registerUrlProtocolHandler(),就注册 org.springframework.boot.loader.jar.Handler

2,ClassLoader classLoader = createClassLoader(getClassPathArchives());

创建ClassLoader。

getClassPathArchives 核心判断是 isNestedArchive方法。

isNestedArchive被JarLauncher覆写了。

其实现如下:

    ​​static final String BOOT_INF_CLASSES = "BOOT-INF/classes/";
    
    static final String BOOT_INF_LIB = "BOOT-INF/lib/";
    @Override
    protected boolean isNestedArchive(Archive.Entry entry) {
       if (entry.isDirectory()) {
          return entry.getName().equals(BOOT_INF_CLASSES);
       }
       return entry.getName().startsWith(BOOT_INF_LIB);
    }
    ​

也就是说,只要 满足以BOOT-INF/classes/和BOOT-INF/lib/都是classLoader加载的范围。

解压的jar,查看也与只对应

202208162332491717.png

  1. launch(args, getMainClass(), classLoader);
    ​​protected void launch(String[] args, String mainClass, 
                    ClassLoader classLoader)
          throws Exception {
       Thread.currentThread().setContextClassLoader(classLoader);
       createMainMethodRunner(mainClass, args, classLoader).run();
    }
    ​

查看createMainMethodRunner的run方法,如下:

    ​​public class MainMethodRunner {
        // 省略部分代码
        public void run() throws Exception {
       Class<?> mainClass = Thread.currentThread().getContextClassLoader()
             .loadClass(this.mainClassName);
           Method mainMethod = 
               mainClass.getDeclaredMethod("main", String[].class);
           mainMethod.invoke(null, new Object[] { this.args });
        }
    }
    ​

其中mainClass,来自/META-INF/MANIFEST.MF中的Start-Class属性。

即,JarLauncher是同进程内,通过反射调用Start-Class对应类,即XXXApplication的main方法。

4.总结

Spring Boot 项目的实际启动类是org.springframework.boot.loader.JarLauncher。

在JarLauncher内部通过反射调用XXApplication类的main方法。

具体实现位于 MainMethodRunner中。最后,关于 Spring Boot 系列教程可以关注公众号互联网架构师获取阅读。

作者:温安适