3.springboot-yml配置

springboot-配置文件

1 springboot配置文件

1.1 springboot的配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的。

• application.properties

• application.yml

作用：修改SpringBoot自动配置的默认值。SpringBoot在底层都给我们自动配置好了，如果我们有需求，我们就需要修改配置文件，使用该文件的配置来实现对默认的配置的修改。

2 YML文件

1 什么是yml？

YAML（YAML Ain’t Markup Language）：是一个递归的写法。

• YAML A Markup Language：是一个标记语言

• YAML isn’t Markup Language：不是一个标记语言；

标记语言：

​ 以前的配置文件；大多都使用的是 xxxx.xml文件，现在则可以使用yml的方式。

2 yml特点：

1. 以数据为中心，比json、xml等更适合做配置文件。
2. 如果yml和properties同时存在的时候，yml优先加载。

3 XML和yml配置方式对比

YAML：

server:
  port: 8081

​ XML：

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

2 YAML语法：

2.1 基本语法

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

• 以空格的缩进来控制层级关系。

• 只要是左对齐的一列数据，都是同一个层级的。

• 属性和值也是大小写敏感。

server:
    port: 8081
    path: /hello

2.2 值的写法

2.2.1 字面量

​ 字面量就是普通的值（数字，字符串，布尔）

​ k: v：字面直接来写；

​ 字符串默认不用加上单引号或者双引号；

​ “”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

​ name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

​ ‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

​ name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

2.2.2 对象&Map

​ k: v：在下一行来写对象的属性和值的关系

​ 对象还是k: v的方式(注意空格)

friends:
  lastName: zhangsan
  age: 20

行内写法：

friends: {lastName: zhangsan,age: 24}

2.2.3 数组

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

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

3 配置文件值注入

3.1 配置文件

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

3.2 javaBean

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 *
 *@Component 只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能；
 */
@Component
@ConfigurationProperties(prefix = "person")
public class Person {

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

细节：导入配置文件处理器，以后编写配置就有提示了

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

3.3 细节

3.3.1 乱码问题

​ properties配置文件在idea中默认utf-8可能会乱码，因此我们需要对idea进行调整。

3.3.2 @Value&@ConfigurationProperties

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持,属性是lastName，配置可以使用last-name等	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

松散绑定(松散语法)：支持属性是lastName，properties中的属性key可以使用last-name

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

如何选择：

• 如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

• 如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

3.3.3 注入值数据校验

​ 配置注入值得校验问题：

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

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

   //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;

3.3.4 @PropertySource&@ImportResource&@Bean

1 @PropertySource

​ 加载指定的配置文件，从指定的配置文件中进行值注入等

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 *      prefix = "person"：和配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；
 *  @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值；
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */

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

2 @ImportResource

​ 作用：导入Spring的配置文件。

• Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，springboot不能自动识别。
• @ImportResource标注在一个配置类上，表示加载该配置文件。
• 该方式不是springboot推荐的方式。

@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效
//这并不是springboot推荐的方式

编写Spring的配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">


    <bean id="helloService" class="com.atguigu.springboot.service.HelloService"></bean>
</beans>

3 @bean

​ SpringBoot推荐给容器中添加组件的方式：推荐使用全注解的方式

使用步骤：

1. 配置类**@Configuration**------>Spring配置文件
2. 使用**@Bean**给容器中添加组件

/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

4 配置文件占位符

4.1 随机数

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

4.2 占位符

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

注意：

• 如果取之前配置的属性的值为当前值进行拼串，如果没有给其赋值就会解析出错。
• 如果取得的值没有被定义，会使用默认值

5 Profile的使用

5.1 多Profile文件

​ profile是Spring对不同的环境提供不同的配置功能的支持，可以通过激活，指定参数等方式快速的切换环境。我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml

默认使用application.properties的配置

5.2 多文档块

​ yml支持多文档块，使用文档块的方式来划分不同的配置文件。

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

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


---

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

5.3 激活指定profile

5.3.1 配置文件

​ 在配置文件中指定 spring.profiles.active=dev

配置修改的优先级高于配置文件的优先级。

5.3.2 命令行：

1 先对项目进行打包：

2 在cmd窗口执行可执行文件

​ java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；

​ 可以直接在测试的时候，配置传入命令行参数

5.3.3 虚拟机参数

​ 设置虚拟机的参数来设置配置文件的位置-Dspring.profiles.active=dev

6 配置文件加载位置

6.1 默认行为

​ springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件：

• file:./config/ ：当前项目的根目录下的config下的文件夹

• file:./

• classpath:/config/

• classpath:/

特点：

• 优先级由高到底，高优先级的配置会覆盖低优先级的配置。

• SpringBoot会从这四个位置全部加载主配置文件==>互补配置。

6.2 自定义

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

• 项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置

• 指定配置文件和默认加载的这些配置文件共同起作用形成互补配置。

• 例如：从本地磁盘加载配置文件：

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

7 外部配置加载顺序

​ 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包外向jar包内进行寻找；

优先加载带profile

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

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

再来加载不带profile

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

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

10.@Configuration注解类上的@PropertySource

11.通过SpringApplication.setDefaultProperties指定的默认属性

所有支持的配置加载来源；

由jar包外向jar包内进行寻找；

优先加载带profile

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

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

再来加载不带profile

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

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

10.@Configuration注解类上的@PropertySource

11.通过SpringApplication.setDefaultProperties指定的默认属性

所有支持的配置加载来源；

参考官方文档