SpringBoot基础01-yaml配置文件

1、配置文件

1)SpringBoot使用一个全局的配置文件,配置文件名是固定的;

  • application.properties
  • application.yml

2)配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;

3)YAML(YAML Ain't Markup Language)

  • YAML A Markup Language:是一个标记语言
  • YAML isn't Markup Language:不是一个标记语言;

4)标记语言:
​ - 以前的配置文件;大多都使用的是 xxxx.xml文件;
​ - YAML:以数据为中心,比json、xml等更适合做配置文件;
5)YAML:配置例子

server:
  port: 8081

​ XML:

<server>
	<port>8081</port>
</server>

2、YAML语法:

1、基本语法

k:(空格)v:表示一对键值对(空格必须有);

空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

server:
    port: 8081
    path: /hello

属性和值也是大小写敏感;

2、值的写法

1)字面量:普通的值(数字,字符串,布尔)

k: v:字面直接来写;
    字符串默认不用加上单引号或者双引号;
            "":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
                    name:   "zhangsan \n lisi":输出;zhangsan 换行  lisi
            '':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
                    name:   ‘zhangsan \n lisi’:输出;zhangsan \n  lisi

2)对象、Map(属性和值)(键值对):

k: v:在下一行来写对象的属性和值的关系;注意缩进
        对象还是k: v的方式
friends:
    lastName: zhangsan
    age: 20

行内写法:

friends: {lastName: zhangsan,age: 18}

3)数组(List、Set):

用- 值表示数组中的一个元素

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

3、Profile

1)多Profile文件

  • 我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml

  • 默认使用application.properties的配置;

2)yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8083
spring:
  profiles: dev


---

server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

3)激活指定profile

    1、在配置文件中指定  spring.profiles.active=dev
    2、命令行:
            java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
    3、虚拟机参数:
            -Dspring.profiles.active=dev

4、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
以IDEA中举例:

  • –file:./config/ 相当于项目目录下的config目录下的 application.properties/application.yml文件

  • –file:./ 相当于项目目录下 application.properties/application.yml文件

  • –classpath:/config/ 相当于resource目录下config目录下的 application.properties/application.yml文件

  • –classpath:/ 相当于resource目录下 application.properties/application.yml文件

优先级由高到底,高优先级的配置会覆盖低优先级的配置;

SpringBoot会从这四个位置全部加载主配置文件;互补配置

我们还可以通过spring.config.location来改变默认的配置文件位置

项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;

     例如:  java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

5、外部配置加载顺序

SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置

1.命令行参数

  • java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
  • 多个配置用空格分开; --配置项=值

2.来自java:comp/env的JNDI属性

3.Java系统属性(System.getProperties())

4.操作系统环境变量

5.RandomValuePropertySource配置的random.*属性值

=====================================================================================
项目打成jar包以后(且不进行命令行控制):

1)由 jar包外 向jar包内 进行寻找;

优先加载带profile

6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

7.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

2)再来加载不带profile

8.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

9.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

6、从配置文件中获取值

1)配置文件

person:
    lastName: hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: 12}
    lists:
      - lisi
      - zhaoliu
    dog:
      name: 小狗
      age: 12

2)@Value获取值和@ConfigurationProperties获取值比较

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

配置文件yml还是properties他们都能获取到值:

  • 在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
  • 专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;
    • @ConfigurationProperties(prefix = "person")
    • @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
    • prefix = "person":配置文件中哪个下面的所有属性进行一一映射

3)配置文件注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {


   //lastName必须是邮箱格式
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;

    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
posted @ 2020-03-31 22:02  H2deNote  阅读(279)  评论(0编辑  收藏  举报