跳到主要內容

springboot的jar為何能獨立運行

歡迎訪問我的GitHub


https://github.com/zq2599/blog_demos
內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；


能獨立運行的jar文件


在開發springboot應用時，通過java -jar命令啟動應用是常用的方式，今天就來一起了解這個簡單操作背後的技術；


開發demo


開發一個springboot應用作為本次研究的對象，對應的版本信息如下：



  • JDK：1.8.0_211

  • springboot：2.3.1.RELEASE

  • maven：3.6.0


接下來開發springboot應用，這個應用異常簡單：



  1. springboot應用名為springbootstarterdemo，pom.xml文件內容：


<?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <parent>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-parent</artifactId>
         <version>2.3.1.RELEASE</version>
         <relativePath/> <!-- lookup parent from repository -->
     </parent>
     <groupId>com.bolingcavalry</groupId>
     <artifactId>springbootstarterdemo</artifactId>
     <version>0.0.1-SNAPSHOT</version>
     <name>springbootstarterdemo</name>
     <description>Demo project for Spring Boot</description>
     <properties>
         <java.version>1.8</java.version>
     </properties>
     <dependencies>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
     </dependencies>
     <build>
         <plugins>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
             </plugin>
         </plugins>
     </build>
 </project>


  1. 只有一個java類，裏面有個http接口：


package com.bolingcavalry.springbootstarterdemo;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 import java.util.Date;
 
 @SpringBootApplication
 @RestController
 public class SpringbootstarterdemoApplication {
 
     public static void main(String[] args) {
         SpringApplication.run(SpringbootstarterdemoApplication.class, args);
     }
     @RequestMapping(value = "/hello")
     public String hello(){
         return "hello " + new Date();
     }
 }


  1. 編碼完成，在pom.xml所在目錄執行命令


mvn clean package -U -DskipTests


  1. 構建成功后，在target目錄下得到文件springbootstarterdemo-0.0.1-SNAPSHOT.jar

  2. 就是這個springbootstarterdemo-0.0.1-SNAPSHOT.jar，此時執行java -jar springbootstarterdemo-0.0.1-SNAPSHOT.jar就能啟動應用，如下圖：


接下來就用這個springbootstarterdemo-0.0.1-SNAPSHOT.jar來分析jar文件能夠獨立啟動的原因；


java -jar做了什麼



  • 先要弄清楚java -jar命令做了什麼，在oracle官網找到了該命令的描述：

    If the -jar option is specified, its argument is the name of the JAR file containing class and resource files for the application. The startup class must be indicated by the Main-Class manifest header in its source code.


  • 再次秀出我蹩腳的英文翻譯：




  1. 使用-jar參數時，後面的參數是的jar文件名(本例中是springbootstarterdemo-0.0.1-SNAPSHOT.jar)；

  2. 該jar文件中包含的是class和資源文件；

  3. 在manifest文件中有Main-Class的定義；

  4. Main-Class的源碼中指定了整個應用的啟動類；(in its source code)



  • 小結一下：
    java -jar會去找jar中的manifest文件，在那裡面找到真正的啟動類；


探查springbootstarterdemo-0.0.1-SNAPSHOT.jar



  1. springbootstarterdemo-0.0.1-SNAPSHOT.jar是前面的springboot工程的構建結果，是個壓縮包，用常見的壓縮工具就能解壓，我這裏的環境是MacBook Pro，用unzip即可解壓；


  2. 解壓後有很多內容，我們先關注manifest相關的，下圖紅框中就是manifest文件：


  3. 打開上圖紅框中的文件，內容如下：



Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx
 Implementation-Title: springbootstarterdemo
 Implementation-Version: 0.0.1-SNAPSHOT
 Start-Class: com.bolingcavalry.springbootstarterdemo.Springbootstarter
  demoApplication
 Spring-Boot-Classes: BOOT-INF/classes/
 Spring-Boot-Lib: BOOT-INF/lib/
 Build-Jdk-Spec: 1.8
 Spring-Boot-Version: 2.3.1.RELEASE
 Created-By: Maven Jar Plugin 3.2.0
 Implementation-Vendor: Pivotal Software, Inc.
 Main-Class: org.springframework.boot.loader.JarLauncher


  1. 在上述內容可見Main-Class的值org.springframework.boot.loader.JarLauncher，這個和前面的java官方文檔對應上了，正是這個JarLauncher類的代碼中指定了真正的啟動類；


