SpringBoot配置文件详细解释

配置文件

1.配置文件

Spring Boot使用一个全局的配置文件，配置文件名字是固定的

		1.application.properties
		2.application.yml

配置文件的作用：修改SpringBoot自动配置的默认值

yml是YAML它的全称（AYML Aint Markup Language）

YANL A Markup Language 是一个标记语言

YANL isnt Markup Language 不是一个标记语言

标记语言：

以前的配置文件，大多数使用的是xxx.xml文件

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

YAML配置的例子

server配置使用呢个端口号
	port: 8081

XML配置

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

2.YAML的基本语法

1.基本语法

K:(空格)V : 表示一对键值对（空格必须有）

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

server
	port: 8081
	path: /hello

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

2.值的写法

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

k: v : 字面值直接来写

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

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

name：“张珊/n 历史” 输出：张珊换行历史

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

name：“张珊/n 历史” 输出：张珊/n 历史

2.对象，Map（属性和值）（键值对）：

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

对象还是K: v的方式

friends:
      lastName: 张三
      age: 20

行内写法：

friends: {lastName: zhangsahn,age: 18}

3.数组（List， Set）

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

pets: 
 - cat
 - dog
 - pig

行内写法：

pets: [cat,dao,pig]

4. 这里出现了一个错误

最后才发现是因为 spring boot 只扫描启动类 Application 的子目录，而我的启动类放在了子目录，报错无法找到的 bean 放到了父目录，所以没有被扫描并且初始化。最后的解决办法是把 Application 启动类挪到父目录解决问题。
在这里插入图片描述

3.配置文件值的注入

1.在yaml配置文件把对象注入Javabean

person:
    lastName: zhangsan
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: v1,k2: v2}
    lsits:
      - lisi
      - zhaol
      - 大学
    dog:
      name: 效果
      age: 2

2.JavaBean：@ConfigurationProperties

/**
 * @author lzq
 * @date 2019/11/25 - 17:48
 *
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 *@ConfigurationProperties：告诉Springboot将本类中的所有的属性和配置文件中相关的配置进行绑定
 *      prefix="person"配置文件中那个下面的所有属性进行一一映射
 *
 *只有这个组件是容器中的组件，才能使用容器提供的功能
 @ConfigurationProperties默认从全局配置文件中获取值
 */
@Component
@ConfigurationProperties(prefix = "person")//需要的注解
public class Person implements Serializable {

    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.在properties配置文件把对象注入Javabean

person.last-name=张三
person.age=10
person.birth=2018/12/12
person.boss=false
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=dog
person.dog.age=15

4.使用@value()注解注入对象

@Component
public class Person implements Serializable {
    /**
    *<bean class="Person"> 
    *		<properties name="lastName" value="字面量/${key}从环境变量，配置文件获取值/#		*		{spEL}"></properties>
    *</bead>
    */
    @Value("${person.lastName}")
    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;

5.松散绑定

以person.firstName为例

person.first-name：-n为N

person.first_name：_n也为N

6.配置文件注入值的JSP303数据校验

//lastName的格式必须是邮箱格式
@Email
private String lastName;

7.@value和@ConfigurationProperties获取值比较

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

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

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

8.@PropertySource和@ImportResource

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

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

    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;

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

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

想让Spring的配置文件生效，加载到容器内，需要@ImportResource配置到主配置类上面

@ImportResource(locations = {"classpath:beans.xml"})
导入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="cn.lz.springboot.service.HelloService"></bean>
</beans>

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

1.配置类=======Spring配置文件

2.使用@Bean给容器添加组件

/**
 * @author lzq
 * @date 2019/11/26 - 20:44
 * 
 * @Configuration指明当前类是一个配置类，就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean></bean>标签添加组件的
 *
 */
@Configuration
public class MyAppConfig {

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

4.配置文件占位符

1.随机数

${random.value},${random.int},${random.long}
${random.int(10)},${random.int(1027,65536)}

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

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

5.Profile多环境支持

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

1.多Profile文件

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

默认使用application.properties的配置

2.yaml支持多文档快模式

#文档块1
server:
  port: 8081
#运行环境的激活
spring:
  profiles:
   active: dev
---
#文档块2
server:
  port: 8082
#测试环境
spring:
  profiles: dev
---
#文档块2
server:
  port: 8083
#生产环境
spring:
  profiles: prod

3.激活指定profile

1.多profile文件方式的激活

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

在这里插入图片描述

2.命令行参数

–spring.profiles.active=dev;可以直接在idea中添加参数，不用在cmd中写，如下

在这里插入图片描述
3.虚拟机参数

-Dspring-profiles.active=dev

在这里插入图片描述
2和3的激活方式使用yaml配置文件才可以使用

6.SpringBoot配置文件加载位置

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

—file（于src同一级也就是项目的根目录下…/config/

—file（于src同一级也就是项目的根目录下）…

—classpath(当前项目resources目录下):/config/

—classpath(当前项目resources目录下)/

以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容。

我们可以通过spring.config.location来改变默认配置

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-PYbxLiBe-1589979027189)(E:\文档\图片\spring boot\SpringBoot的文件加载位置.PNG)]

7.外部配置加载顺序

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

1.命令行参数

项目的jar包在开始运行的时，指定一些配置

例子：springboot.jar --server.port=8087 --server.context-payh=/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

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

8.自动配置

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

配置文件能配置的属性参照

自动配置原理：

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

2.@EnableAutoConfiguration作用：

利用Import({AutoConfigurationImportSelector.class})给容器中导入了一些组件

可以查看插件selectimports()方法的内容

3.List conﬁgurations = getCandidateConﬁgurations(annotationMetadata, attributes);获取候选的配置

EnableAutoConﬁguration的值加入到了容器中；

SpringFactoriesLoader.loadFactoryNames() 

扫描所有jar包类路径下  META‐INF/spring.factories 

把扫描到的这些文件的内容包装成properties对象 

从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器 中

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

# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\ org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\ org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\ org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\ org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\ org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\ org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\ org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\ org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\ org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\ org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration, \ org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\ org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration ,\ org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\ org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration ,\ org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration
.........

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

4、以HttpEncodingAutoConﬁguration（Http编码自动配置）为例解释自动配置原理；

@Configuration   //表示这是一个配置类，以前编写的配置文件一样，也可以给容器中添加组
@EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的 ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来；并把 HttpEncodingProperties加入到ioc容器中   
@ConditionalOnWebApplication //Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果 满足指定的条件，整个配置类里面的配置就会生效；    判断当前应用是否是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 HttpEncodingProperties properties; 
    
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {    this.properties = properties;          
                                                                            }

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

一但这个配置类生效；这个配置类就会通过Bean给容器中添加各种组件；

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

这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；

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

@ConfigurationProperties(prefix = "spring.http.encoding")  //从配置文件中获取指定的值和bean的属 性进行绑定 
public class HttpEncodingProperties {      public static final Charset DEFAULT_CHARSET = Charset.forName("UTF‐8");

精髓：

1）、SpringBoot启动会加载大量的自动配置类
2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；
3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）

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

xxxxAutoConﬁgurartion：自动配置类；

给容器中添加组件

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

9.@conditional注解扩展

1、@Conditional派生注解（Spring注解版原生的@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存在指定项

自动配置类必须在一定条件下才可以生效

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