2021-02-03 SpringBoot 激活多环境读取全局配置文件与配置文件目录优先级

本文非原创,仅为 原文章 做了一点补充
本文中示例程序gitee地址:Radar,非常优秀的spring boot项目。

1.SpringBoot 激活多环境全局配置文件

在实际的的开发中,对于一个工程,经常配置很多个Profile(配置文件),每个Profile都对应一个完整的全局配置,例如开发环境(application-dev.properties)测试环境(application-test.properties)生产环境(application-prod.properties)等。在不同的环境下,配置有可能是不一样的。SpringBoot 提供可以很方便地切换不同场景下的配置文件,激活哪个,其对应的全局配置就生效。

(1)properties 格式全局配置文件的做法:

默认必须要有 \color{red}{application.properties } 文件,同时可以多写几个配置文件,名字取为 \color{red}{application-{profile}.properties},然后不做激活配置,默认就使用\color{red}{application.properties } ,在\color{red}{application.properties } 做激活配置,激活哪个,哪个生效。配置端口号,通过 \color{red}{spring.profiles.active=xxx} 来激活,运行程序主类,查看OK

image.png

(2) YAML格式全局配置文件的做法

  • YAML格式全局配置文件,在同一个application.yml全局配置文件进行多文档块方式配置
    \color{red}{注意:}有两个以上没定义文档快名称的,以最后一个文档快作为全局配置文件,所以文档块记得取名。
    image.png
  • 为了更方便维护各种环境的配置,可以将 yml文件拆分
    在src/main/resource目录下,再创建yml配置文件(不需要定义文档块和命名spring.profiles属性),文件命名规则为 application-{profiles}.yml,然后,在原来application.yml 做激活配置,激活哪个,哪个生效。
    image.png

    image.png

    \color{red}{注意:}👆红框这里可以直接写dev或者local,也可以引用pom.xml中配置的参数。👇
    image.png
  • 除了在上面默认全局配置文件里激活Profile以外,还可用 IDEA命令方式激活,命令方式激活时会忽略配置文件的激活配置
    1)在idea中配置命令行参数,任意选择一种即可,优先级高于配置文件激活
    -Dspring.profiles.active=xx
    --spring.profiles.active=xxx
    xxx
    image.png

    image.png

    2)将项目打成 jar 包后,在启动 jar包命令后添加激活配置文件的命令参数
    优先级高于配置文件激活和IDEA激活
    image.png

2.SpringBoot 配置文件目录优先级

1、当前项目中配置文件

SpringBoot配置文件可以放置在多种路径下,不同路径下的配置优先级有所不同。默认会扫描这几个放置目录的默认配置文件:

   当前项目的根目录/config/                   # 最高优先级

   当前项目的根目录/                              # 第二优先级

   类路径(在resources目录下)/config/     # 第三优先级

   类路径(在resources目录下)/                # 第四优先级

\color{red}{如果这四个位置都有配置文件,} \color{red}{那么四个配置文件都会生效,} \color{red}{只不过四个配置文件中的相同配置项,} \color{red}{生效的是高优先级的配置文件里的配置项 。} \color{red}{即:优先级由高到底,高优先级的配置会覆盖低优先级的相同配置项并互补配置。}

image.png

配置端口号,运行程序主类,查看OK, 优先级:8081 --> 8082 --> 8083 --> 8084 .

2、外部配置文件

在项目已打包运行后,若需要修改配置文件时,可以在jar包的外面,新建一个外部配置文件,
然后在运行jar包命令后添加激活外部配置文件的命令参数 (--spring.config.location=文件路径),
那么这个新的外部配置文件会覆盖jar包中配置文件里相同的配置项信息。即:外部配置文件优先级最高。
将上面项目打包,新建一个外部配置文件,端口号为 8079.


image.png

以上。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容