疑惑出現



  1. 在MANIFEST.MF文件中有這麼一行內容：


Start-Class: com.bolingcavalry.springbootstarterdemo.Springbootstarter
  demoApplication


  1. 前面的java官方文檔中，只提到過Main-Class ，並沒有提到Start-Class；

  2. Start-Class的值是SpringbootstarterdemoApplication，這是我們的java代碼中的唯一類，也只真正的應用啟動類；

  3. 所以問題就來了：理論上看，執行java -jar命令時JarLauncher類會被執行，但實際上是SpringbootstarterdemoApplication被執行了，這其中發生了什麼呢？


猜測


動手之前先猜一下，個人覺得原因應該如下：



  1. java -jar命令會啟動JarLauncher；

  2. Start-Class是給JarLauncher用的；

  3. JarLauncher根據Start-Class找到了SpringbootstarterdemoApplication，然後執行它；


分析JarLauncher



  1. 先下載SpringBoot源碼，我下載的是2.3.1版本，地址：https://github.com/spring-projects/spring-boot/releases/tag/v2.3.1.RELEASE


  2. JarLauncher所在的工程是spring-boot-loader，先弄明白JarLauncher的繼承關係，如下圖，可見JarLauncher繼承自ExecutableArchiveLauncher，而ExecutableArchiveLauncher的父類Launcher位於最頂層，是個抽象類：


  3. java -jar執行的是JarLauncher的main方法，如下，會實例化一個JarLauncher對象，然後執行其launch方法，並且將所有入參都帶入：



public static void main(String[] args) throws Exception {
 	new JarLauncher().launch(args);
 }


  1. 上面的launch方法在父類Launcher中：


protected void launch(String[] args) throws Exception {
     // 將jar解壓后運行的方式叫做exploded mode
     // 如果是exploded mode，就不能支持通過URL加載jar
     // 如果不是exploded mode,就可以通過URL加載jar
 	if (!isExploded()) {
 	    // 如果允許通過URL加載jar，就在此註冊對應的處理類
 		JarFile.registerUrlProtocolHandler();
 	}
 	// 創建classLoader
 	ClassLoader classLoader = createClassLoader(getClassPathArchivesIterator());
 	// jarmode是創建docker鏡像時用到的參數，使用該參數是為了生成帶有多個layer信息的鏡像
 	// 這裏暫時不關注jarmode
 	String jarMode = System.getProperty("jarmode");
 	//如果沒有jarmode參數，launchClass的值就來自getMainClass()返回
 	String launchClass = (jarMode != null && !jarMode.isEmpty()) ? JAR_MODE_LAUNCHER : getMainClass();
 	launch(args, launchClass, classLoader);
 }


  1. 可見要重點關注的是getMainClass()方法，在看這個方法之前，我們先去關注一個重要的成員變量archive，是JarLauncher的父類ExecutableArchiveLauncher的archive，如下可見，該變量又來自方法createArchive：


public ExecutableArchiveLauncher() {
 		try {
 			this.archive = createArchive();
 			this.classPathIndex = getClassPathIndex(this.archive);
 		}
 		catch (Exception ex) {
 			throw new IllegalStateException(ex);
 		}
 	}


  1. 方法來自Launcher.createArchive，如下所示，可見成員變量archive實際上是個JarFileArchive對象：


protected final Archive createArchive() throws Exception {
 		ProtectionDomain protectionDomain = getClass().getProtectionDomain();
 		CodeSource codeSource = protectionDomain.getCodeSource();
 		URI location = (codeSource != null) ? codeSource.getLocation().toURI() : null;
 		String path = (location != null) ? location.getSchemeSpecificPart() : null;
 		if (path == null) {
 			throw new IllegalStateException("Unable to determine code source archive");
 		}
 		File root = new File(path);
 		if (!root.exists()) {
 			throw new IllegalStateException("Unable to determine code source archive from " + root);
 		}
 		return (root.isDirectory() ? new ExplodedArchive(root) : new JarFileArchive(root));
 	}


  1. 現在回到getMainClass()方法，可見his.archive.getManifest方法返回的是META-INF/MANIFEST.MF文件的內容，然後getValue(START_CLASS_ATTRIBUTE)方法實際上就是從META-INF/MANIFEST.MF中取得了Start-Class的屬性：


