SpringBoot配置详解

二、配置文件

1、配置文件

SpringBoot使用一个全局的配置文件

  • application.properties
  • application.yml

配置文件的作用：修改SpringBoot自动配置的默认值（默认值SpringBoot在底层给我们自动配置好）。

yml又称YAML（YAML Ain't Markup Language)

  • YAML A Markyp Language : 是一个标记语言；

  • YAML isn't Markup Language : 不是一个标记语言。

标记语言：

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

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

​ YAML的 配置例子

server:
  port: 8081

​ XML :

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

2、YAML语法：

2.1、基本语法

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

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

server:
    port: 8081
    path: /what

属性和值是大小写敏感的。

2.2、值的写法

字面量 ：普通的值（数字，字符串，布尔，日期)

​ k: v : 字面直接来写。

​ 字符串默认不用假上单引号或者看双引号；

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

​ name : "zhuanyi \n list" ; 输出 ：zhuanyi 换行 list

  • ​ '' : 单引号；会转义特殊字符，特殊字符最终知识一个普通的字符串数据，

​ name : "zhuanyi \n list" ; 输出 ：zhuanyi \n list

对象、Map(属性和值)（键值对）

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

user:
   name: zhangsan
   age: 18

行内写法：

user: {name: zhangsan, age: 20}
数组（List，Set）

用-(空格)值表示数组中的一个元素

pets:
 - dog
 - cat
 - pig

行内写法

pets: [cat,dog,pig]

3、配置文件值注入

配置文件

person:
  lastName: hello
  age: 29
  boss: true
  birth: 2020/07/06
  maps: {k1: ha, k2: 你好}
  lists:
    - lisi
    - zhanhui
  dog:
    name: 小狗
    age: 100

JavaBean

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties: 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * 只有这个组件时容器中的组件，才能使用容器提供的@ConfigurationProperties功能
 *
 */
@ConfigurationProperties(prefix = "person")
@Component
public class Person {
    private String lastName;
    private Integer age;
    private Boolean boss;
    private Date birth;

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

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Boolean getBoss() {
        return boss;
    }

    public void setBoss(Boolean boss) {
        this.boss = boss;
    }

    public Date getBirth() {
        return birth;
    }

    public void setBirth(Date birth) {
        this.birth = birth;
    }

    public Map<String, Object> getMaps() {
        return maps;
    }

    public void setMaps(Map<String, Object> maps) {
        this.maps = maps;
    }

    public List<Object> getList() {
        return list;
    }

    public void setList(List<Object> list) {
        this.list = list;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }

    @Override
    public String toString() {
        return "Person{" +
                "lastName='" + lastName + '\'' +
                ", age=" + age +
                ", boss=" + boss +
                ", birth=" + birth +
                ", maps=" + maps +
                ", list=" + list +
                ", dog=" + dog +
                '}';
    }
}

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

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

3.1、解决application.properties配置文件乱码：

关于具体要不要勾选的请参考链接：关于Transparent native-to-ascii conversion

3.2、@Value获取值和@ConfigurationProperties获取值比较

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

配置文件yml或者properties都能获取到值;

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

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

@Value("${person.last-name}")
private String name;

@RequestMapping(value = "sayHello")
public String sayHello() {
    return "hello" + name;
}

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

import javax.validation.constraints.Email;
@ConfigurationProperties(prefix = "person")
@Component
@Validated
public class Person {
    /**
     * <bean class = “Person>
     *      <property name = "lastNmae" value = "字面量/${key}从环境变量、配置文件中获取值/#{SpEL}></property>
     * </bean>
     */
    //@Value("${person.last-name}")
    //lastName格式必须是邮箱格式
    @Email
    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> list;
    private Dog dog;

3.4@PropertySource&@ImportResource

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

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件中
 * @ConfigurationProperties: 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
 * prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
 * 只有这个组件时容器中的组件，才能使用容器提供的@ConfigurationProperties功能
 *@ConfigurationProperties(prefix = "person")默认从全局配置文件中读取值
 *
 */
@PropertySource(value = {"classpath:person.properties"})
@ConfigurationProperties(prefix = "person")
@Component
@Validated
public class Person {
    /**
     * <bean class = “Person>
     *      <property name = "lastNmae" value = "字面量/${key}从环境变量、配置文件中获取值/#{SpEL}></property>
     * </bean>
     */
    //lastName格式必须是邮箱格式
    //@Email
    //@Value("${person.last-name}")
    private String lastName;
    //@Value("#{11*2}")
    private Integer age;
    //@Value("true")
    private Boolean boss;
    private Date birth;

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

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

想让Spring的配置文件生效，就得加@ImportResource标注在一个配置类上。

例如编写得Spring配置文件如下,HelloService没有加上@Service注解：

<?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.hello.service.HelloService"></bean>
</beans>

主配置类：

@SpringBootApplication
@ImportResource(value = {"classpath:beans.xml"})
public class SpringbootHelloWorldApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootHelloWorldApplication.class, args);
    }
}

