【轉(zhuǎn)載】面試官問:為什么SpringBoot的 jar 可以直接運(yùn)行蛤迎?

原文:https://mp.weixin.qq.com/s/QMVbz3nRgob9rXoCM-cy5w

SpringBoot提供了一個(gè)插件spring-boot-maven-plugin用于把程序打包成一個(gè)可執(zhí)行的jar包。在pom文件里加入這個(gè)插件即可:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

打包完生成的executable-jar-1.0-SNAPSHOT.jar內(nèi)部的結(jié)構(gòu)如下:

├── 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
然后可以直接執(zhí)行jar包就能啟動(dòng)程序了:

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

打包出來fat jar內(nèi)部有4種文件類型:

META-INF文件夾:程序入口,其中MANIFEST.MF用于描述jar包的信息
lib目錄:放置第三方依賴的jar包,比如springboot的一些jar包
spring boot loader相關(guān)的代碼
模塊自身的代碼
MANIFEST.MF文件的內(nèi)容:

Manifest-Version: 1.0
Implementation-Title: executable-jar
Implementation-Version: 1.0-SNAPSHOT
Archiver-Version: Plexus Archiver
Built-By: Format
Start-Class: spring.study.executablejar.ExecutableJarApplication
Implementation-Vendor-Id: spring.study
Spring-Boot-Version: 1.3.5.RELEASE
Created-By: Apache Maven 3.2.3
Build-Jdk: 1.8.0_20
Implementation-Vendor: Pivotal Software, Inc.
Main-Class: org.springframework.boot.loader.JarLauncher
我們看到矩欠,它的Main-Class是org.springframework.boot.loader.JarLauncher,當(dāng)我們使用java -jar執(zhí)行jar包的時(shí)候會(huì)調(diào)用JarLauncher的main方法悠夯,而不是我們編寫的SpringApplication癌淮。

那么JarLauncher這個(gè)類是的作用是什么的?

它是SpringBoot內(nèi)部提供的工具Spring Boot Loader提供的一個(gè)用于執(zhí)行Application類的工具類(fat jar內(nèi)部有spring loader相關(guān)的代碼就是因?yàn)檫@里用到了)疗疟。相當(dāng)于Spring Boot Loader提供了一套標(biāo)準(zhǔn)用于執(zhí)行SpringBoot打包出來的jar

Spring Boot Loader抽象的一些類
抽象類Launcher:各種Launcher的基礎(chǔ)抽象類该默,用于啟動(dòng)應(yīng)用程序;跟Archive配合使用策彤;目前有3種實(shí)現(xiàn)栓袖,分別是JarLauncher、WarLauncher以及PropertiesLauncher

Archive:歸檔文件的基礎(chǔ)抽象類店诗。JarFileArchive就是jar包文件的抽象裹刮。它提供了一些方法比如getUrl會(huì)返回這個(gè)Archive對(duì)應(yīng)的URL;getManifest方法會(huì)獲得Manifest數(shù)據(jù)等庞瘸。ExplodedArchive是文件目錄的抽象

JarFile:對(duì)jar包的封裝捧弃,每個(gè)JarFileArchive都會(huì)對(duì)應(yīng)一個(gè)JarFile。JarFile被構(gòu)造的時(shí)候會(huì)解析內(nèi)部結(jié)構(gòu),去獲取jar包里的各個(gè)文件或文件夾违霞,這些文件或文件夾會(huì)被封裝到Entry中嘴办,也存儲(chǔ)在JarFileArchive中。如果Entry是個(gè)jar买鸽,會(huì)解析成JarFileArchive涧郊。

比如一個(gè)JarFileArchive對(duì)應(yīng)的URL為:

jar:file:/Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar!/
它對(duì)應(yīng)的JarFile為:

/Users/format/Develop/gitrepository/springboot-analysis/springboot-executable-jar/target/executable-jar-1.0-SNAPSHOT.jar
這個(gè)JarFile有很多Entry,比如:

META-INF/
META-INF/MANIFEST.MF
spring/
spring/study/
....
spring/study/executablejar/ExecutableJarApplication.class
lib/spring-boot-starter-1.3.5.RELEASE.jar
lib/spring-boot-1.3.5.RELEASE.jar
...
JarFileArchive內(nèi)部的一些依賴jar對(duì)應(yīng)的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文件妆艘,那么會(huì)使 用 !/ 分隔開,這種方式只有org.springframework.boot.loader.jar.Handler能處 理看幼,它是SpringBoot內(nèi)部擴(kuò)展出來的一種URL協(xié)議批旺。

