阅读 479

SpringBoot的启动引导类真的是XXApplication吗?

1. 引言

SpringBoot项目中的启动类,一般都是XXApplication,例如StatsApplication,UnionApplication。每个项目的启动类名称都不一样。但是它的启动类真的是XXApplication吗?

2. META-INF/Manifest.mf文件

jar文件实际上是class文件的zip压缩存档。jar并不能表达应用程序的便签信息.
META-INF/Manifest.mf文件提供存档的便签信息.
Manifest.mf有 Main-Class,用来标明jar文件的入口类。
解压jar包,查看META-INF/Manifest.mf过程如下:

重要信息如下

Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.shanyuan.StatsApplication
复制代码

也就是说: org.springframework.boot.loader.JarLauncher是SpringBoot的启动类!
下面浏览下JarLauncher

3. 浏览JarLauncher

3.1 找到JarLauncher

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

进入 search.maven.org/classic/#ad… 查询JarLauncher

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

确定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
简化层次关系为:


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,查看也与只对应

3. 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.总结


SpringBoot项目的实际启动类是org.springframework.boot.loader.JarLauncher。
在JarLauncher内部通过反射调用XXApplication类的main方法。
具体实现位于 MainMethodRunner中。

5.写在最后

在解决这个问题,查找资料的过程中,发现小马哥写了一本《SpringBoot的编程思想》。
我欣喜的买了一本,阅读了一遍。它详细介绍了SpringBoot的原理。
其中有个章节就是介绍JarLauncher。推荐这本书!
我是自来水,没有广告费。