测试之后，返回true:

@Autowired
   private ApplicationContext ioc;

   @Test
   public void testHelloService(){
       System.out.println(ioc.containsBean("helloService"));
   }

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

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

4、配置文件占位符

4.1、随机数

${random.value}、${random.int}、${random.long}
${random.uuid}、${random.int(10)}

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

person.last-name=里斯${random.uuid}
person.age=${random.int}
person.birth=2018/09/16
person.boss=false
person.maps.k1 = 1
person.maps.k2 = 2
person.dog.name = ${person.hello:name}_dog
person.dog.age = 30
person.list = 1,2,3

5、Profile

5.1、多Profile文件

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

默认使用application.properties的配置；

5.2、yml支持多文档块方式

server:
  port: 8081

spring:
  profiles:
    active: prod
---
server:
  port: 8083
spring:
  profiles: dev
---
server:
  port: 8084
spring:
  profiles: prod
---

5.3、激活指定profile

5.3.1在主配置文件中指定

spring.profiles.active=dev

image-20200708130243389

5.3.2命令行：--spring.profiles.active=dev

image-20200708131715190

或者通过maven的package打成jar包，在项目的target目录下cmd运行jar包：

java -jar springboot-helloworld-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev

image-20200708132632690

5.3.2虚拟机参数：-Dspring.profiles.active=dev

image-20200708133124647

6、配置文件加载位置

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

-file:./config

-file./

-classpath:/config/

-classpath:/

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

SpringBoot会从这四个位置全部加载主配置文件，他们是互补配置。

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

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

java -jar spring-boot-01-config-0.0.1-SNAPSHOT.jar
--spring.config.location=C:\Users\20271\Desktop\application.properties

image-20200708142820497

7、外部配置加载顺序

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

1、命令行参数

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

image-20200708152819753

2、来自java:comp/enb的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-{profile}.properties或application.yml(不带sprIng.profile)配置文件

9、jar包内部的application-{profile}.properties或application.yml(不带sprIng.profile)配置文件

10、@Configuration注解在类上的@PropertSource

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

8、自动配置原理

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

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

8.1、自动配置原理：

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

2、@EnableAutoConfiguration作用：

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

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

  • 该方法调用了List getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes)；获取候选的配置

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

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

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.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration,\
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.CassandraReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jdbc.JdbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration,\
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.r2dbc.R2dbcDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,\
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.ElasticsearchRestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
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.http.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration,\
org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration,\
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.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration,\
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.mongo.embedded.EmbeddedMongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration,\
org.springframework.boot.autoconfigure.r2dbc.R2dbcAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketRequesterAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketServerAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketStrategiesAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveUserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.rsocket.RSocketSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.saml2.Saml2RelyingPartyAutoConfiguration,\
org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.servlet.OAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.reactive.ReactiveOAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.reactive.ReactiveOAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration,\
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.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAutoConfiguration

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

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

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

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

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

//Spring底层@Conditional注解（Spring注解版），根据不同的条件，如果满足指定的条件，整个配置类才会生效;现在的这个注解判断当前应用是否是web应用，如果是，当前配置类生效
@ConditionalOnWebApplication(type = Type.SERVLET)

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

//判断配置文件中是否存在某个配置 server.servlet.encoding.enabled;如果不存在，判断也是成立的;
//即使不配置server.servlet.encoding.enabled，也是默认生效的
@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//给容器添加一个组件
    @ConditionalOnMissingBean//判断容器中没有这个组件
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));
        return filter;
    }

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

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

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

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

精髓：

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

xxxxAutoConfiguration : 自动配置类；给容器添加组件。

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

8.2、细节

1、@Conditional派生注解（Spring注解版原生的@Conditional作用）

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

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

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

怎么知道哪些自动配置类是生效了呢？

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

============================
CONDITIONS EVALUATION REPORT
============================


Positive matches:(自动配置类生效的)
-----------------

   AopAutoConfiguration matched:
      - @ConditionalOnProperty (spring.aop.auto=true) matched (OnPropertyCondition)

   AopAutoConfiguration.ClassProxyingConfiguration matched:
      - @ConditionalOnMissingClass did not find unwanted class 'org.aspectj.weaver.Advice' (OnClassCondition)
      - @ConditionalOnProperty (spring.aop.proxy-target-class=true) matched (OnPropertyCondition)
          
Negative matches:(自动配置类无效的)
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required class 'javax.jms.ConnectionFactory' (OnClassCondition)

   AopAutoConfiguration.AspectJAutoProxyingConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required class 'org.aspectj.weaver.Advice' (OnClassCondition)
posted @ 2020-07-08 20:05  MyDistance  阅读(1616)  评论(0)  编辑  收藏  举报