SpringBoot配置文件

二、YAML语法:

1、基本语法

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

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

server:
    port: 8081
    path: /hello

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

2、值的写法

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

• k:V:字面直接来写

• 字符串默认不用加上单引号或者双引号;

• "":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思

            name:"zhangsan In lisi":输出; zhangsan换行lisi

• '':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据

            name: zhangsan \n lisi':输出; zhangsan \n lisi

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

k:v:在下一行来写对象的属性和值的关系；注意缩进

对象还是k:v的方式

friends:
    lastName: zhangsan
    age: 20

行内写法：

friends: {lastName: zhangsan,age: 20}

数组（List、Set）

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

pets:
    - cat
    - dog
    - pig

行内写法：

pets: [cat,dog,pig]

3、配置文件值注入

配置文件

person:
  lastName: zhangsan
  age: 18
  boss: false
  birth: 2021/12/12
  maps: {k1: v1,k2: 12}
  lists:
    - lisi
    - zhaoliu
  dog:
    name: 小狗
    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 lists;
    private Dog dog;

我们可以导入配置文件处理器，以后编写配置就有提示了

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

  1）、properties配置文件在idea中默认utf-8可能会乱码

   2）、@Value获取值和@Configuration Properties获取值比较

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

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

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

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

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

    /**
     * <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取/#{SpEl}"></property>
     *  </bean>
     */
//    @Value("${person.last-name}")
    private String lastName;
//    @Value("#{11*2}")
    private Integer age;
//    @Value("true")
    private Boolean boss;

    @lmportResource：导入 Spring的配置文件，让配置文件里面的内容生效；

    Spring BootSpring里面没有的配置文件，我们己编写的配置文件,也不能自动识别

    想让 Spring的配置文件生效,加载进来；@ImportResource标注在一个配置类上

    @ImportResource(locations = {""}
    导入Spring的配置文件让其生效

    不来编写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.whenfayang.onespringboot.service.HelloService"></bean>
</beans>

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

• 配置类=Spring配置文件

• 使用@Bean给容器中添加组件

• /**
   * Configuration:指明当前类是一个配置类;就是来替代之前的 Spring配置文件
   * 在配置文件中用<bean><bean/>标签添加组件
   */
  @Configuration
  public class MyAppConfig {
  
      //将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
      @Bean
      public HelloService helloService() {
          System.out.println("配置类@Bean给容器添加了组件");
          return new HelloService();
      }
  }

4、配置文件占位符

1）、随机数

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

2）、占位符获取之前配置的值,如果没有可以是用指定默认值

 person.last-name张s{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

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: pro

3）、激活指定profile

1、在配置文件中指定 springprotiles. active=dev

2、命令行:

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

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

3、虚拟机参数;

    -Dspring.profiles.active=dev

6、配置文件占位符

 springboot启动会扫描以下位置的 application. propertiesapplication或者.yml文件作为Springboot的默认配置文件

•  file:./config/

•  file:/

•  classpath: /config/

•  classpath:/

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

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

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

7、外部配置加载顺序

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

1.命令行参数

java -jar spring-boot-test-config-02-0.0.1-SNAPSHOT.jar --server.port=8088

多个配置用空格分开；--配置项=值

2.来自 java compenv的NDI属性

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

4.操作系环境变量

5.RandomValue PropertySource配置的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指定的默认属性

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

链接：参考spring官方文档

https://docs.spring.io/spring-boot/docs/1.5.10.RELEASE/reference/htmlsingle/#using-boot-starter

8、自动配置原理

1.自动配置原理

1)SpringBoot启动的时候加载主配置类,开启了自动配置功能@EnableAutoConfiguration

2)@EnableAutoConfiguration作用:

• 利用 EnableAuto ConfigurationImportSelector给容器中导入一些组件?

• 可以查看 selectlmports()方法的内容；

• List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
  

• SpringFactoriesLoader.loadFactoryNames() 扫描所有jar包类路径下 META-INF/spring.factories 把扫描到的这些文件的内容包装成 properties对象 从properties中获取到MpropertiesEnableAutoConfigurat.class类(类名)对应的值,然后把他们添加在容器中

     将类路径下META-INF/spring.factories里面配置的所有 EnableAutoConfiguration的值加入到了容器中；

     链接：spring.factories里面配置

     每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中，用他们来做自动配置；

3）每一个自动配置类进行自动配置功能；

4）以HttpEncodingAutoConfiguration（Http编码自动配置）为例解释自动配置原理；

解释自动配置原理；

//表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@Configuration(proxyBeanMethods = false)

//启动指定类的ConfigurationProperties功能；将配置文件中对应得值和ServerProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中 
@EnableConfigurationProperties(ServerProperties.class)

//spring底层@Conditional注解，根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；
//判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

//判断当前项目有没有这个类。 CharacterEncodingFilter; SpringMVc中进行乱码解决的过滤器
@ConditionalOnClass(CharacterEncodingFilter.class)

//判断配置文件中是否存在某个配置 server.servlet.encoding.enabled如果不存在，判断也是成立的
//即使我们配置文件中部配置Spring.http.encoding.enabled=true,也是默认生效
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {

    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
       this.properties = properties.getServlet().getEncoding();
    }
    
    @Bean    //给容器中添加一个组件，这个组件的某些值需要从Properties中获取
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
       CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
       filter.setEncoding(this.properties.getCharset().name());
       filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));
       filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
       return filter;
}

    根据当前不同的条件判断，决定这个配置类是否生效；

    一旦这个配置类生效，这个配置类就会给容器中添加各种组件，这些组件的属性是从对应得properties类中获取的，

    这些类里面的每一个属性又是和配置文件绑定的；

5）所有在配置文件中能配置的属性都是在xxxProperties类中封装的，配置文件能配置什么就可以参照某个功能对应得这个属性类

//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {

精髓：

1. SpringBoot启动加载大量的自动配置类

2. 我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；

3. 我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

4. 给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值