Spring Boot 配置 ---02

二、配置文件

1. 配置文件

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

• application.properies
• application.yml

配置文件的作用：修改SpringBoot自动配置的默认值；SpringBot在底层都给我们自动配置好；

YAML (YAML An't Markup Language)

​ YAML A Markup Language: 是一种标记语言

​ YANL isn't Markup Language： 不是一种标记语言

标记语言：

​ 以前的配置文件：大多都使用的是 xxxx.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. 值的写法

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

​ k: v ：字面直接来写

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

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

​ name：“zhangsan lisi”：输出 zhangsan 换行 lisi

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

​ name：’zhangsan lisi‘：输出 zhangsan lisi

对象、Map（属性和值）（键值对）：

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

​ 对象还是k: v的方式

friends
	lastName: zhangsan
	age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

数组（List，Set）

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

pets:
 - cat
 - dog
 - pig

行内写法

pets: [cat,dog,pig]

3. 配置文件值注入

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

2. @Value获取值和@ComfigurationProperties获取值比较

	@ComfigurationProperties	@Value
功能	批量注入配置文件	一个个指定
松散绑定 (松散语法)	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持

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

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

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

3. 配置文件注入值校验

@Component
@ConfigurationProperties(prefix = "person")  //默认从全局文件中获取值
@Validated   //校验
public class Person {

    /**
     *  <bean class="person">
     *     <property name="lastName" value="字面量/${key}从环境、配置文件中获取值/#{SpEL}"
     *  </bean>
     */
    //@Value("${person.last-name}")
    //@Email    //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;
}

4. @PropertySource&@ImportResource

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

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

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

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

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

//导入Spring的配置文件，让其生效
@ImportResource(locations = {"classpath:beans.xml"})
@SpringBootApplication
public class SpringBootQuickApplication {

	public static void main(String[] args) {
		SpringApplication.run(SpringBootQuickApplication.class, args);
	}

}

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

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

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

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

/**
 * @Configuration，指明当前类是一个配置类；就是用来替代之前的Sping配置文件
 * 在配置文件中用<bean></bean>标签添加组件
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中，容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService(){
        return new HelloService();
    }
}

4. 配置文件占位符

1. 随机数

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

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

person.lastName=zhangsan${random.uuid}
person.age=${random.int}
person.birth=2010/10/10
person.boss=false
person.maps.k1=v1
person.maps.k2=v2
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

5. Profile

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

1. 多Profile文件

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

默认使用application.properties的配置；

2. yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: prod

---
server:
  port: 8082
spring:
  profiles: dev

---
server:
  port: 8083
spring:
  profiles: prod  #指定属于哪个环境

3. 激活指定profile

1. 在配置文件中指定

   spring.profiles.active=dev

2. 命令行

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

3. 虚拟机参数：

   -Dspring-profiles.active=dev

6. 配置文件加载位置

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

-file:./config/
-file:./
-classpath:/config/
-classpath:/

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

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

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

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

7. 外部配置加载顺序

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

1. 命令行参数

java -jar spring-boot-config.0.0.1-SNAPSHOT.jar --server.port=8085 --server.context.path=/abc

2. 来自java:comp/env的NDI属性

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)配置文件

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

• @EnableAutoConfiguration作用：

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

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

  • List configurations = this.getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置

    • 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,
    org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,
    org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,
    org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,
    org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,
    org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,
    org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,
    org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,
    org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,
    org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,
    org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,
    org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,
    org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,
    org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,
    org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,
    org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,
    org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,
    org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,
    org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,
    org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,
    org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,
    org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,
    org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,
    org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,
    org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,
    org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,
    org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,
    org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,
    org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,
    org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,
    org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,
    org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,
    org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,
    org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,
    org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,
    org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,
    org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,
    org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,
    org.springframework.boot.autoconfigure.mobile.DeviceResolverAutoConfiguration,
    org.springframework.boot.autoconfigure.mobile.DeviceDelegatingViewResolverAutoConfiguration,
    org.springframework.boot.autoconfigure.mobile.SitePreferenceAutoConfiguration,
    org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,
    org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,
    org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,
    org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,
    org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,
    org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,
    org.springframework.boot.autoconfigure.security.SecurityFilterAutoConfiguration,
    org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,
    org.springframework.boot.autoconfigure.security.oauth2.OAuth2AutoConfiguration,
    org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,
    org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,
    org.springframework.boot.autoconfigure.social.SocialWebAutoConfiguration,
    org.springframework.boot.autoconfigure.social.FacebookAutoConfiguration,
    org.springframework.boot.autoconfigure.social.LinkedInAutoConfiguration,
    org.springframework.boot.autoconfigure.social.TwitterAutoConfiguration,
    org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,
    org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,
    org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,
    org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,
    org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,
    org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration,
    org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,
    org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration,
    org.springframework.boot.autoconfigure.web.HttpEncodingAutoConfiguration,
    org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration,
    org.springframework.boot.autoconfigure.web.MultipartAutoConfiguration,
    org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration,
    org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration,
    org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,
    org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration,
    org.springframework.boot.autoconfigure.websocket.WebSocketMessagingAutoConfiguration,
    org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration
    

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

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

• 以HttpEncodingAutoConfiguration为例解释自动配置原理；

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

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

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

Spring Boot精髓：

• SpringBoot启动会加载大量的指定配置类
• 我们看我们需要的功能有没有SpringBoot默认写好的指定配置类
• 我们再来看这个自动配置类在到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置）
• 给容器中找到配置类添加组件的时候，会从properties类中获取某些属性，我们可以在配置文件中指定这些属性的值

​ xxxxAutoConfiguration：自动配置类；

​ 给容器中添加组件

​ xxxxProperties：封装配置文件中的相关属性