美文网首页
springboot的配置文件

springboot的配置文件

作者: 白夜亮司丶 | 来源:发表于2019-01-21 17:02 被阅读0次

Ⅰ.简介

SpringBoot使用一个全局的配置文件,配置文件名是固定的;
1.application.properties
2.application.yml(或者是yaml)
配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;
YAML(YAML Ain't Markup Language)
  YAML A Markup Language:是一个标记语言
  YAML isn't Markup Language:不是一个标记语言;
标记语言:
  以前的配置文件;大多都使用的是 xxxx.xml文件;
  YAML:以数据为中心,比json、xml等更适合做配置文件;

Ⅱ.yaml语法

1.基本语法

以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的,大小写敏感

k:(空格)v:

#空格不能省
#k: v:字面直接来写;
#  字符串默认不用加上单引号或者双引号;
#  "":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
#  name:   "zhangsan \n lisi":输出;zhangsan 换行  lisi
#  '':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据
#  name:   ‘zhangsan \n lisi’:输出;zhangsan \n  lisi

2.表示对象、Map(属性和值)(键值对)语法:

k: v:在下一行来写对象的属性和值的关系;注意缩进,对象还是k: v的方式
friends:
        lastName: zhangsan
        age: 20
行内写法:
friends: {lastName: zhangsan,age: 18}

3.表示数组的语法

用- 值表示数组中的一个元素(- 和属性之间空格不能省)
pets:#(数组名)
 - cat#(属性)
 - dog#(属性)
 - pig#(属性)
行内写法
pets: [cat,dog,pig]

写一个间的的将配置文件的值注入到JavaBean中的例子

1.创建一个springboot项目


目录结构

Person类为:

package com.byls.springbootdemo.bean;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * 将配置文件中配置的每一个属性的值,映射到这个组件中
 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定;
 *      prefix = "person":配置文件中哪个下面的所有属性进行一一映射
 *
 * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能;
 *
 */
@Component//将Person类注册到容器中
@ConfigurationProperties(prefix = "person") //绑定配置文件的值
public class Person {
    private String lastName;//名字
    private Integer age;//年龄
    private Boolean boss;//是否是老板
    private Date bir;//生日

    private Map<String,Object> maps;//map集合
    private List<Object> lists;//list集合
    private Dog dog;//Dog类对象  只有name 和 age属性

    public Person() {
    }

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

    public Person(String lastName, Integer age, Boolean boss, Date bir, Map<String, Object> maps, List<Object> lists, Dog dog) {
        this.lastName = lastName;
        this.age = age;
        this.boss = boss;
        this.bir = bir;
        this.maps = maps;
        this.lists = lists;
        this.dog = dog;
    }

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

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

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

    public void setBir(Date bir) {
        this.bir = bir;
    }

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

    public void setLists(List<Object> lists) {
        this.lists = lists;
    }

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

    public String getLastName() {
        return lastName;
    }

    public Integer getAge() {
        return age;
    }

    public Boolean getBoss() {
        return boss;
    }

    public Date getBir() {
        return bir;
    }

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

    public List<Object> getLists() {
        return lists;
    }

    public Dog getDog() {
        return dog;
    }
}

yaml文件:

person:
  lastName: byls
  age: 22
  boss: true
  bir: 2017/12/01
  maps: {k1: v1,k2: v2}
  lists:
    - zs
    - ls
  dog:
    name: baibai
    age: 10

测试类:

package com.byls.springbootdemo;

import com.byls.springbootdemo.bean.Person;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootDemoApplicationTests {
    @Autowired
    private Person person;
    @Test
    public void contextLoads() {
//        Person person = new Person();
        System.out.println(person.toString());
    }
}

先运行springboot主程序类的main方法,在运行测试类,运行结果:


运行结果

可以看出结果和我们在yaml文件中预设的值是一样的,配置文件绑定成功

Ⅲ.springbooot的properties类型配置文件

properties类型配置文件语法和以前并无却别,不多介绍,直接上例子

person.last-name=张三
person.age=12
person.bir=2017/12/01
person.maps.k1=v1
person.maps.k2=v2
person.dog.name=xiaobai
person.dog.age=12
person.lists=a,b,c
person.boss=true

运行:


运行结果

这里出现乱码是因为idea的默认编码格式是utf-8,而application.properties编译时ascii码

调整:


解决乱码

Ⅳ.除了用“@ConfigurationProperties”绑定配置文件外,还可以用“@value”进行绑定

例子

@ConfigurationProperties和@value的对比

@ConfigurationProperties @value
功能 批量注入配置文件中的属性 一个一个注入
松散绑定 支持 不支持
SpEL 不支持 支持
JSR303数据校验 支持 不支持
复杂数据类型封装 支持 不支持
使用场景对比:

如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;
如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使@ConfigurationProperties;

package com.byls.springbootdemo.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;

/**
 *  @Value的一个简单的使用场景例子
 */
@RestController //@ResponseBody和@Controller的结合
public class HelloController {
    @Value("${person.last-name}")//使用@Value从配置文件中取单个值
    private  String name;

    @RequestMapping("/hello")//设置请求路径
    public String hello(){
        return "hello"+name;
    }
}
运行结果

Ⅵ.@PropertySource&@ImportResource和@Bean

前面的@ConfigurationProperties能将实体类和springboot的全局配置文件进行绑定,但实际上我们一个项目不能把所有的配置文件都写在全局配置文件中,所有我们就可以下面几个注解

@PropertySource:加载指定的配置文件:
在resourse文件夹中创建一个person.properties用于存放先前的配置文件并把之前的配置文件注释
Preson类部分代码如下

@PropertySource(value ={"classpath:person.properties"}) //value的值可以是数组
@Component
@ConfigurationProperties(prefix = "person")//这个不能注,注了就会报错
public class Person {

    //    @Value("${person.last-name}")
    private String lastName;
    //    @Value("#{25*5}")
    private Integer age;
    private Boolean boss;
    private Date bir;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
//此处省略**行书体类代码,前面有
}


//利用测试类测试得到结果正常,如下:
Person{lastName='张三', age=12, boss=true, bir=Fri Dec 01 00:00:00 CST 2017, maps={k1=v1, k2=v2}, lists=[a, b, c], dog=Dog{name='xiaobai', age=12}}

@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上
1.创建一个service包并在其中创建一个HelloService类,新建一个spring的配置文件:bean.xml
bean.xml

<?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">

    <!--向spring容器中添加helloService组件-->
    <bean id="helloService" class="com.byls.springbootdemo.service.HelloService"></bean>
</beans>

2.在主函数入口类中加入@ImportResource标签,如果不加bean将注入失败

package com.byls.springbootdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ImportResource;

/**
 * springboot主程序入口类
 */
@ImportResource(locations = {"classpath:bean.xml"})//如果不加bean将注入失败
@SpringBootApplication
public class SpringbootDemoApplication {

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

}

测试类:

package com.byls.springbootdemo;

import com.byls.springbootdemo.bean.Person;
import com.sun.glass.ui.Application;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.junit4.SpringRunner;

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

    @Autowired
    private ApplicationContext ioc; //spring容器对象

    @Test
    public void testHelloService(){
        //判断容器中是否包含某个bean 包含为true 反之为false
        boolean flag = ioc.containsBean("helloService");
        System.out.println(flag);
    }
}

