SpringBoot 入门篇(五) SpringBoot的配置文件

一、SpringBoot的yml配置文件

二、SpringBoot配置文件优先级

三、Profile-specific配置文件

SpringBoot版本:1.5.13.RELEASE
对应官方文档链接:https://docs.spring.io/spring-boot/docs/1.5.13.RELEASE/reference/htmlsingle/

上一篇:SpringBoot 入门篇(四) SpringBoot外部配置以及优先级


一、SpringBoot的yml配置文件

  SpringBoot的配置文件常用的有2种类型,.properties和.yml。默认情况下,SpringBoot会加载classpath或者classpath:/config下的application.properties或者application.yml文件。

  .properties文件是我们常用的配置文件,.yml则是YAML文件,YAML是一种易阅读、易和脚本语言交互的用来表达资料序列的编程语言,这里简单说下语法
  (1)使用空格 Space 缩进分层,同层元素左对齐,不同层元素使用不同的空格数目缩进(不能使用 Tab,各系统 Tab对应的空格数目可能不同,导致层次混乱);
  (2)#表示注释;
  (3)破折号后面跟一个空格表示列表;
  (4)key和value之间用冒号和空格分隔。

environments:
    dev:
        url: http://dev.bar.com
        name: Developer Setup
    prod:
        url: http://foo.bar.com
        name: My Cool App

#yaml 的list集合
my:
   servers:
       - dev.bar.com
       - foo.bar.com

  上述代码段是一个标准的yml文件内容,等价于如下properties配置

environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App

my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

  SpringBoot通过YamlPropertiesFactoryBean 来加载application.yml文件,并通过YamlMapFactoryBean 将其转换成Map。
  我们可以通过@Value或者@ConfigurationProperties注解来获取配置文件中的数据。例如有如下application.yml文件:

name:
    nameStr
age:
    11

#yaml 的list集合
my:
    servers:
       - dev.bar.com
       - foo.bar.com
@Configuration
public class MyConfiguration {
    // 通过@Value获取值
    @Value("${name}")
    private String name;

    @Value("${age}")
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}
@Configuration
//通过@ConfigurationProperties获取值
@ConfigurationProperties(prefix="my")
public class MyConfig {

    private List<String> servers = new ArrayList<String>();

    public List<String> getServers() {
        return this.servers;
    }

}
@SpringBootApplication
@RestController
public class Application {

    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(Application.class);
        application.run(args);
    }


    @Autowired
    private MyConfiguration myConfiguration;

    @RequestMapping("/getMyConfiguration")
    public String getMyConfiguration() {
        return myConfiguration.getName() + ":" + myConfiguration.getAge();
    }

    @Autowired
    private MyConfig myConfig;

    @RequestMapping("/getMyConfig")
    public List<String> getMyConfig() {
        return myConfig.getServers();
    }
}

  启动Application,在浏览器分别输入 http://localhost:8080/getMyConfigurationhttp://localhost:8080/getMyConfig 可以得到配置的值。
  当使用@ConfigurationProperties获取配置值,SpringBoot还提供了一种宽松的绑定方式(@Value不支持该特性):

@ConfigurationProperties(prefix="person")
public class OwnerProperties {

    private String firstName;

    public String getFirstName() {
        return this.firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

}

则在配置文件中使用如下任意一种方式都能获取对应的配置值

person.firstName
person.first-name
person.first_name
PERSON_FIRST_NAME

二、SpringBoot配置文件优先级

  默认情况下,SpringBoot会加载如下位置的配置文件,这些文件可以同时存在,当这些文件中的多个存在相同的key时,value的优先级从高到低分别为:
  (1)当前应用目录下/config子文件夹下的application.properties或者application.yml文件;
  (2)当前应用目录下的application.properties或者application.yml文件;
  (3)类路径下/config子文件夹下的application.properties或者application.yml文件;
  (4)类路径下的application.properties或者application.yml文件。
  如果想指定加载的配置文件,则可以通过在启动时添加命令行参数--spring.config.name或者--spring.config.location进行指定文件。

$ java -jar app.jar --spring.config.name=myproject
或者
$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties

  需要注意的是,使用命令行参数指定的文件的优先级是最高的,例如如果通过命令行指定了应用目录下./custom-config/和classpath:/custom-config/,则value的优先级从高到低分别为:
  (3)当前应用目录下./custom-config路径下的application.properties或者application.yml文件;
  (4)类路径下子文件夹/custom-config/下的application.properties或者application.yml文件;
  (3)当前应用目录下/config子文件夹下的application.properties或者application.yml文件;
  (4)当前应用目录下的application.properties或者application.yml文件;
  (5)类路径下/config子文件夹下的application.properties或者application.yml文件;
  (6)类路径下的application.properties或者application.yml文件。


三、Profile-specific配置文件

  SpringBoot除了会加载application.properties/yml外,还会加载application-{profile}.properties/yml,其中{profile}默认为default,也就是说,如果同时存在application.properties/yml和application-default.properties/yml,SpringBoot会同时加载它们,且application-default.properties/yml的优先级更高。
  我们也可以自定义{profile},需要注意,除了application-default.properties/yml外,application-{profile}.properties/yml文件在加载后会处于未激活状态,即其中的值无法使用,如果想使用,则需要在application.properties/yml中指定spring.profiles.active。
  例如,在工程中有如下3个文件,application-dev.yml表示开发使用的配置,application-test.yml表示测试使用的配置,application-pro.yml表示生产环境使用的配置,则我们通过在application.yml中指定spring.profiles.active的值为{profile}对应的值(即dev\test\pro),就可以灵活的修改对应配置,方便开发、测试和运维的同学使用不同的配置。

spring:
    profiles:
        active:
            pro

  另外一种激活application-{profile}.properties/yml文件的方式是使用SpringApplication.setAdditionalProfiles()方法:

 public static void main(String[] args) {
        SpringApplication application = new SpringApplication(Application.class);
        application.setAdditionalProfiles("dev");
        application.run(args);
    }

上一篇:SpringBoot 入门篇(四) SpringBoot外部配置以及优先级

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

推荐阅读更多精彩内容