Spring Boot的配置文件

1.全局配置文件

Spring Boot時，很多啓動所需要的配置在底層都爲我們默認配置好了，但是如果我們有對默認配置不滿意的地方，我們就需要修改配置文件。在類路徑下會有一個application.properties或application.yml文件，這兩個文件都會被Spring Boot當做全局配置文件。

全局配置文件名字是固定的都是application，只是後綴有.properties和.yml
位置：src/main/resources目錄或者類路徑/config下。
作用：修改Spring Boot自動配置的默認值。

2.yml介紹

以前的配置文件大多采用.xml的文件。YML(YAML Ain’t Markup Language)屬於一種比較新型的文件，以數據爲中心，比json、xml等更適合做配置文件。 另外Spring Boot使用 snakeyaml 解析yml文件。

比較一下爲服務器更換端口號的寫法：

<server>
	<port>8081<port>
</server>

server:
  port: 8081

可以明顯的看到第二種yml版的比第一種xml版的更加簡潔。

2.1yml基本語法

k:(空格)v：表示一對鍵值對。

以空格的縮進來控制層級關係，只要是左邊對齊的一列數據，都是同一個層級的。
屬性和值大小寫敏感。

server:
  port: 8181
  path: /hello

2.1.1字面量

k：v

數字、字符串、布爾、日期直接寫
字符串：默認不使用引號，可以使用單引號或者雙引號，單引號原樣輸出，雙引號會對特殊字符進行轉義。字符串可以寫成多行，從第二行開始，必須有一個單空格縮進。換行符會被轉爲空格。

2.1.2對象(Map)

對象的一組鍵值對和Map類似，使用冒號分隔。如：username: admin。

普通寫法

friends:
   name: zhangsan
   age: 20

行內寫法

friends: {name: lisi,age: 19}

2.1.3數組(list、set)

連詞線（-）開頭的行，構成一個數組，[]爲行內寫法。

普通寫法

# 相當於var pets = [ 'cat','dog','pig'];
pets:
 - cat
 - dog
 - pig

行內寫法

pets: [cat,dog,pig]

3.配置文件值注入

JavaBean組件

@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean boss;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
	//省略setter、getter與toString方法
}

yml配置文件

person:
  name: 張三
  age: 18
  boss: false
  birth: 2020/1/13
  maps: {k1: v1,k2: v2}
  lists:
    - 李四
    - 王五
  dog:
    name: 旺旺
    age: 2

properties配置文件

person.name=張三
person.age=18
person.birth=2020/12/12
person.boss=false
person.maps.k1=v1
person.maps.k2=15
person.lists=a,b,c
person.dog.name=大黃
person.dog.age=3

想要使上面yml或properties中組件中的屬性和配置中的值一一綁定，需要在組件JavaBean中使用@ConfigurationProperties(prefix = "person")註解。

@ConfigurationProperties註解：告訴SpringBoot將本類中的所有屬性和配置文件中相關的配置進行綁定,前提必須是容器中的組件。即需要先使用@Component將JavaBean加入到IoC容器中。

綁定時導入配置文件處理器，這樣以後編寫yml文件就有提示了：

	     <!--導入配置文件處理器-->
	      <dependency>
	          <groupId>org.springframework.boot</groupId>
	          <artifactId>spring-boot-configuration-processor</artifactId>
	          <optional>true</optional>
	      </dependency>

3.1配置properties配置文件時的編碼問題

IDEA默認使用UTF-8編碼，properties使用的是ASCII碼，需要進行，編碼轉換：

3.2@ConfigurationProperties與@Value的區別

@Value的寫法

    @Value("${person.name}")
    private String name;
    @Value("#{11*2}")
    private Integer age;
    @Value("true")
    private Boolean boss;

兩者比較	@ConfigurationProperties	@Value
功能	批量注入配配置文件中的屬性	一個個指定
鬆散綁定(鬆散語法)	支持	不支持
SpEL	不支持	支持
JSR303數據校驗	支持（需要添加@Validated註解）	不支持
複雜類型封裝	支持	不支持

取捨問題：如果我們只是在某個業務邏輯中需要獲取一下配置文件中的某項值，使用@Value。如下

@RestController
public class HelloController {
    @Value("${person.name}")
    private String name;

    @RequestMapping("/say")
    public String sayHello() {
        return "Hello " + name;
    }
}

而如果專門寫了一個JavaBean來和配置文件進行映射，使用@ConfigurationProperties。

3.3@PropertySource和@ImportResource

@PropertySource：加載指定的配置文件。

@ConfigurationProperties(prefix = "person")默認加載的是全局配置文件，使用@PropertySource(value = {"classpath:person.properties"})可以加載指定配置文件。

@ImportResource：導入Spring的配置文件，讓配置文件生效。

Spring Boot中默認沒有Spring的配置文件，想讓Spring配置生效，需要使用此註解將Spring配置加載進來。
@ImportResource(locations = {"classpath:beans.xml"})

Spring Boot推薦的爲容器中添加組件的方式是下面的全全註解的方式。

@Configuration
public class MyAppConfig {

    @Bean
    public HelloService helloService(){
        return new HelloService();
    }
}

4.配置文件隨機數和佔位符

配置文件中可以使用隨機數：
${random.value}、${random.int}、${random.long}、${random.int(10)}、${random.int[1024,65546]}

佔位符獲取之前配置的值，如果沒有可以使用默認值。