@Override
 	protected String getMainClass() throws Exception {
 	    // 對應的是JarFileArchive.getManifest方法，
 	    // 進去后發現對應的就是JarFile.getManifest方法，
 	    // JarFile.getManifest對應的就是META-INF/MANIFEST.MF文件的內容
 		Manifest manifest = this.archive.getManifest();
 		String mainClass = null;
 		if (manifest != null) {
 		    // 對應的是META-INF/MANIFEST.MF文件中的Start-Class的屬性
 			mainClass = manifest.getMainAttributes().getValue(START_CLASS_ATTRIBUTE);
 		}
 		if (mainClass == null) {
 			throw new IllegalStateException("No 'Start-Class' manifest entry specified in " + this);
 		}
 		return mainClass;
 	}


  1. 從上述分析可知：getMainClass()方法返回的是META-INF/MANIFEST.MF中取得了Start-Class的屬性com.bolingcavalry.springbootstarterdemo.SpringbootstarterdemoApplication，再次回到launch方法中，可見最終運行的代碼是launch(args, launchClass, classLoader)，它的launchClass參數就是com.bolingcavalry.springbootstarterdemo.SpringbootstarterdemoApplication：


protected void launch(String[] args) throws Exception {
 		if (!isExploded()) {
 			JarFile.registerUrlProtocolHandler();
 		}
 		ClassLoader classLoader = createClassLoader(getClassPathArchivesIterator());
 		String jarMode = System.getProperty("jarmode");
 		// 這裏的launchClass等於"com.bolingcavalry.springbootstarterdemo.SpringbootstarterdemoApplication"
 		String launchClass = (jarMode != null && !jarMode.isEmpty()) ? JAR_MODE_LAUNCHER : getMainClass();
 		// 這裏就是啟動SpringbootstarterdemoApplication的地方
 		launch(args, launchClass, classLoader);
 	}


  1. 展開launch(args, launchClass, classLoader)，最終查到了MainMethodRunner類：


public class MainMethodRunner {
 
 	private final String mainClassName;
 
 	private final String[] args;
 
 	/**
 	 * Create a new {@link MainMethodRunner} instance.
 	 * @param mainClass the main class
 	 * @param args incoming arguments
 	 */
 	public MainMethodRunner(String mainClass, String[] args) {
 	    // mainClassName被賦值為"com.bolingcavalry.springbootstarterdemo.SpringbootstarterdemoApplication"
 		this.mainClassName = mainClass;
 		this.args = (args != null) ? args.clone() : null;
 	}
 
 	public void run() throws Exception {
 	    // 得到SpringbootstarterdemoApplication的Class對象
 		Class<?> mainClass = Class.forName(this.mainClassName, false, Thread.currentThread().getContextClassLoader());
 		// 得到SpringbootstarterdemoApplication的main方法對象
 		Method mainMethod = mainClass.getDeclaredMethod("main", String[].class);
 		mainMethod.setAccessible(true);
 		// 通過反射執行main方法
 		mainMethod.invoke(null, new Object[] { this.args });
 	}
 }

終於，真相大白了；


小結


最後盡可能簡短做個小結，先看jar是如何產生的，如下圖，maven插件生成的jar文件中，有常見的class、jar，也有符合java規範的MANIFEST.MF文件，並且，還在MANIFEST.MF文件中額外生成了名為Start-Class的配置，這裏面是我們編寫的應用啟動類SpringbootstarterdemoApplication：


啟動類是JarLauncher，它是如何與MANIFEST.MF文件關聯的呢？從下圖可以看出，最終是通過JarFile類的成員變量manifestSupplier關聯上的：


再來看看關鍵代碼的執行情況，如下圖：


