SpringBoot加載外部依賴過程解析

這篇文章主要介紹了SpringBoot加載外部依賴過程解析,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

背景

公司一個項目的大數據平臺進行改造，之前使用Structured Streaming作為實時計算框架，需要替換為替換為Kafka Streams，并使用SpringBoot包裝，使其可以納入微服務體系。

然而由于之前并沒有接觸過SpringFramework相關技術，并且項目工期較為緊張，因此只好花了2天時間看了看Spring和SpringBoot，并且在改造過程中沿用大部分原有代碼，最后套上SpringBoot的殼子（就是基本不使用Spring Data相關的封裝和DI、AOP這些特性，只是在啟動類上添加@SpringBootApplication注解，并在main()方法里面使用SpringApplication.run()方式啟動）。

問題

然后在部署過程中就遇到了一個比較蛋疼的問題：因為遺留代碼的關系，部分配置項的名稱是自定義的，并使用java.util.ResourceBundle的getString()來讀取，而為了讓項目可以注冊到Eureka以及使用SpringBoot默認的日志配置，在配置文件中配置了eureka.client.serviceUrl.defaultZone以及logging.file等SpringBoot內置的配置項，并使用SpringBoot內置的配置讀取方式讀取。

也就是在一個應用程序中，混合使用了兩種讀取配置文件的方式。在使用maven將應用程序“EatMalonPeople”打包后，根據微服務組大佬的友情提示，使用如下命令運行程序：

java -jar EatMalonPeople.jar


然鵝運行倒是沒問題，不過application.properties文件在jar包里面，修改配置文件需要用vim直接修改jar包。感覺這種方式略挫，不太能接受。按照以往的經驗，使用java -cp命令可以指定classpath，應用程序會優先讀取classpath指定的外部配置文件。但是當我在config目錄下拷貝了一份application.properties文件，并修改了其中使用ResourceBundle.getString()方式讀取的配置項時，再使用：

java -cp .:./config/application.properties EatMalonPeople.jar

啟動后，發現生效的配置項仍然是EatMalonPeople.jar這個jar包內的配置項......
感覺不太科學啊。于是去查了查SpringBoot項目加載配置文件的順序，結果根據Spring官網的提示，SpringBoot加載配置文件application.properties的順序依次為：

• 當前目錄的cofnig目錄
• 當前目錄
• classpath目錄下的/config目錄
• classpath目錄

但是根據這種順序，明明應該加載config目錄下的配置文件嘛。于是在pom文件中exclude掉了配置文件：

<resources>
  <resource>
    <directory>src/main/resources</directory>
      <excludes>
        <exclude>${resource.exclude}</exclude>
      </excludes>
  </resource>
</resources>

這樣jar包內就不含有配置文件了。再次使用

java -cp .:./config/application.properties EatMalonPeople.jar

啟動后，應用程序能注冊到Eureka，然而使用ResourceBundle.getString()方法獲取的配置項竟然找不到了，直接throw出了內部封裝的找不到配置項錯誤！

天啦嚕，這是要鬧哪樣嘛。原來SpringBoot讀取配置文件的順序只能保證內部方式可以讀到，也就是說對于SpringBoot的jar包，-cp命令是沒有用的撒。沒想到我這個剛學過兩天Spring的萌新竟然碰到了這種問題，真是不給活路啊。

解決

又是一頓好找，終于在官網的另一處發現了原因。

原來SpringBoot是通過org.springframework.boot.loader.Launcher類來啟動的，這貨才是jar包中META-INF/MANIFEST.MF文件中Main-Class這個屬性的值，Launcher最后會調用我們自定義啟動類中的的main()方法（而我們自定義的啟動類是META-INF/MANIFEST.MF文件中的Start-Class屬性的值，這個屬性應該是SpringBoot特有的）。

這個類有三個子類，分別是JarLauncher,WarLauncher,PropertiesLauncher,前兩個Launcher都是不能添加外部依賴的。只有PropertiesLauncher是可以的。于是在spring-boot-maven-plugin中添加layout屬性，添加后的spring-boot-maven-plugin的配置是醬嬸兒的：

<plugin>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-maven-plugin</artifactId>
  <configuration>
    <layout>ZIP</layout>
  </configuration>
</plugin>

然后用maven重新打包，并且在運行時使用loader.path參數指定外部classpath地址：

java -Dloader.path=./config -jar EatMalonPeople.jar

這樣SpringBoot應用程序就可以使用兩種方式愉快的讀取外部配置文件啦（其實還有外部jar，也是可以的）！

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。