运行测试结果为true,bean注入成功。
不管是哪种注解,用起来都比较繁琐,所以:

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

1.创建配置类(使用@Configuration标签) -------> 相当于是配置文件
2.使用@Bean标签往容器中添加组件

package com.byls.springbootdemo.config;

import com.byls.springbootdemo.service.HelloService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 配置类
 */
@Configuration//指定这是一个配置类,用于替代之前的配置文件
public class MyAppConfig {

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

返回spring主程序类注释掉@ImportResource(locations = {"classpath:bean.xml"})运行测试方法
得到值依然为true,helloService注入成功。(这种方法相比于前面两种会比较简单)

Ⅶ.配置文件的占位符

1.常用的几个随机数

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

2.占位符的使用,在原先的著配置文件中修改如下

      person:
        lastName: 张三${random.int(10)}
        age: ${random.int}
        boss: true
        bir: 2017/12/01
        maps: {k1: v1,k2: v2}
        lists:
          - zs
          - ls
        dog:
          name: ${person.lastName}_dog
          age: 10
#${}中可以是原先预设好的值如:${person.last-name} 也可以是没有预设的值,没有预设的值需要在后面加“ :默认值 ”
#如果不加默认值输出时将原样输出

#运行测试类方法得到数据为:
#Person{lastName='张三4', age=-141504158, boss=true, bir=Fri Dec 01 00:00:00 CST 2017, #maps={k1=v1, k2=v2}, lists=[zs, ls], dog=Dog{name='张三6_dog', age=10}}

Ⅷ.springboot的Profile

简介:一个项目的不同时期需要有不同的配置,比如开发阶段要有开发阶段的配置,测试阶段要有测试阶段的配置那么我们在主配置文件编写的时候,文件名可以是 application-{profile//标识}.properties/yml
默认使用application.properties的配置;

1.多profile表示的properties文件
多profile文件示例
2.yml支持多文档块方式

(测试前要将application.properties配置文件注释掉)

yml支持多文档块方式

几种激活指定profile的方式:
  1、在配置文件中指定 spring.profiles.active=dev
  2、命令行:java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;可以直接在测试的时候,配置传入命令行参数
  3、虚拟机参数-Dspring.profiles.active=dev

Ⅸ.配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/
–file:./
–classpath:/config/
–classpath:/
优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件;互补配置(共同作用,一个文件没有另一个有的会一起都会产生作用);
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

X.springboot的外部配置加载顺序

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指定的默认属性
所有支持的配置加载来源;
参考官方文档

Ⅺ.springboot的自动配置原理(难,重点)

尚硅谷视频讲解传送门
1)、SpringBoot启动的时候加载主配置类,开启了自动配置功能
  @EnableAutoConfiguration
2)、@EnableAutoConfiguration 作用:
 利用EnableAutoConfigurationImportSelector给容器中导入一些组件?
 可以查看selectImports()方法的内容;
 List<String> configurations = getCandidateConfigurations(annotationMetadata,  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.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类都是容器中的一个组件,都加入到容器中;用他们来做自动配置;
3)、每一个自动配置类进行自动配置功能;
4)、以HttpEncodingAutoConfiguration(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   //给容器中添加一个组件,这个组件的某些值需要从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类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfigurartion:自动配置类;
给容器中添加组件
xxxxProperties:封装配置文件中相关属性;

自动配置报告

1、@Conditional派生注解(Spring注解版原生的@Conditional作用)
作用:必须是@Conditional指定的条件成立,才给容器中添加组件,配置配里面的所有内容才生效;
自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
我们可以通过启用 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)

         ***********************************这里还有很多省略了 ***********************************

相关文章

网友评论

      本文标题:springboot的配置文件

      本文链接:https://www.haomeiwen.com/subject/jmiqjqtx.html