SpringBoot学习笔记-配置文件

Springboot配置文件

1、配置文件

（1）、springboot使用一个全局的配置文件，配置文件名是固定的；

• application.properties
• application.yml

（2）、配置文件的作用：修改springboot自动配置的默认值；springboot在底层将都给我们自动配置好；

（3）、YAML：以数据为中心，比json、xml更适合做配置文件

（4）、YAML例子：

server:
	port: 8080

XML：

<server>
	<port>8080</port>
</server>

2、YAML语法

（1）、基本语法：

• k：v 表示一对键值对（冒号后面的空格必须有）；

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

  server: 
  	prot: 8081
  	path: /hello
  

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

（2）、值的写法

• 字面量：普通的值（数字、字符串、布尔）；字符串默认不用加上单引号或者双引号

• 对象、Map（属性和值）（键值对）：在下一行来写对象的属性和值的关系，注意缩进

  friends: 
  	lastName: zhangsan
  	age: 20
  

  行内写法：

  friends: {lastName: zhangsan,age: 20}
  

• 数组（List、Set）：

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

  pets:
   - cat
   - dog
   - pig
  

  行内写法：

  pets: [cat,dog,pig]
  

3、配置文件值注入

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

（2）、@Value获取值和@ConfigurationProperties获取值比较

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

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

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

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

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

@Component
@ConfigurationProperties(profix = "person")
@Validated
public class Person {
    
    @Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@
}

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

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

想让Spring的配置文件生效，加载进来；

@ImportResource标注在一个配置类上

@importResource(location = {"classpath;beans.xml"})
导入Spring的配置文件让其生效

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

4、配置文件占位符

（1）、随机数

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

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

person.last-name=张三${random.uuid}
person.age=${random.int}
person.dog.name=${person.hello:hello}_dog

5、Profile

（1）、多profile文件

（2）、yml支持多文档块方式

server:
	port: 8081
spring:
	profiles:
		active: prod #启动生产环境配置文件
		
---
server:
	port: 8083
spring:
	profiles: dev
	
---
server:
	port: 8084
spring:
	profiles: prod #指定属于哪个环境

（3）、激活指定profile

​ a、在配置文件中指定spring.profiles.active=dev ； 使用开发环境配置

​ b、命令行方式激活：在运行的时候进行指定的配置文件

​ --spring.profiles.active=dev

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

​ java -jar spring-boot-config-0.0.1-SNAPSHOP.jar --spring.profiles.active=dev

​ d、调节虚拟机参数：

​ -Dspring.profiles.active=dev

6、配置文件加载位置

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

​ -file：./config/

​ -file：./

​ -classpath：./config/

​ -classpath：./

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

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

我们还可以通过spring.config.location来改变默认的配置文件位置，項目打包好，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；

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

#指定主配置文件的地址
spring.config.location=F:/application.properties

7、外部配置加载顺序

springBoot也可以从以下位置加载配置：按照优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置形成互补配置

（1）命令行参数

（2）来自java：comp/env的JNDI属性

（3）java系统属性（System.getProperties（））

（4）操作系统环境变量

（5）RandomValuePropertiesSource配置为random.*属性值

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

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

（8）jar包外部的application.properties或者application.yml（不带spring.profile）配置文件

（9）jar包内部的application.properties或者application.yml（不带spring.profile）配置文件

（10）@Configuration注解类上的@PropertySource

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

8、自动配置原理

配置文件能配置的属性，参照官方文档

自动配置原理：

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

（2）、@EnableAutoConfiguration的作用：

​ a、利用AutoConfigurationImportSelector给容器中导入了一些组件，可以查看selectImports()方法的内容

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

（4）、每一个xxxAutoConfiguration类都是容器的一个组件，都加入到容器中，用他们来做自动配置

（5）、每一个自动配置类，来进行自动配置功能。

（6）、以HttpEncodingAutoConfiguration为例来解释自动配置原理：

@Configuration(proxyBeanMethods = false) //表示这是一个配置类，也可以给容器中添加组件
@EnableConfigurationProperties(HttpProperties.class) //启动ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET) //spring底层@Conditional注解，根据不同的条件，如果满足指定的条件，整个配置类里面的配置就会生效； 判断当前应用是否为Web应用，如果是，则当前配置类生效
@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类； CharacterEncodingFilter 是SpringMVC中进行乱码解决的过滤器
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判断配置文件中是否存在某个配置,spring.http.encoding 如果不存在，判断也是成立的，即使我们配置文件中不配置spring.http.encoding.enable=true，默认也是生效的
public class HttpEncodingAutoConfiguration {

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

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

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

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

springboot的精髓：

（1）、springboot启动会加载大量的自动配置类

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

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

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