springboot配置文件

1.配置文件

[1].SpringBoot使用一个全局的配置文件,配置文件名是固定的;

application.properties

application.yml

[2].配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;

[3].YAML(YAML Ain't Markup Language)

YAML A Markup Language:是一个标记语言

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

[4]].标记语言:

以前的配置文件;大多都使用的是 xxxx.xml/xxx.properties文件;

xml

<server>
    <port>8888</port>
</server>

properties

server.port=8888

[5].YAML:以数据为中心,比json、xml等更适合做配置文件;

[6].YAML:配置例子

server:
  port: 8888

2、YAML语法:

[1].基本语法

k:(空格)v:表示一对键值对(空格必须有); 以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

server:
    port: 8081
    path: /hello

属性和值也是大小写敏感;

[2].值的写法

①.字面量:普通的值(数字,字符串,布尔)

k: v:字面直接来写;

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

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

name: "zhangsan \n lisi":输出;zhangsan 换行 lisi

'':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi

②.对象、Map(属性和值)(键值对):

k: v:在下一行来写对象的属性和值的关系;注意缩进对象还是k: v的方式

student:
  name: zhangsan
  age: 11

行内写法

student: {name: zhangsan,age: 11}

③.数组(List、Set):

用-【空格】值表示数组中的一个元素

pets:
 - dog
 - cat
 - elephant

行内写法

pets: [dog,cat,lion]

3.配置文件值注入

[1].配置文件

person:
    last-name: King
    age: 18
    map: {k1: v1,k2: v2}
    lists: [entry1,entry2]
    dog:
        name: cutting
        age: 12
    boss: false
    birth: 2018/04/01

[2].javaBean

/**
 * @ProjectName: newStart
 * @Package: com.w4xj.springboot02config.bean
 * @ClassName: ${TYPE_NAME}
 * @Description: The description of this class
 * @Author: w4xj
 * @CreateDate: 2018/3/18 0018 下午 2:59
 * @UpdateUser: w4xj
 * @UpdateDate: 2018/3/18 0018 下午 2:59
 * @UpdateRemark: The modified content
 * @Version: 1.0
 * Copyright: Copyright (c) 2018$
 */

public class Dog {

    private String name;

    private int age;


    //getter setter toString
/**

 * @ProjectName: newStart
 * @Package: com.w4xj.springboot02config.bean
 * @ClassName: ${TYPE_NAME}
 * @Description: The description of this class
 * @Author: w4xj
 * @CreateDate: 2018/3/18 0018 下午 2:57
 * @UpdateUser: w4xj
 * @UpdateDate: 2018/3/18 0018 下午 2:57
 * @UpdateRemark: The modified content
 * @Version: 1.0
 * Copyright: Copyright (c) 2018$
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @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;

    //getter setter toString

[3].点击Open Documentation

跳转到Spring文档,复制依赖到pom文件

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

[4].编写测试类,用ide快速生成的springboot项目包在test包下默认含有一个测试类

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot02ConfigApplicationTests {

   @Autowired
   Person person;

   @Test
   public void contextLoads() {
      System.out.println(person);
   }

}

运行测试类

Person{lastName='King', age=18, boss=false, birth=Sun Apr 01 00:00:00 CST 2018, maps=null, lists=[entry1, entry2], dog=Dog{name='cutting', age=12}}

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

[6].properties注入

person.last-name=w4xj
person.age=12
person.boss=true
person.lists=entry1,entry2,entry3
person.maps.k1=v1
person.maps.k2=v2
person.birth=2018/02/22
person.dog.name=tiger
person.dog.age=4

[7].运行测试类

Person{lastName='w4xj', age=12, boss=true, birth=Thu Feb 22 00:00:00 CST 2018, maps={k1=v1, k2=v2}, lists=[entry1, entry2, entry3], dog=Dog{name='tiger', age=4}}

[8].@Value获取值和@ConfigurationProperties获取值比较

 

@ConfigurationProperties

@Value

功能

批量注入配置文件中的属性

一个个的指定

松散绑定(松散语法)

支持

不支持

SeEL

不支持

支持

JSR303

支持

不支持

复杂类型封装

支持

不支持

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

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

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

[9].配置文件注入值数据校验

@Component

@ConfigurationProperties(prefix = "person")

public class Person {

    /**
     *  <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */
    @Email
//    @Value("$(person.last-name)")
    private String lastName;
//    @Value("#{2*2}")
    private Integer age;
//    @Value("false")

    private Boolean boss;

    private Date birth;

    private Map<String,Object> maps;

    private List<Object> lists;

    private Dog dog;


    //getter setter toString

[10].@PropertySource&@ImportResource&@Bean

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

/**
 * Copyright: Copyright (c) 2018$
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 *      prefix = "person":配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
 */
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    /**
     *  <bean class="Person">
     *      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>
     * <bean/>
     */
    @Email
//    @Value("$(person.last-name)")

    private String lastName;

//    @Value("#{2*2}")

    private Integer age;

//    @Value("false")

    private Boolean boss;

    private Date birth;

    private Map<String,Object> maps;

    private List<Object> lists;