至此，SpringBoot的jar獨立運行的基本原理已經清楚，探究的過程中，除了熟悉關鍵代碼流程，還對jar中的文件有了更多了解，如果您正在學習SpringBoot，希望本文能給您一些參考；


官方文檔



  1. 最後附上SpringBoot官方文檔，可以看到Start-Class描述信息：


  2. 上述文檔明確提到：Start-Class定義的是實際的啟動類，此時的您應該對一切都瞭然於胸，產生本該如此的感慨；


本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】



※新北清潔公司,居家、辦公、裝潢細清專業服務



※別再煩惱如何寫文案,掌握八大原則!



※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!



※超省錢租車方案


Orignal From: springboot的jar為何能獨立運行

留言

張貼留言

這個網誌中的熱門文章

架構設計 | 異步處理流程，多種實現模式詳解

本文源碼：GitHub·點這裏 || GitEE·點這裏 一、異步處理 1、異步概念 異步處理不用阻塞當前線程來等待處理完成，而是允許後續操作，直至其它線程將處理完成，並回調通知此線程。 必須強調一個基礎邏輯，異步是一種設計理念，異步操作不等於多線程，MQ中間件，或者消息廣播，這些是可以實現異步處理的方式。 同步處理和異步處理相對，需要實時處理並響應，一旦超過時間會結束會話，在該過程中調用方一直在等待響應方處理完成並返回。同步類似電話溝通，需要實時對話，異步則類似短信交流，發送消息之後無需保持等待狀態。 2、異步處理優點 雖然異步處理不能實時響應，但是處理複雜業務場景，多數情況都會使用異步處理。 異步可以解耦業務間的流程關聯，降低耦合度； 降低接口響應時間，例如用戶註冊，異步生成相關信息表； 異步可以提高系統性能，提升吞吐量； 流量削峰即把請求先承接下來，然後在異步處理； 異步用在不同服務間，可以隔離服務，避免雪崩； 異步處理的實現方式有很多種，常見多線程，消息中間件，發布訂閱的廣播模式，其根據邏輯在於先把請求承接下來，放入容器中，在從容器中把請求取出，統一調度處理。 注意 ：一定要監控任務是否產生積壓過度情況，任務如果積壓到雪崩之勢的地步，你會感覺每一片雪花都想勇闖天涯。 3、異步處理模式 異步流程處理的實現有好多方式，但是實際開發中常用的就那麼幾種，例如： 基於接口異步響應，常用在第三方對接流程； 基於消息生產和消費模式，解耦複雜流程； 基於發布和訂閱的廣播模式，常見系統通知 異步適用的業務場景，對數據強一致性的要求不高，異步處理的數據更多時候追求的是最終一致性。 二、接口響應異步 1、流程描述 基於接口異步響應的方式，有一個本地業務服務，第三方接口服務，流程如下： 本地服務發起請求，調用第三方服務接口； 請求包含業務參數，和成功或失敗的回調地址； 第三方服務實時響應流水號，作為該調用的標識； 之後第三方服務處理請求，得到最終處理結果； 如果處理成功，回調本地服務的成功通知接口； 如果處理失敗，回調本地服務的失敗通知接口； 整個流程基於部分異步和部分實時的模式，完整處理； 注意 ：如...
張貼留言
閱讀完整內容

.NET Core前後端分離快速開發框架(Core.3.0+AntdVue)

