4、SpringBoot -配置文件

一、简介

官方配置文档
当创建完工程之后默认在工程的sources目录下会有一个application.properties的配置文件,在该配置文件中可以指定我们工程中的不变的属性,名字一般是固定的死的(不建议修改);springboot支持两个格式的配置:

  • application.properties
  • application.yml
    properties
server.port=9000
server.servlet.context-path=/api
server.address=127.0.0.1

yml

server:
  port: 8000
  servlet:
    context-path: /api
  address: 127.0.0.1

二、常用配置文件位置

说明

Spring boot 的配置文件可以在classpath下也可以是从指定的file路径下

加载顺序

  1. classpath:/config/
  2. classpath:/
    springboot首先会从classpath下的/config目录下查找配置文件
    然后在classpath的根目录查找,查找的顺序/config优于classpath
    当同级目录同时有application.propertiesapplication.yml,那么application.properties里面的属性就会覆盖application.yml里的属性。

三、自定义属性

Spring Boot提供自定义配置组件,但有些时候我们需要在配置文件自定义一些属性,那我们如何获取这些自定义的属性的值呢?

application.yml

user:
  name: 测试自定义属性
  address:
    - 上海
    - 北京
    - 深圳
    - 武汉
    - 长沙
    detail:
        phone: 130xxx

JavaBean

单个值获取
使用@Value注解,可以在程序的任意类中使用,当我们只需要配置属性的单个值的时候可以使用@Value

public  class TestConfiguration{
  @Value("user.name")
  private String name;
  @Value("user.detail.phone")
  private String phone;
}

一次性加载
当配置的值比较多的时候,我们可以使用@ConfigurationProperties注解一次性将配置文件中配置的每一个属性的值,映射到这个组件中

// 或者@Configuration
@Component
@ConfigurationProperties("user")
@Data
public class User {
    private Map<String,String> detail;
    private List<String> address;
    private String name;
}

@ConfigurationProperties

  • 该注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。
  • prefix = "user":声明配置前戳,将该前戳下的所有属性进行映射。
  • @Component 或者@Configuration:将该组件加入Spring Boot容器,只有这个组件是容器中的组件,配置才生效。

两种方式对比

说明 @ConfigurationProperties @Value
作用 批量注入配置文件中的属性 单个指定
松散绑定(松散语法) 支持 不支持
SpEL 不支持 支持
JSR303数据校验 支持 不支持
复杂类型封装 支持 不支持

自动提示功能

在pom.xml中导入

<!--导入配置文件处理器,配置文件进行绑定就会有提示-->
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-configuration-processor</artifactId>
  <optional>true</optional>
</dependency>

在idea中开启


image

四、多配置文件

说明

我们在主配置文件编写的时候,文件名也可以是 application-{profile}.properties/yml,默认使用application.properties的配置
例如我们的一个项目基本的会有三种环境,开发dev,测试test,生产 produce。每个环境下的配置文件的内容都会不同,所以需要在不同环境下使用不同的配置文件

配置文件

application-pro.yml

server:
  port: 8080

application-dev.yml

server:
  port: 8081

application-test.yml

server:
  port: 8082

激活配置文件

激活配置文件的方式有两种
一种在主配置文件application.yml中 使用spring.profiles.active 属性指定使用哪个配置文件

spring:
  profiles:
    active: dev

另外一种打包后可以通过命令行参数的方式指定配置文件

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