    private Dog dog;

②.@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别; 想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上

a.创建类一个service类

/**
 * @ProjectName: newStart
 * @Package: com.w4xj.springboot02config.service
 * @ClassName: ${TYPE_NAME}
 * @Description: The description of this class
 * @Author: w4xj
 * @CreateDate: 2018/3/18 0018 下午 5:35
 * @UpdateUser: w4xj
 * @UpdateDate: 2018/3/18 0018 下午 5:35
 * @UpdateRemark: The modified content
 * @Version: 1.0
 * Copyright: Copyright (c) 2018$
 */
public class MyService {

}

b.配置bean

<?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="myService" class="com.w4xj.springboot02config.service.MyService"></bean>
</beans>

c.测试是否能获取到

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot02ConfigApplicationTests {

   @Autowired
   ApplicationContext ioc ;

   @Test
   public void testBean() {
      boolean myService = ioc.containsBean("myService");
      System.out.println(myService);
   }

false

d.给主程序加上@ImportResource注解

@ImportResource("classpath:bean.xml")
@SpringBootApplication
public class Springboot02ConfigApplication {

f.再次测试

true

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

a.配置类:@Configuration<------>Spring配置文件

方法名<---->id

/**
 * @ProjectName: newStart
 * @Package: com.w4xj.springboot02config.config
 * @ClassName: ${TYPE_NAME}
 * @Description: The description of this class
 * @Author: w4xj
 * @CreateDate: 2018/3/18 0018 下午 5:52
 * @UpdateUser: w4xj
 * @UpdateDate: 2018/3/18 0018 下午 5:52
 * @UpdateRemark: The modified content
 * @Version: 1.0
 * Copyright: Copyright (c) 2018$
 *  @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
 *  在配置文件中用<bean><bean/>标签添加组件
 */
@Configuration
public class MyConfig {
    //将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
    @Bean
    public SecondService secondService02() {
        System.out.println("向容器中注入secondService02");
        return new SecondService();
    }
}

b.测试,按方法名来取bean

@Test
public void testBean() {
   boolean myService = ioc.containsBean("secondService02");
   System.out.println(myService);
}

c.结果

true

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.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

5.Profile

[1].多Profile文件

我们在主配置文件编写的时候,文件名可以是 application-{profile}.properties/yml 默认使用application.properties的配置;

①.主配置文件,若不指定spring.profiles.active,则使用主配置文件默认配置

server.port=8080
spring.profiles.active=prod

②.application-dev.properties

server.port=8081

③.application-prod.properties

server.port=8082

[2].yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: prod
‐‐‐
server:
  port: 8083
spring:
  profiles: dev
‐‐‐
server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

[3].激活指定profile

①.在配置文件中指定 spring.profiles.active=dev:结合[1]

②.命令行传入 --spring.profiles.active=dev

③.执行jar包时传入参数

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

④.指定虚拟机参数 -Dspring.profiles.active=dev

6.配置文件加载位置

[1].springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件(用springboot2.0测试,前两个好像未生效,有待测试

file:./config/

file:./

classpath:/config/

classpath:/

优先级由高到底,高优先级的配置会覆盖低优先级的配置;在同一级同时存在yml和properties配置文件时,yml优先级高于properties

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

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

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

7.外部配置加载顺序

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

 

所有支持的配置加载来源:https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-external-config

8.自动配置原理

[1].配置文件到底能写什么?怎么写?自动配置原理;

https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#common-application-properties

[2].自动配置原理:

①SpringBoot启动的时候加载主配置类,开启了自动配置功能 @EnableAutoConfiguration

②.@EnableAutoConfiguration 作用:

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

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

List configurations = 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.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.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.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.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.jest.JestAutoConfiguration,\

org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\

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.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.groovy.template.GroovyTemplateAutoConfiguration,\

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.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.reactor.core.ReactorCoreAutoConfiguration,\

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.sendgrid.SendGridAutoConfiguration,\

org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\

org.springframework.boot.autoconfigure.security.oauth2.client.OAuth2ClientAutoConfiguration,\

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

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

[3].每一个自动配置类进行自动配置功能;

[4].以HttpEncodingAutoConfiguration(Http编码自动配置)为例解释自动配置原理;

@Configuration  //这是一个配置类,和以前编写的配置文件一样,也可以给容器中添加组件
@EnableConfigurationProperties({HttpEncodingProperties.class})//启用指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把他加入到ioc容器中
@ConditionalOnWebApplication(
    type = Type.SERVLET
)//Spring底层@Conditional注解,根据不同的条件,如果满足指定的条件,整个配置类里面的配置才会生效;判断当前应用是否为web应用,如果是,当前应用生效
@ConditionalOnClass({CharacterEncodingFilter.class})//判断当前项目有没有这个类@CharactorEncodingFilter:SpringMVC中进行乱码解决的过滤器
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)//判断配置文件中是否存在某个配置spring.http.encoding;如果不存在,也认为判断为成立
public class HttpEncodingAutoConfiguration {
    private final HttpEncodingProperties properties;//已经和Springboot配置文件进行映射
    //只有一个有参构造器的情况下,参数的值会从容器中获取
    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(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.REQUEST));
        filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.autoconfigure.http.HttpEncodingProperties.Type.RESPONSE));
        return filter;
    }

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

一但这个配置类生效;这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取

的,这些类里面的每一个属性又是和配置文件绑定的;

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


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

[6].精髓:

①.SpringBoot启动会加载大量的自动配置类

②.我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;

③.我们再来看这个自动配置类中到底配置了哪些组件;(只要我们要用的组件有,我们就不需要再来配置了)

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

xxxxAutoConfigurartion:自动配置类;

给容器中添加组件

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

[7].@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属性;来让控制台打印自动配置报告,这样我们就可以很方便的知道哪些自动配置 类生效;

=========================

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)

 

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值