.NET Core前後端分離快速開發框架(Core.3.0+AntdVue) 目錄 引言 時間真快，轉眼今年又要過去了。回想今年，依次開源發布了 Colder.Fx.Net.AdminLTE(254Star) 、 Colder.Fx.Core.AdminLTE(335Star) 、 DotNettySocket(82Star) 、 IdHelper(47Star) ，這些框架及組件都是本着以實際出發，實事求是的態度，力求提高開發效率（我自己都是第一個使用者），目前來看反響不錯。但是隨着前端和後端技術的不斷變革，尤其是前端，目前大環境已經是前後端完全分離為主的開發模式，在這樣的大環境和必然趨勢之下，傳統的MVC就顯得有些落伍了。在這樣的背景下，一款前後端分離的.NET開發框架就顯得尤為必要，由此便定了框架的升級目標： 前後端分離 。 首先後端技術的選擇，從目前的數據來看，.NET Core的發展遠遠快於.NET Framework，最簡單的分析就是Colder.Fx.Core.AdminLTE發布比Colder.Fx.Net.AdminLTE晚，但是星星卻後來居上而且比前者多30%，並且這個差距在不斷擴大，由點及面的分析可以看出我們廣大.NET開發人員學習的熱情和积極向上的態度，並不是某些人所認為的那麼不堪（ 走自己的路，讓別人說去吧 ）。大環境上微軟积極擁抱開源，大力發展.NET Core， 可以說前途一片光明。因此後端決定採用 .NET Core3.0 ，不再浪費精力去支持.NET Framework。 然後是前端技術選擇，首選是三大js框架選擇，也是從實際出發，Vue相對其它而言更加容易上手，並且功能也毫不遜色，深得各種大小公司喜歡，如果偏要說缺點的話，那就是對TS支持不行，但是即將發布Vue3.0肯定會改變這一缺陷。選擇了Vue之後，然後就是UI框架的選擇了，這裏的選擇更多了，我選擇了Ant Design Vue，理由便是簡潔方便，十分符合我的設計理念。 技術選型完畢之後便...
張貼留言
閱讀完整內容

台北市住宅、社區建創儲能設備 最高可獲600萬元補助

為了推廣分散式發電，台北市環保局預計補助1億元供住宅社區設置創能、儲能設備，計有3種方案可供選擇。環保局說明，每案補助額度不超過建制總經費49％，社區每案最高可獲200萬至600萬元補助，住宅每案補助上限100萬元，5月1日起開放申請。 環保局說明，台北市溫室氣體排放量7成以上來自住商部門，其中以使用電力造成間接溫室氣體排放為大宗，台北市平均年用電量約159.86億度，1度電約等同排放0.5公斤二氧化碳，若想達成2050年淨零排放目標，僅靠節能減碳無法達成，必須發展綠色創能、儲能，並且參考歐洲、日本的做法，採分散式發電方式，推廣到社區、住家、商辦，達到供電自給自足目標。 因此，環保局推出「台北市住宅社區創能儲能及節能補助計畫」，補助對象為台北市轄內房屋所有權人及社區管理委員會，補助方案共計3種，每一申請人或每一場址僅能獲1次補助，每案補助額度不超過建置總經費49％為限，5月1日到7月31日開放申請，但補助經費用完即停止申請。 環保局說明，方案A補助對象以社區為主，公共區域申請創能儲能及節能項目，每案補助上限新台幣600萬元；方案B分為住宅或社區公共區域申請創能搭配儲能項目（創能或儲能方案不得單獨申請），社區每案補助上限新台幣400萬元，住宅每案補助上限100萬元。方案C補助對象也是社區，公共區域申請節能項目，每案補助上限新台幣200萬元。 網頁設計 最專業,超強功能平台可客製,窩窩以「數位行銷」「品牌經營」「網站與應用程式」「印刷品設計」等四大主軸，為每一位客戶客製建立行銷脈絡及洞燭市場先機,請問 台中電動車 哪裡在賣比較便宜可以到台中景泰電動車門市去看看總店：臺中市潭子區潭秀里雅潭路一段102-1號。 電動車補助 推薦評價好的 iphone維修 中心擁有專業的維修技術團隊，同時聘請資深iphone手機維修專家，現場說明手機問題，快速修理，沒修好不收錢住家的頂樓裝 太陽光電 聽說可發揮隔熱功效一線推薦東陽能源擁有核心技術、產品研發、系統規劃設置、專業團隊的太陽能發電廠商。 網頁設計 一頭霧水該從何著手呢? 回頭車 貨運收費標準宇安交通關係企業，自成立迄今，即秉持著「以誠待人」、「以實處事」的企業信念 台中搬家公司 教你幾個打包小技巧,輕鬆整理裝箱!還在煩惱搬家費用要多少哪？台中大展搬家線上試算搬家費用，從此不再擔心「物品怎麼計費」、「多...
張貼留言
閱讀完整內容