二、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推薦給容器中添加組件的方式:使用全注解的方式
- 配置類 ==== 配置文件
- 使用@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
5.3.2命令行:--spring.profiles.active=dev
或者通過maven的package打成jar包,在項目的target目錄下cmd運行jar包:
java -jar springboot-helloworld-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
5.3.2虛擬機參數:-Dspring.profiles.active=dev
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
7、外部配置加載順序
SpringBoot也可以從以下位置加載配置,優先級由高到低;高優先級的配置覆蓋低優先級的配置,所有的配置會形成互補配置
1、命令行參數
java -jar spring-boot-01-config-0.0.1-SNAPSHOT.jar
--server.port=8090 --server.servlet.context-path=/abc
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 {
精髓:
- SpringBoot啟動會加載大量的自動配置類;
- 我們看我們需要的功能有沒有SpringBoot默認寫好的自動配置類;
- 我們再來看這個自動配置類中到底配置了哪些組件(只要有我們要用的組件,我們就不需要再來配置了);
- 給容器中自動配置類添加組件的時候,毀容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)