Spring boot 配置文件,配置注解详解 (properties 和yml )

从其他框架来看 我们都有自己的配置文件, hibernate有hbm,mybatis 有properties, 同样, Spring boot 也有全局配置文件。

Springboot使用一个全局的配置文件,而且配置文件的名字是固定的。 有两种

  • application.properties
  • application.yml 

springboot 配置文件的作用是用来 修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好; 像我们Tomcat 启动 默认配置端口是8080 . 如果要修改, 我们就在这两个文件的一种中来修改,

  • YML (也叫YAML :  YAM Ain't  Markup Language)

      YAML Ain't Markup Language 这是一个递归写法 ;

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

标记语言: 

   我们以前用的配置文件,大多都使用 xxxx.xml  文件 ;

 YAML  : 是一种以数据为中心的配置文件, 比json,xml  等更适合做配置文件 

举个栗子:

1以 修改端口为例 : 2 3yml : 4 5server: 6 port: 8081 7 8xml : 9<server> 10 <port>8081</port> 11</server> xml 配置 将太多的浪费在了标签上面。

 yml 基本语法:

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

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

1server: 2 port: 8081 3 path: /hello属性和值也是大小写敏感;

值的写法: 

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

 k: v:字面直接来写;

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

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

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

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

name:   ‘zhangsan \n lisi’:输出;zhangsan \n  lisi
  • 对象、Map(属性和值)(键值对):

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

​        对象还是k: v的方式

1friends: 2 lastName: zhangsan 3 age: 20 4行内写法: 5 6friends: {lastName: zhangsan,age: 18}
  •   数组(List、Set):

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

1pets: 2 - cat 3 - dog 4 - pig行内写法pets: [cat,dog,pig]
  •   配置文件注入

javaBean :

可以导入配置文件处理器依赖,以后编写配置就会有代码提示;

代码展示配置文件注入属性值 : 

1 1 package com.example.webservice.bean; 2 2 3 3 import org.springframework.boot.context.properties.ConfigurationProperties; 4 4 import org.springframework.stereotype.Component; 5 5 6 6 import java.util.Date; 7 7 import java.util.List; 8 8 import java.util.Map; 9 9 1010 /** 1111 * 1212 * ConfigurationProperties(prefix ="person") 将本类中的所有属性和配置文件中的相关配置进行绑定 1313 * prefix ="person 表示对哪个文件进行绑定 1414 * Component 表示这是一个容器, 只有在容器中 ConfigurationProperties 才能使用 1515 */ 1616 @Component 1717 @ConfigurationProperties(prefix = "person") 1818 public class Person { 1919 2020 private String name; 2121 private Integer age; 2222 private boolean man; 2323 private Date birth; 2424 private Map<String,Object>map; 2525 private List<Object>list ; 2626 private Son son ; 2727 2828 .....省略get/set 以及toString 方法 2929 3030 } 3131 3232 3333 package com.example.webservice.bean; 3434 3535 public class Son { 3636 3737 private String name; 3838 private Integer age ; 3939 4040 public String getName() { 4141 return name; 4242 } 4343 4444 public Integer getAge() { 4545 return age; 4646 } 4747 4848 public void setName(String name) { 4949 this.name = name; 5050 } 5151 5252 public void setAge(Integer age) { 5353 this.age = age; 5454 } 5555 5656 @Override 5757 public String toString() { 5858 return "Son{" + "name='" + name + '\'' + ", age=" + age + '}'; 5959 } 6060 } 6161 6262 6363 properties文件绑定的写法 6464 #注释方法 Ctrl + / 6565 person.name=爸爸 6666 person.age=45 6767 person.man=true 6868 person.birth=2019/8/8 6969 person.map.k1=h1 7070 person.map.k2=h2 7171 person.list=a,1,son 7272 person.son.name=儿子 7373 person.son,age=20 7474 7575 7676 yml 文件绑定的写法: 7777 7878 person: 7979 name: 爸爸 8080 age: 25 8181 birth: 2018/2/8 8282 man: true 8383 list: 8484 - a 8585 - 2 8686 - son 8787 map: {key1:value1,key2:value2} 8888 son: 8989 name: 儿子 9090 age: 5测试类 : 在我们的test 文件夹下 : 91 92package com.example.webservice;import com.example.webservice.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)@SpringBootTestpublic class WebserviceApplicationTests { @Autowired Person person; @Test public void contextLoads() { // 直接运行这个方法 ,而不是运行整个程序 System.out.println(person); System.out.println("********************************************************"); }

 控制台打印结果 (使用的 yml 配置文件)

properties配置文件在idea中默认utf-8可能会乱码 。因为spring properties  默认是ASCII 码 ,所以需要将properties  默认编码改为UTP-8 ,再√上旁边的 将其运行时转换为ASCII码;再输入中文就好了

都改成utf-8 ,再输入中文就好了。

  • @Value获取值和@ConfigurationProperties获取值比较

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

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

  •  配置文件注入值数据校验

    @Component @ConfigurationProperties(prefix = "person") @Validated public class Person {

    1/** 2 * <bean class="Person"> 3 * <property name="name" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property> 4 * <bean/> 5 */

    //name必须是邮箱格式 @Email //@Value("${person.name}") private String name; //@Value("#{11*2}") private Integer age; //@Value("true") private Boolean boss;

    1private Date birth; 2private Map<String,Object> maps; 3private List<Object> lists; 4private Dog dog;

    。。。。。get/set /toString

  •  @PropertySource&@ImportResource&@Bean

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

1/** 2 * 将配置文件中配置的每一个属性的值,映射到这个组件中 3 * @ConfigurationProperties:告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定; 4 * prefix = "person":配置文件中哪个下面的所有属性进行一一映射 5 * 6 * 只有这个组件是容器中的组件,才能容器提供的@ConfigurationProperties功能; 7 * @ConfigurationProperties(prefix = "person")默认从全局配置文件中获取值; 8 * 9 */ 10@PropertySource(value = {"classpath:person.properties"}) 11@Component 12@ConfigurationProperties(prefix = "person") 13//@Validated 14public class Person { 15 16 /** 17 * <bean class="Person"> 18 * <property name="name" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property> 19 * <bean/> 20 */ 21 22 //name必须是邮箱格式 23 // @Email 24 //@Value("${person.name}") 25 private String name; 26 //@Value("#{11*2}") 27 private Integer age; 28 //@Value("true") 29 private Boolean boss; 30 31```
  •  @ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;

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

    想让Spring的配置文件生效,加载进来;就要将 @ImportResource 标注在一个配置类上

    @ImportResource(locations = {"classpath:beans.xml"})//类路径上添加配置类的路径 导入Spring的配置文件让其生效 不来编写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="com.example.webservice.controller.Hello"></bean> </beans>

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

    1、配置类**@Configuration**------>Spring配置文件

    2、使用@Bean给容器中添加组件 /**

    • @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
    • 在配置文件中用<bean><bean/>标签添加组件

    */ @Configuration public class MyAppConfig {

    1//将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名 2@Bean 3public HelloService helloService02(){ 4 System.out.println("配置类@Bean给容器中添加组件了..."); 5 return new HelloService(); 6}

    }

  • 配置文件占位符

 1、随机数

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

 2、占位符获取之前配置的值,如果没有可以是用:指定默认值

1 1 properties 2 2 person.name=张三${random.uuid} 3 3 person.age=${random.int} 4 4 person.birth=2017/12/15 5 5 person.boss=false 6 6 person.maps.k1=v1 7 7 person.maps.k2=14 8 8 person.lists=a,b,c 9 10// 如果没有hello这个属性, 则会直接输出 11 12${person.hello} , 如果加了 13 14${person.hello:hello}_dog 则会直接赋值 输出 15 16hello_dog 17 18 9 person.dog.name=${person.hello:hello}_dog 10 person.dog.age=15

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

所以我们在然后在application.properties配置文件中 激活自定义的环境配置文件就可以了从application.properties 加载到application-dev.properties 文件了

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

 2、yml支持多文档块方式

1 1 server: 2 2 port: 8081 3 3 spring: 4 4 profiles: 5 5 active: prod 表示当前激活使用哪个环境 --- 表示环境的分割 ,分成不同的文档块。 6 6 --- 7 7 server: 8 8 port: 8083 9 9 spring: 1010 profiles: dev 1111 --- 1212 server: 1313 port: 8084 1414 spring: 1515 profiles: prod #指定属于哪个环境

4、激活指定profile
​    1、在配置文件中指定  spring.profiles.active=dev
​    2、命令行:
​        java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev;
​        可以直接在测试的时候,配置传入命令行参数 ,打包好的项目运行的时候指定我们的环境:

​    3、虚拟机参数; 在运行的时候 选择Editor configrations

  -Dspring.profiles.active=dev    

5、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件
–file:./config/     文件路径config目录--->最高优先级
–file:./       文件路径根目录--->其次
–classpath:/config/ 类路径config目录--->再其次
–classpath:/     类路径根目录--->最低优先级

优先级由高到底,高优先级的配置会覆盖低优先级的配置;
SpringBoot会从这四个位置全部加载主配置文件:互补配置;
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认加载的这些配置文件共同起作用形成互补配置;
 进入命令行 :

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties(properties的硬盘文件目录)

6、外部配置加载顺序
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

7.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

8.jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

再来加载不带profile

9.jar包外部的application.properties或application.yml(不带spring.profile)配置文件

10.jar包内部的application.properties或application.yml(不带spring.profile)配置文件

11.@Configuration注解类上的@PropertySource

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

所有支持的配置加载来源;

[参考官方文档]

  • 自动配置原理

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

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

 1、**自动配置原理:

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的值加入到了容器中;

1```properties 2# Auto Configure 3org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 4org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ 5org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\ 6org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\ 7org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\ 8org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\ 9org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\ 10org.springframework.boot.autoconfigure.cloud.CloudAutoConfiguration,\ 11org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\ 12org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\ 13org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\ 14org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\ 15org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\ 16org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\ 17org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\ 18org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\ 19org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\ 20org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\ 21org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\ 22org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\ 23org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\ 24org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,\ 25org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\ 26org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\ 27org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\ 28org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,\ 29org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\ 30org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\ 31org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\ 32org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\ 33org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\ 34org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\ 35org.springframework.boot.autoconfigure.elasticsearch.jest.JestAutoConfiguration,\ 36org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\ 37org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,\ 38org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,\ 39org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\ 40org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,\ 41org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,\ 42org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,\ 43org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,\ 44org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,\ 45org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\ 46org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\ 47org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,\ 48org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,\ 49org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\ 50org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,\ 51org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\ 52org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\ 53org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\ 54org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\ 55org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\ 56org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\ 57org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,\ 58org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\ 59org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\ 60org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,\ 61org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,\ 62org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\ 63org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,\ 64org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,\ 65org.springframework.boot.autoconfigure.mobile.DeviceResolverAutoConfiguration,\ 66org.springframework.boot.autoconfigure.mobile.DeviceDelegatingViewResolverAutoConfiguration,\ 67org.springframework.boot.autoconfigure.mobile.SitePreferenceAutoConfiguration,\ 68org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,\ 69org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\ 70org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\ 71org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\ 72org.springframework.boot.autoconfigure.reactor.ReactorAutoConfiguration,\ 73org.springframework.boot.autoconfigure.security.SecurityAutoConfiguration,\ 74org.springframework.boot.autoconfigure.security.SecurityFilterAutoConfiguration,\ 75org.springframework.boot.autoconfigure.security.FallbackWebSecurityAutoConfiguration,\ 76org.springframework.boot.autoconfigure.security.oauth2.OAuth2AutoConfiguration,\ 77org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\ 78org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\ 79org.springframework.boot.autoconfigure.social.SocialWebAutoConfiguration,\ 80org.springframework.boot.autoconfigure.social.FacebookAutoConfiguration,\ 81org.springframework.boot.autoconfigure.social.LinkedInAutoConfiguration,\ 82org.springframework.boot.autoconfigure.social.TwitterAutoConfiguration,\ 83org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\ 84org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\ 85org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,\ 86org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,\ 87org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,\ 88org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration,\ 89org.springframework.boot.autoconfigure.web.EmbeddedServletContainerAutoConfiguration,\ 90org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration,\ 91org.springframework.boot.autoconfigure.web.HttpEncodingAutoConfiguration,\ 92org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration,\ 93org.springframework.boot.autoconfigure.web.MultipartAutoConfiguration,\ 94org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration,\ 95org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration,\ 96org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration,\ 97org.springframework.boot.autoconfigure.websocket.WebSocketAutoConfiguration,\ 98org.springframework.boot.autoconfigure.websocket.WebSocketMessagingAutoConfiguration,\ 99org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration 100```

View Code

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

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

4)、以HttpEncodingAutoConfiguration(Http编码自动配置)**为例解释自动配置原理;

1@Configuration //表示这是一个配置类,以前编写的配置文件一样,也可以给容器中添加组件 2@EnableConfigurationProperties(HttpEncodingProperties.class) //启动指定类的ConfigurationProperties功能;将配置文件中对应的值和HttpEncodingProperties绑定起来;并把HttpEncodingProperties加入到ioc容器中 3 4@ConditionalOnWebApplication //Spring底层@Conditional注解(Spring注解版),根据不同的条件,如果满足指定的条件,整个配置类里面的配置就会生效; 判断当前应用是否是web应用,如果是,当前配置类生效 5 6@ConditionalOnClass(CharacterEncodingFilter.class) //判断当前项目有没有这个类CharacterEncodingFilter;SpringMVC中进行乱码解决的过滤器; 7 8@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true) //判断配置文件中是否存在某个配置 spring.http.encoding.enabled;如果不存在,判断也是成立的 9//即使我们配置文件中不配置pring.http.encoding.enabled=true,也是默认生效的; 10public class HttpEncodingAutoConfiguration { 11 12 //他已经和SpringBoot的配置文件映射了 13 private final HttpEncodingProperties properties; 14 15 //只有一个有参构造器的情况下,参数的值就会从容器中拿 16 public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) { 17 this.properties = properties; 18 } 19 20 @Bean //给容器中添加一个组件,这个组件的某些值需要从properties中获取 21 @ConditionalOnMissingBean(CharacterEncodingFilter.class) //判断容器没有这个组件? 22 public CharacterEncodingFilter characterEncodingFilter() { 23 CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter(); 24 filter.setEncoding(this.properties.getCharset().name()); 25 filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST)); 26 filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE)); 27 return filter; 28 } 29```

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

一但这个配置类生效;这个配置类就会给容器中添加各种组件;这些组件的属性是从对应的properties类中获取的,这些类里面的每一个属性又是和配置文件绑定的;
5)、所有在配置文件中能配置的属性都是在xxxxProperties类中封装者‘;配置文件能配置什么就可以参照某个功能对应的这个属性类

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

