Springboot项目使用外部配置文件(排除打包内部yml文件,使用jar包外配置yml文件)
在项目中不同的环境可能会有不同的配置文件,比如项目中 redis 地址在本地的环境和在线上生产环境的地址密码是可能会不同,那么每次打包构建项目的时候去更改配置文件,十分可能会忘记或者改错。
为了解决上述情况,在打包的时候排除配置文件,然后在线上环境 jar 包同级放上配置 yml 文件,这样每次只需要上次 jar 包即可。
一、排除配置文件
在项目父 pom.xml 文件中:
<build>
<!-- 如果你想在构建过程中排除某些文件,你应该在Maven的<resources>部分中配置,而不是在Spring Boot Maven插件中。-->
<resources>
<resource>
<!-- 排除的文件的路径 -->
<directory>src/main/resources</directory>
<excludes>
<!-- 排除的文件的名称 -->
<exclude>application.properties</exclude>
<exclude>application-dev.yml</exclude>
<exclude>application-prod.yml</exclude>
<exclude>logback.xml</exclude>
</excludes>
</resource>
</resources>
</build>
加上上面配置后,打包的 jar 包中,便不会有这些文件。
二、在线上环境 jar 包同级放入生产配置文件 application.yml
通过以上两步,便可以实现 jar 包运行时会默认读取外部配置文件,这样即使临时更改一些配置,直接更改外部配置文件然后重启项目即可。
注意:
-
一、网上一堆转载文章说通过以下配置排除文件:
这种造成误解,这样是不对的,因为 maven-plugin 中的 excludes 是只能排除不需要的 jar 包的,不能排除 文件的。 -
二、除了上述解决办法,我们还可以在启动脚本中配置指定使用外部配置文件。