person.name=張三${random.uuid}
person.age=${random.int}
person.birth=2020/12/12
person.boss=false
person.maps.k1=v1
person.maps.k2=15
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=3

5.Profile

Profile是Spring用來做多環境支持的。可以通過激活、指定參數等方式快速切換環境。

5.1多profile形式

在主配置文件編寫時，使用帶這樣的文件名：application-dev.properties、application-prod.properties，可以實現動態的切換環境。

當有多個主配置文件時，默認加載application.properties。

5.2多profile文檔塊模式

server:
  port: 8081
spring:
  profiles:
    active: dev
---
server:
  port: 8082
spring:
  profiles: dev
---
server:
  port: 8083
spring:
  profiles: pro

5.3激活方式

(1)配置文件激活
使用spring.profiles.active=dev的方式進行激活。

(2)命令行激活
使用：--spring.profiles.active=dev

除了上述使用IDEA可視化工具來運行，還可以將項目打包成jar，使用java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profoles.active=dev運行jar包的方式。

(3)JVM參數

虛擬機參數：–Dspring.profiles.active=dev。

6.配置文件加載位置與順序

springboot啓動會掃描以下位置的application.properties或application.yml文件作爲Spring Boot 的默認配置文件。
-file:./config/
-file:./
-classpath:/config/
-classpath:/
優先級由高到低，高優先級的配置會覆蓋低優先級的配置。
Spring Boot會從這四個位置全部加載主配置文件，且互補配置。

除了應用內部，SpringBoot也可以從以下位置加載配置，優先級從高到低，高優先級的配置覆蓋低優先級的配置，所有的配置會形成互補。

（1）命令行參數。
（2）來自java:comp/env的jndl屬性。
（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註解類上的@PropertySource。
（11）通過SpringApplication.setDefaultProperties指定的默認屬性。

7.自動配置原理☆

①SpringBoot啓動時會默認加載大量的自動配置類。
**②這些自動配置類中如果沒有我們需要的組件，就需要在配置文件中指定這些屬性的值。
③給容器中自動配置類添加組件時，會從properties類中獲取某些屬性。我們可以在配置文件中指定這些屬性的值。

SpringBoot啓動時，加載主配置類，開啓了自動配置功能。@EnableAutoConfiguration註解的作用：利用@EnableAutoConfigurationImportSelector(選擇器)爲容器導入一些組件。

List<String> 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.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都是容器中的一個組件，用他們來做自動配置。

以HttpEncodingAutoConfiguration爲例解釋自動配置原理：

@Configuration	//表示這是一個配置類,可以給容器中添加組件.

@EnableConfigurationProperties(HttpEncodingProperties.class)//啓用指定類的EnableConfigurationProperties功能;
//將配置文件和對應的HttpEncodingAutoConfiguration綁定起來，並把HttpEncodingProperties加到IoC容器中

@ConditionalOnWebApplication//判斷當前配置類是否是web應用,true(生效),false(不生效)

@ConditionalOnClass(CharacterEncodingFilter.class)//判斷當前項目有沒有這個類;
//CharacterEncodingFilter是SpringMVC中進行亂碼解決的過濾器.

@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)//判斷配置文件中是否存在某個配置spring.http.encoding.enabled;
//如果不存在,判斷也是成立的.即使我們配置文件中不配置spring.http.encoding.enable=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;
	}

根據不同的條件判斷，決定這個配置類是否生效。一旦配置類生效，這個配置類就會爲IoC容器中添加各種組件，這些組件的屬性是從對應的properties類中獲取的，這些類裏面的屬性又是和配置文件綁定的。所以我們能夠手動配置的屬性都是來自於某功能的properties類。

8.@Conditional註解和自動配置報告

8.1@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存在指定項

8.2自動配置報告

自動配置類必須在一定條件下才生效，如何才能知道哪些自動配置類生效哪些不生效呢？

可以在全局配置properties文件中通過debug=true屬性，來讓控制檯打印自動配置報告。

通過這個屬性，我們可以很方便的看到哪些自動配置啓用了，哪些自動配置未啓用。

Spring Boot |超詳細的SpringBoot配置及原理

文章目錄

Spring Boot的配置文件

1.全局配置文件

2.yml介紹

2.1yml基本語法

2.1.1字面量

2.1.2對象(Map)

2.1.3數組(list、set)

3.配置文件值注入

3.1配置properties配置文件時的編碼問題

3.2@ConfigurationProperties與@Value的區別

3.3@PropertySource和@ImportResource

4.配置文件隨機數和佔位符

5.Profile

5.1多profile形式

5.2多profile文檔塊模式

5.3激活方式

6.配置文件加載位置與順序

7.自動配置原理☆

8.@Conditional註解和自動配置報告

8.1@Conditional派生註解

8.2自動配置報告

985 碩士程序員，空窗 4 個月沒有 Offer！

一文搞懂 Spring 循環依賴

賽博鬥地主——使用大語言模型扮演Agent智能體玩牌類遊戲。

VScode右鍵打開(添加到右鍵)

記一次 .NET某工控視覺自動化系統卡死分析

Linux之JavaEE環境搭建 |JDK安裝 |Tomcat安裝 |Eclipse安裝 |MySQL安裝

Linux |網絡配置 |進程管理 |服務管理

Linux |定時任務調度 |磁盤分區和掛載

Linux |組管理與權限管理

碼住! 超實用的Linux指令大全

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結