​   1)、SpringBoot启动会加载大量的自动配置类**

​   2)、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类;**

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

​   4)、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值;
xxxxAutoConfigurartion:自动配置类;
给容器中添加组件
xxxxProperties:封装配置文件中相关属性;

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环境            

@ConditionalOnNotWebApplication

 当前不是web环境    

@ConditionalOnJndi         

JNDI存在指定项     

              

自动配置类必须在一定的条件下才能生效;
我们怎么知道哪些自动配置类生效;
我们可以通过启用  debug=true属性;来让控制台打印自动配置报告==**,这样我们就可以很方便的知道哪些自动配置类生效;

1 1 ========================= 2 2 AUTO-CONFIGURATION REPORT 3 3 ========================= 4 4 Positive matches:(自动配置类启用的) 5 5 ----------------- 6 6 DispatcherServletAutoConfiguration matched: 7 7 - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition) 8 8 - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition) 9 9 1010 Negative matches:(没有启动,没有匹配成功的自动配置类) 1111 ----------------- 1212 ActiveMQAutoConfiguration: 1313 Did not match: 1414 - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition) 1515 AopAutoConfiguration: 1616 Did not match: 1717 - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)
点赞
收藏

评论区

加载中...

相关推荐

MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1

文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s

Oracle 分组与拼接字符串同时使用

SELECTT.,ROWNUMIDFROM(SELECTT.EMPLID,T.NAME,T.BU,T.REALDEPART,T.FORMATDATE,SUM(T.S0)S0,MAX(UPDATETIME)CREATETIME,LISTAGG(TOCHAR(

手写Java HashMap源码

HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22

springcloud的配置文件的读取顺序

SpringBoot默认支持properties和YAML两种格式的配置文件。前者格式简单,但是只支持键值对。如果需要表达列表,最好使用YAML格式。SpringBoot支持自动加载约定名称的配置文件,例如application.yml。如果是自定义名称的配置文件,就要另找方法了。可惜的是,不像前者有@PropertySource这样方便的加载方式,

2020年前端实用代码段,为你的工作保驾护航

有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )

Twitter的分布式自增ID算法snowflake (Java版)

概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移