一、配置文件
SpringBoot使用一个全局的配置文件,配置文件名是固定的:
application.properties
application.yml
配置文件的作用:修改SpringBoot自动配置的默认值,SpringBoot在底层都给我们自动配置好;
YAML配置例子:
server:
port:8081
xml配置:
<server>
<port> 8081</port>
</server>
2、YMAL语法
2.1、基本语法
k:(空格)v 表示一对键值对(空格必须有)
以空格的缩进来控制层级关系:只要是左对齐的一列数据,都是同一个层级的
server:
port: 8081
属性和值都是大小写敏感;
2.2、值的写法
2.2.1、字面量:普通值(数字,字符串,布尔)
k:v ->字面直接来写;
备注:字符串默认不用加上单引号和双引号
""->双引号,会转义字符串里面的特殊字符,特殊字符会作为本身想表达的意思
''->单引号,不会转义特殊字符,特殊字符最终只是一个普通的字符串数据
例子:
test1: "aa \n ba"
test2: 'aa \n ba'
结果:
test1:aa
ba
test2:aa \n ba/
2.2.2、对象,Map
K: V ->对象还是K:V的方法
例子:
friends:
lastName: zhangsan
age: 20
行内写法:(注意:后面加空格)
friends: {lastName: zhangsan,age: 20}
2.2.3、数组(List,Set)
用-值表示数组中的一个元素
例子:注意空格
pets:
- cat
- dog
- pig
行内写法:
pets: {cat,dog,pig}
2.3、配置文件值注入
2.3.1、例子:
YML配置:
person:
lastName: zhangsan //last-name也可以
age: 18
boos: false
birth: 2020/6/18
maps: {k1: v1,k2: v2}
lists:
- list
- zhaoliu
dog:
name: xiaogou
age: 2
properties配置:
person.lastName=zhangsan1
person.age=18
person.boos=true
person.birth=2020/6/18
person.maps.k1=k1
person.maps.k2=k2
person.lists={list,zhaoliu}
person.dog.name=xiaogou
person.dog.age=2
乱码解决:
java:
@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;
我们导入配置文件处理器,以后编写配置就有提示了。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
2.3.2、@Value和@ConfigurationProperties获取值比较
@ConfigurationProperties | @Value | |
功能 | 批量注入配置文件的属性 | 一个个指定 |
松散绑定 | 支持 | 不支持 |
Spel | 不支持 | 支持 |
JSR303数据校验 | 支持 | 不支持 |
复杂类型封装 | 支持 | 不支持 |
配置文件YML还是properties他们都能获取到值;
在某个业务逻辑中需要获取一下配置文件的某项值,使用@Value;
编写一个javaBean来和配置文件映射,使用@Configuration
备注:
松散绑定:配置文件里的参数可以全部大写,或者大写用_代替。person.first-name,PERSON_FIRST_NAME
Spel:表达式,#{11*2}
JSR303校验:@Validated@Email
2.3.3、占位符和随机数
占位符:
可以在配置文件引用前面配置过的属性
${app.name:默认值} 来指定找不到属性时的默认值
随机数:
${random.value},${random.int}...
2.3.4、Profile多文件支持
Profile是Spring对不同环境提供不同配置功能的支持,可以通过激活、指定参数等方法快速切换环境
默认使用application.properties配置。
备注:
a、多Profile文件形式:application-{profile}.properties,例子:application-dev.properties
b、多Profile文档块模式
YML文件使用---区分不同的文件
c、激活方法
命令行:--spring.profiles.action=dev
配置文件:spring.profiles.action=dev
jvm参数:-Dspring.profiles.action=dev
idea激活配置:
2.3.5、 配置加载顺序
springboot启动会扫描以下位置的application.properties或者application.yml文件作为SpringBoot的默认配置文件:
-file:./config/ 当前项目的根目录下的config目录
-file:/ 当前项目的根目录下的
-classpath:/config/ 项目配置文件目录下的config目录
-classpath:/ 项目配置文件目录
优先级由高到低,高优先级的配置会覆盖优先级的配置。
SpringBoot会从这四个位置全部加载主配置文件;互补配置。
我们还可以通过spring.config.location来改变默认的配置文件位置
项目打包以后。我们可以使用命令参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默认
加载这些配置文件共同起作用形成互补配置。
2.3.6、外部配置文件的加载顺序
SpringBoot也可以从以下位置加载配置:优先级从高到低
1.命令行参数
2.来自java:comp/env属性
3.java系统属性(System.getProperties)
4.操作系统环境变量
5.RandomValuePropertySource配置的random.*属性
6.jar包外部的application-{profile}.properties或者application.yml(带spring.profile)配置文件
7.jar包内部的application-{profile}.properties或者application.yml(带spring.profile)配置文件
8.jar包外部的application.properties或者application.yml(不带spring.profile)配置文件
9.jar包内部的application.properties或者application.yml(不带spring.profile)配置文件
10.@Configuration注解类上的@PropertiesSource
11.通过SpringApplication.setDefaultProperties指定的默认属性
2.3.7、自动配置原理
自动配置原理:
备注:以下是2.3.0版本代码逻辑
2.3.7.1、SpringBoot启动的时候加载主配置类
开启了自动配置功能@EnableAutoConfiguration
2.3.7.2、@EnableAutoConfiguration作用:
*利用AutoConfigurationImportSelector给容器导入一些组件,
*可以插件selectImports()方法的内容:
* List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取候选的配置
SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
扫描所有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.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类都是容器中的一个组件,都加入到容器中,用他们来做自动配置;
2.3.7.3 、每一个自动配置类进行自动配置功能
2.3.7.4、以HttpEncodingAutoConfiguration(HTTP编码自动配置)为例解释自动配置原理
//表示这是一个配置类,以前编写的配置文件一样,也可以给容器添加组件
@Configuration(proxyBeanMethods = false)
//启动指定类的ConfigurationProperties功能;将配置文件中对应的值和ServerProperties绑定起来
//并ServerProperties加入到ioc容器中。
@EnableConfigurationProperties(ServerProperties.class)
//spring底层@Condition注解,满足指定条件,整个配置类里面的配置就会生效
//判断当前应用是否是web应用,如果是,当前配置生效
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
//判断当前项目有没有这个类CharacterEncodingFilter,这个类是springMvc中进行乱码解决的过滤器
@ConditionalOnClass(CharacterEncodingFilter.class)
//从配置文件中获取指定的值和bean的属性进行绑定
//判断当前配置文件中是否存在某个值,server.servlet.encoding,如果不存在,判断也是成立的
//即使我们配置文件中不配置server.servlet.encoding,也是默认生效的;
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
//配置文件属性值,我们能配置的属性都是来源于这个功能的properties类
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(Encoding.Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
return filter;
}
}
根据当前不同的条件判断,决定这个配置类是否生效。
一旦这个配置类生效;这个配置类就会给容器添加各种组件,这些组件的属性是从对应的properties类中获取的,
这些类里面的每一个属性又是和配置文件绑定的;
2.3.7.5、封装类
所有在配置文件中能配置的属性都是在xxxProperties类的封装者;
配置文件能配置什么就可以参照某个功能对应的这个属性类
@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {
}
2.3.7.6、精髓
a、SpringBoot启动会加载大量的自动配置类
b、我们看需要的功能有没有SpringBoot默认写好的自动配置类
c、我们再来看这个自动配置类中到底配置了那些组件;(只要我们要用的组件有,就不需要配置了)
d、给容器中自动配置类添加组件的时候,会从properties类中获取某些属性,我们就可以在配置文件中
指定这些属性的值;
xxxAutoConfiguration:自动配置类,给容器中添加组件
xxxProperties封装配置文件中相关属性;