SpringBoot配置(1) 配置文件application&yml

 

SpringBoot配置(1) 配置文件application&yml

一、配置文件

1.1 配置文件

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

• application.properties

• application.yml

  配置文件放在src/main/resources目录或者类路径/config下。

YAML（YAML Ain’t Markup Language）

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

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

标记语言：

​ 以前的配置文件；大多都使用的是 xxxx.xml文件；

​ YAML：以数据为中心，比json、xml等更适合做配置文件；

​ YAML：配置例子

server:
  port: 8090

​ XML:

<server>
	<port>8090</port>
</server>

1.2 YAML语法

1.2.1 YAML基本语法

YAML基本语法

• 使用缩进表示层级关系
• 缩进时不允许使用Tab键，只允许使用空格
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• 大小写敏感
• ‘#’表示注释，只能单行注释，从#开始处到行尾
• 破折号后面跟一个空格（a dash and space）表示列表
• 用冒号和空格表示键值对 key: value
• .简单数据（scalars，标量数据）可以不使用引号括起来，包括字符串数据。用单引号或者双引号括起来的被当作字符串数据，在单引号或双引号中使用C风格的转义字符

YAML 支持的三种数据结构
– 对象：键值对的集合
– 数组：一组按次序排列的值
– 字面量：单个的、不可再分的值

1.2.2 YAML常用写法

字面量：普通的值（数字，字符串，布尔）

• k: v：字面直接来写；
• 字符串
  – 默认不使用引号
  – 可以使用单引号或者双引号，单引号会转义特殊字符

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

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

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

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

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

– 字符串可以写成多行，从第二行开始，必须有一个单空格缩进。换行符会被转为空格。​

对象：

对象的一组键值对，使用冒号分隔。如：username: admin
• 冒号后面跟空格来分开键值；
• {k: v}是行内写法

​ k:(空格) v：在下一行来写对象的属性和值的关系；注意缩进

​ 对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

数组（List、Set）：

一组连词线（-）开头的行，构成一个数组，[]为行内写法
– 数组，对象可以组合使用

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

文档

• 多个文档用 - - - 隔开

1.3 配置文件注入

导入配置文件处理器，以后编写配置就会有提示

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

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

.yml配置文件

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

测试配置文件是否完成属性注入

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootConfigurationApplicationTests {
    @Autowired
    Person person;
    @Test
    public void contextLoads() {
        System.out.println(person);
    }
}

输出结果：

Person{name='张三', age=15, boss=false, email='123456@qq.com', birth=Fri Dec 12 00:00:00 GMT+08:00 2003, maps={k1=张三, k2=员工}, lists=[0, 1, 2, 3], dog=Dog{name='小六', age=2, MasterName='张三'}}

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

1.3.2 @Value获取值和@ConfigurationProperties获取值比较

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

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

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

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

---

属性名匹配规则（Relaxed binding）松散语法绑定：

• person.firstName：使用标准方式
• person.first-name：大写用-
• person.first_name：大写用_
• PERSON_FIRST_NAME： 推荐系统属性使用这种写法

1.3.3 配置文件注入值数据校验

@ConfigurationProperties @Validation

• 支持JSR303进行配置文件值校验；

数据校验只在@ConfigurationProperties获取值时有效，示例：

/**
 * 加载指定位置配置文件
 * @PropertySource(value ={"classpath:application.properties"})
 * 需和@ConfigurationProperties(prefix = "person") 一起使用
 */
@ConfigurationProperties(prefix = "person")
@Component     //将类添加到容器中成为容器的组件
@Validated    //数据校验
public class Person {
    /**
     * <bean class ="person">
     *     <propertry name="lastname" value="字面量/${key}从环境变量、配置文件中获取值/#          *         {SpEl}">
     *         </propertry>
     *     </bean>
     * 同时配置了@value()和@ConfigurationProperties 优先使用后者
     */
   // @Value("王五")
    private  String name;
   // @Value("#{22*2}")
    private int age;
    private  Boolean boss;
   // @Email  //数据检验 email必须是邮箱格式
    private String email;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private  Dog dog;

1.3.4 @PropertySource&@ImportResource&@Bean

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

@ConfigurationProperties：

• 与@Bean结合为属性赋值
• 与@PropertySource（只能用于properties文件）结合读取指定文件

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

/**
 * 加载指定位置配置文件
 * @PropertySource(value ={"classpath:application.properties"})
 * 需和@ConfigurationProperties(prefix = "person") 一起使用
 * 若application.properties中和person.properties同时配置了person优先使用前者。
 */

@ConfigurationProperties(prefix = "person")
@PropertySource(value ={"classpath:person.properties"})
@Component     //将类添加到容器中成为容器的组件
@Validated    //数据校验
public class Person {
    //@Value("王八")
    private  String name;
   // @Value("#{22*2}")
    private int age;
    private  Boolean boss;
   // @Email  //数据检验 email必须是邮箱格式
    private String email;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private  Dog dog;

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

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

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

@ImportResource(locations = {"classpath:beans.xml"})//导入Spring的配置文件，让配置文件里面的内容生效
@SpringBootApplication
public class SpringbootConfigYmlApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootConfigYmlApplication.class, args);
    }
}

