SpringBoot加载外部依赖

背景

公司一个项目的大数据平台进行改造,之前使用Structured Streaming作为实时计算框架,需要替换为替换为Kafka Streams,并使用SpringBoot包装,使其可以纳入微服务体系。然而由于之前并没有接触过SpringFramework相关技术,并且项目工期较为紧张,因此只好花了2天时间看了看Spring和SpringBoot,并且在改造过程中沿用大部分原有代码,最后套上SpringBoot的壳子(就是基本不使用Spring Data相关的封装和DI、AOP这些特性,只是在启动类上添加@SpringBootApplication注解,并在main()方法里面使用SpringApplication.run()方式启动)。

问题

然后在部署过程中就遇到了一个比较蛋疼的问题:因为遗留代码的关系,部分配置项的名称是自定义的,并使用java.util.ResourceBundlegetString()来读取,而为了让项目可以注册到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的顺序依次为:

  1. 当前目录的cofnig目录
  2. 当前目录
  3. classpath目录下的/config目录
  4. 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,也是可以的)!至于具体原理,感兴趣的同学可以看看参考中的链接。

总结

花了我一天时间。SpringBoot水平还是太菜,需要以后再学习一个。另外很感谢参考中的三篇博客(2是官方文档)。

参考

  1. How to add extra dir to CLASSPATH at spring-boot
  2. Lanching executable jars
  3. Spring Boot应用启动原理分析
  4. 将Springboot的“fat jar” 变成 “thin jar”
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353

推荐阅读更多精彩内容