Spring Boot 外置配置文件

默认情况下,我们 spring boot 项目的配置文件<small>(application.yaml、application.properties)</small>是在项目的 jar 包『里面』的。

如果是要改配置文件中的配置项时,就需要将项目重新打包,在某些情况下,这就显得十分不方便。

对此,我们可以将 spring boot 项目的配置文件『挪到』jar 包之外,然后再启动 spring boot 项目时再指定它使用外部的这些配置文件。

  • 为 pom.xml 添加插件及配置

    <plugin> <!-- copy资源文件 -->
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-resources-plugin</artifactId>
      <version>3.2.0</version>
      <executions>
        <execution>
          <id>copy-resources</id>
          <phase>package</phase>
          <goals>
            <goal>copy-resources</goal>
          </goals>
          <configuration>
            <resources>
              <resource>
                <directory>src/main/resources</directory>
                <includes>
                  <include>**/application*.yml</include>
                  <include>**/application*.properties</include>
                  <include>**/bootstrap.yml</include>
                  <include>**/logback*.xml</include>
                </includes>
                <excludes>
                  <exclude>**/i18n/**</exclude>
                  <exclude>**/mybatis/**</exclude>
                  <exclude>**/public/**</exclude>
                  <exclude>**/static/**</exclude>
                  <exclude>**/templates/**</exclude>
                </excludes>
              </resource>
            </resources>
            <outputDirectory>${project.build.directory}/resources</outputDirectory>
          </configuration>
        </execution>
      </executions>
    </plugin>
    <!-- 打jar包时忽略配置文件 -->
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-jar-plugin</artifactId>
      <configuration>
        <excludes>
          <exclude>**/application*.yml</exclude>
          <exclude>**/application*.properties</exclude>
          <exclude>**/logback*.xml</exclude>
          <exclude>**/bootstrap.yml</exclude>
        </excludes>
      </configuration>
    </plugin>
    

根据上述的 <outputDirectory> 的配置,相关的配置文件会被复制到 target 下的 resources 目录中,并且,jar 包中也不会包含你所配置的这些配置文件。

这种情况下,在启动 spring boot 项目时,需要额外的参数(-Dspring.config.location)告诉它项目的配置文件在哪:

java -jar -Dspring.config.location=E:/Workspace/projects/target/resources/ ./xxx.jar

注意:

  1. 如果外部文件指定的是目录,那么 -Dspring.config.location 配置的地址必须以 / 结尾,表明这个配置是一个目录,而非单个文件;

  2. 如果想要指定单个文件,可以使用 -Dspring.config.location=E:/Workspace/projects/target/resources/application.properties 这种方式来指明只需要加载这个配置文件内容。

  3. 当然,你可以可以将配置文件放在与启动的 jar 包同级目录,或者在启动的jar的同级目录下建一个名为 config 的目录,然后将配置文件放到里面,然后直接使用 java -jar ./xxx.jar 命令启动,spring 默认会去 ./config 目录中查询。

补充

spring boot 默认是以 classpath:/,classpath:/config/,file:./,file:./config/ 这样的配置在查找、加载配置文件,有意思的是查找顺序是上述配置的反向顺序:

  1. file:./config/
  2. file:./
  3. classpath:/config/
  4. classpath:/

因此,如果你在 spring.config.location 中也定义了多个配置文件位置,例如:classpath:/custom-config/,file:./custom-config/, 那么配置文件的查找、加载顺序同样是反向的:

  1. file:./custom-config
  2. classpath:/custom-config

另外,还有一个功能相似的配置 spring.config.additional-location,使用它的话,它会作为默认配置路径的『扩展配置』路径来使用。扩展的配置路径会比默认的配置优先被扫描到. 比如说, 如果设置了扩展的配置文件所在路径为:classpath:/custom-config/,file:./custom-config/ , 那么查找路径将会是下面的顺序:

  1. file:./custom-config/
  2. classpath:custom-config/
  3. file:./config/
  4. file:./
  5. classpath:/config/
  6. classpath:/

这种扫描顺序使得你可以通过自己的自定义配置来修改默认的配置项。

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

推荐阅读更多精彩内容