beans.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.lrh.springboot_config_yml.service.HelloService"></bean>
</beans>

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

1、配置类**@Configuration**------>Spring配置文件

2、使用**@Bean**给容器中添加组件

/**
 * SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式
 * 1、配置类**@Configuration**------>Spring配置文件
 * 2、使用**@Bean**给容器中添加组件
 */
/**
 * @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件
 */
@Configuration
public class MyAppConfig {
    //相当于在配置文件中用<bean><bean/>标签添加组件
    //将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名helloService02
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }
}

1.4 配置文件占位符

随机数：

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

占位符获取之前配置的值，如果没有可以是用:指定默认值

#配置person的值
person.name=王五${random.uuid}
person.age=18
person.birth=2018/12/12
person.boss=false
person.email=80808080@qq.com
person.maps.k1=12
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.name}的dog
person.dog.age=2
person.dog.MasterName=${person.first-name:设置默认值}王五

1.5 Profile

Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、指定参数等方式快速切换环境

1.5.1 多Profile文件

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

默认使用application.properties的配置；

编写多个Profile文件：

在application.properties中激活使用指定的profile文件

#激活指定profile
spring.profiles.active=dev  

1.5.2 yml支持多文档块方式

server:
  port: 8090
spring:
  profiles:
     #激活指定profiles
    active: dev
---
server:
  port: 8020
spring:
  profiles: dev
---
server:
  port: 8050
spring:
  profiles: prod

1.5.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

二、加载顺序

2.1 配置文件加载位置

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

–file:./config/

–file:./

–classpath:/config/

–classpath:/

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

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

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

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

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

2.2 外部配置加载顺序

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指定的默认属性

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

参考官方文档

三、配置原理

配置文件到底能写什么？怎么写？自动配置原理；

参考官方文档

3.1 自动配置原理

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

2）、@EnableAutoConfiguration 作用：

• 利用AutoConfigurationImportSelector给容器中导入一些组件？

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

  AutoConfigurationImportSelector.class的selectImports()中：

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

SpringFactoriesLoader.class:

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

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

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

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

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

@Configuration //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组件
@EnableConfigurationProperties({HttpProperties.class})  //启动指定类的ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把HttpEncodingProperties加入到ioc容器中
@ConditionalOnWebApplication(
    type = Type.SERVLET
)//Spring底层@Conditional注解，根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效；    判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnClass({CharacterEncodingFilter.class})//判断当前项目有没有这个类CharacterEncodingFilter；SpringMVC中进行乱码解决的过滤器；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)//判断配置文件中是否存在某个配置  spring.http.encoding.enabled；如果不存在，判断也是成立的
//即使我们配置文件中不配置pring.http.encoding.enabled=true，也是默认生效的；
public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
     //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpProperties properties) {
        this.properties = properties.getEncoding();
    }

    @Bean //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @ConditionalOnMissingBean   //判断容器没有这个组件？
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
   filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpProperties.Encoding.Type.RESPONSE));
        return filter;
    }

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

一但这个配置类生效；这个配置类就会给容器中添加各种组件；这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

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

@ConfigurationProperties(
    prefix = "spring.http"
)   //从配置文件中获取指定的值和bean的属性进行绑定
public class HttpProperties {
    private boolean logRequestDetails;
    private final HttpProperties.Encoding encoding = new HttpProperties.Encoding();

精髓：

​ 1）、SpringBoot启动会加载大量的自动配置类

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

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

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

xxxxAutoConfigurartion：自动配置类；

给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

3.2 细节

3.2.1 @Conditional派生注解

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@Conditional扩展注解	作用（判断是否满足当前指定条件）
@ConditionalOnJava	系统的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	满足SpEL表达式指定
@ConditionalOnClass	系统中有指定的类
@ConditionalOnMissingClass	系统中没有指定的类
@ConditionalOnSingleCandidate	容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty	系统中指定的属性是否有指定的值
@ConditionalOnResource	类路径下是否存在指定资源文件
@ConditionalOnWebApplication	当前是web环境
@ConditionalOnNotWebApplication	当前不是web环境
@ConditionalOnJndi	JNDI存在指定项

自动配置类必须在一定的条件下才能生效；

我们怎么知道哪些自动配置类生效；

在application.properties中**我们可以通过启用 debug=true属性；来让控制台打印自动配置报告**，这样我们就可以很方便的知道哪些自动配置类生效；

=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches:（自动配置类启用的）
-----------------

   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
        
    
Negative matches:（没有启动，没有匹配成功的自动配置类）
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

   AopAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

（如有错误，望指正）