JarLauncher的執(zhí)行過程
JarLauncher的main方法:

public static void main(String[] args) {
    // 構(gòu)造JarLauncher,然后調(diào)用它的launch方法诵姜。參數(shù)是控制臺(tái)傳遞的
    new JarLauncher().launch(args);
}  

JarLauncher被構(gòu)造的時(shí)候會(huì)調(diào)用父類ExecutableArchiveLauncher的構(gòu)造方法汽煮。

ExecutableArchiveLauncher的構(gòu)造方法內(nèi)部會(huì)去構(gòu)造Archive,這里構(gòu)造了JarFileArchive茅诱。構(gòu)造JarFileArchive的過程中還會(huì)構(gòu)造很多東西逗物,比如JarFile搬卒,Entry …

JarLauncher的launch方法:

protected void launch(String[] args) {
  try {
    // 在系統(tǒng)屬性中設(shè)置注冊(cè)了自定義的URL處理器:org.springframework.boot.loader.jar.Handler瑟俭。如果URL中沒有指定處理器,會(huì)去系統(tǒng)屬性中查詢
    JarFile.registerUrlProtocolHandler();
    // getClassPathArchives方法在會(huì)去找lib目錄下對(duì)應(yīng)的第三方依賴JarFileArchive契邀,同時(shí)也會(huì)項(xiàng)目自身的JarFileArchive
    // 根據(jù)getClassPathArchives得到的JarFileArchive集合去創(chuàng)建類加載器ClassLoader摆寄。這里會(huì)構(gòu)造一個(gè)LaunchedURLClassLoader類加載器,這個(gè)類加載器繼承URLClassLoader坯门,并使用這些JarFileArchive集合的URL構(gòu)造成URLClassPath
    // LaunchedURLClassLoader類加載器的父類加載器是當(dāng)前執(zhí)行類JarLauncher的類加載器
    ClassLoader classLoader = createClassLoader(getClassPathArchives());
    // getMainClass方法會(huì)去項(xiàng)目自身的Archive中的Manifest中找出key為Start-Class的類
    // 調(diào)用重載方法launch
    launch(args, getMainClass(), classLoader);
  }
  catch (Exception ex) {
    ex.printStackTrace();
    System.exit(1);
  }
}

// Archive的getMainClass方法
// 這里會(huì)找出spring.study.executablejar.ExecutableJarApplication這個(gè)類
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 {
      // 創(chuàng)建一個(gè)MainMethodRunner微饥,并把a(bǔ)rgs和Start-Class傳遞給它
  Runnable runner = createMainMethodRunner(mainClass, args, classLoader);
      // 構(gòu)造新線程
  Thread runnerThread = new Thread(runner);
      // 線程設(shè)置類加載器以及名字,然后啟動(dòng)
  runnerThread.setContextClassLoader(classLoader);
  runnerThread.setName(Thread.currentThread().getName());
  runnerThread.start();
}
MainMethodRunner的run方法:

@Override
public void run() {
  try {
    // 根據(jù)Start-Class進(jìn)行實(shí)例化
    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");
    }
    // 調(diào)用
    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方法調(diào)用之后欠橘,內(nèi)部會(huì)構(gòu)造Spring容器,啟動(dòng)內(nèi)置Servlet容器等過程现恼。這些過程我們都已經(jīng)分析過了肃续。

關(guān)于自定義的類加載器LaunchedURLClassLoader
LaunchedURLClassLoader重寫了loadClass方法,也就是說它修改了默認(rèn)的類加載方式(先看該類是否已加載這部分不變叉袍,后面真正去加載類的規(guī)則改變了始锚,不再是直接從父類加載器中去加載)。LaunchedURLClassLoader定義了自己的類加載規(guī)則:

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);
}

加載規(guī)則:

