Spring Boot 学习笔记：配置文件

配置文件

Spring Boot 使用一个全局的配置文件，配置文件名是固定的：application.yml或者application.properties。配置文件的作用就是用来修改Spring Boot 自动配置的默认值。

YAML

YAML Ain’t Markup Language：YAML 不是一个标记语言。（题外话：其实就是标记语言）
以前的配置文件大多都使用的是 xxx.xml 文件而 YAML 是以数据为中心，比 json、xml 等更适合做配置文件。

基本语法

k:(空格)v：表示一对键值对（空格必须有）；以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的。
其中属性和值是大小写敏感，值也可以用键值对和数字来表示。

server:
    port: 8081
    path: /hello

• 值的写法：字符串默认不用加上单引号或者双引号
  “”（双引号）：特殊字符会作为本身想表示的意思；’’（单引号）：特殊字符最终只是一个普通的字符串数据
  name: “zhangsan \n lisi” – 输出；zhangsan 换行 lisi
  name: ‘zhangsan \n lisi’ – 输出；zhangsan \n lisi

配置文件注入

application.yml

person:
    lastName: zhangsan
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: v2}
    lists:
      - lisi
      - wangwu
    dog:
      name: ccc
      age: 2

JavaBean

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
 * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * 只有这个组件是容器中的组件，才能容器提供的@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>

SpringBootTest

@SpringBootTest
class SpringBoot02ConfigApplicationTests {

    @Autowired
    Person person;

    @Test
    void contextLoads() {
        System.out.println(person);
    }

}

控制台输出：

• 解决 properties 配置文件在idea中默认utf-8可能会乱码的问题

@PropertySource & @ImportResource & @Bean

• @PropertySource：加载指定的配置文件

将配置文件中配置的每一个属性的值，映射到这个组件中
@ConfigurationProperties：告诉 Spring Boot 将本类中的所有属性和配置文件中相关的配置进行绑定
prefix = “person”：配置文件中哪个下面的所有属性进行一一映射

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {

• @ImportResource && @Bean：导入Spring的配置文件，让配置文件里面的内容生效

Spring Boot 里面没有Spring的配置文件，即使是我们自己编写的配置文件，也不能自动识别；但是想让 Spring 的配置文件生效并加载进来，编写 xml 配置文件并且使用 @Bean 在 config 类中注释进来，而 @ImportResource 等同于 xml 文件
bean.xml

<?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>

MyAppConfig.java

@ImportResource(locations = {"classpath:beans.xml"})
@Configuration
public class MyAppConfig {

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

Profile

我们在主配置文件编写的时候，文件名可以是：application-{profile}.properties/yml，但是默认使用application.properties的配置

application.yml

server:
  port: 8081

spring:
  profiles:
    active: prod
---
server:
  port: 8083
spring:
  profiles: dev
---
server:
  port: 8084
spring:
  profiles: prod

激活指定profile

• 在配置文件中指定 spring.profiles.active=dev
• 命令行：可以直接在测试的时候，配置传入命令行参数

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

• 虚拟机参数：-Dspring.profiles.active=dev

配置文件加载位置

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

–file:./config/
–file:./
–classpath:/config/
–classpath:/

Spring Boot 会从这四个位置全部加载主配置文件，优先级由高到底，高优先级的配置会覆盖低优先级的配置并且互补配置；如下图所示，config 文件夹下的 properties 文件优先级是最高的，随后才是 src 下的的 classpath 路径