如果根類加載器存在喳逛,調(diào)用它的加載方法瞧捌。這里是根類加載是ExtClassLoader
調(diào)用LaunchedURLClassLoader自身的findClass方法,也就是URLClassLoader的findClass方法
調(diào)用父類的loadClass方法,也就是執(zhí)行默認(rèn)的類加載順序(從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");
                    // 基于之前得到的第三方j(luò)ar包依賴以及自己的jar包得到URL數(shù)組姐呐,進(jìn)行遍歷找出對(duì)應(yīng)類名的資源
                    // 比如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!/中被找出
                    // 那么找出的資源對(duì)應(yīng)的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的一個(gè)測(cè)試:

// 注冊(cè)org.springframework.boot.loader.jar.Handler URL協(xié)議處理器
JarFile.registerUrlProtocolHandler();
// 構(gòu)造LaunchedURLClassLoader類加載器,這里使用了2個(gè)URL曙砂,分別對(duì)應(yīng)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個(gè)類都會(huì)在第二步本地查找中被找出(URLClassLoader的findClass方法)
classLoader.loadClass("org.springframework.boot.loader.JarLauncher");
classLoader.loadClass("org.springframework.boot.SpringApplication");
// 在第三步使用默認(rèn)的加載順序在ApplicationClassLoader中被找出
classLoader.loadClass("org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration");

Spring Boot Loader的作用
SpringBoot在可執(zhí)行jar包中定義了自己的一套規(guī)則麦轰,比如第三方依賴jar包在/lib目錄下乔夯,jar包的URL路徑使用自定義的規(guī)則并且這個(gè)規(guī)則需要使用org.springframework.boot.loader.jar.Handler處理器處理。它的Main-Class使用JarLauncher款侵,如果是war包末荐,使用WarLauncher執(zhí)行。這些Launcher內(nèi)部都會(huì)另起一個(gè)線程啟動(dòng)自定義的SpringApplication類新锈。

這些特性通過spring-boot-maven-plugin插件打包完成甲脏。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市妹笆,隨后出現(xiàn)的幾起案子块请,更是在濱河造成了極大的恐慌,老刑警劉巖拳缠,帶你破解...
    沈念sama閱讀 210,835評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件墩新,死亡現(xiàn)場離奇詭異,居然都是意外死亡窟坐,警方通過查閱死者的電腦和手機(jī)海渊,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,900評(píng)論 2 383
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來哲鸳,“玉大人臣疑,你說我怎么就攤上這事♂悴ぃ” “怎么了讯沈?”我有些...
    開封第一講書人閱讀 156,481評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長婿奔。 經(jīng)常有香客問我缺狠,道長,這世上最難降的妖魔是什么脸秽? 我笑而不...
    開封第一講書人閱讀 56,303評(píng)論 1 282
  • 正文 為了忘掉前任儒老,我火速辦了婚禮,結(jié)果婚禮上记餐,老公的妹妹穿的比我還像新娘驮樊。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,375評(píng)論 5 384
  • 文/花漫 我一把揭開白布囚衔。 她就那樣靜靜地躺著挖腰,像睡著了一般。 火紅的嫁衣襯著肌膚如雪练湿。 梳的紋絲不亂的頭發(fā)上猴仑,一...
    開封第一講書人閱讀 49,729評(píng)論 1 289
  • 那天,我揣著相機(jī)與錄音肥哎,去河邊找鬼辽俗。 笑死,一個(gè)胖子當(dāng)著我的面吹牛篡诽,可吹牛的內(nèi)容都是我干的崖飘。 我是一名探鬼主播,決...
    沈念sama閱讀 38,877評(píng)論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼杈女,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼朱浴!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起达椰,我...
    開封第一講書人閱讀 37,633評(píng)論 0 266
  • 序言:老撾萬榮一對(duì)情侶失蹤翰蠢,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后啰劲,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體梁沧,經(jīng)...
    沈念sama閱讀 44,088評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,443評(píng)論 2 326
  • 正文 我和宋清朗相戀三年呈枉,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了趁尼。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片埃碱。...
    茶點(diǎn)故事閱讀 38,563評(píng)論 1 339
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡猖辫,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出砚殿,到底是詐尸還是另有隱情啃憎,我是刑警寧澤,帶...
    沈念sama閱讀 34,251評(píng)論 4 328
  • 正文 年R本政府宣布似炎,位于F島的核電站辛萍,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏羡藐。R本人自食惡果不足惜贩毕,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,827評(píng)論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望仆嗦。 院中可真熱鬧辉阶,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,712評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至规辱,卻和暖如春谆棺,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背罕袋。 一陣腳步聲響...
    開封第一講書人閱讀 31,943評(píng)論 1 264
  • 我被黑心中介騙來泰國打工改淑, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人浴讯。 一個(gè)月前我還...
    沈念sama閱讀 46,240評(píng)論 2 360
  • 正文 我出身青樓溅固,卻偏偏與公主長得像,于是被迫代替她去往敵國和親兰珍。 傳聞我的和親對(duì)象是個(gè)殘疾皇子侍郭,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,435評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容