springBoot配置文件

時間  2021-08-14
標籤 html java web spring json 數組 springboot app dom elasticsearch 欄目 Spring 简体版
原文   原文鏈接

1、配置文件

SpringBoot使用一個全局的配置文件，配置文件名是固定的(有兩種形式)；html

  • application.propertiesjava

  • application.ymlweb

配置文件的做用：修改SpringBoot自動配置的默認值；(SpringBoot在底層都給咱們自動配置好了)spring

YAML（YAML Ain't Markup Language） YAML A Markup Language：是一個標記語言json

YAML：以數據爲中心，比json、xml等更適合作配置文件；數組

之前的配置文件；大多都使用的是 xxxx.xml文件；eg:springboot

YAML：配置例子app

server:
 port: 8080
​

XML例子：dom

<server>
 <port>8080</port>
</server>

二、YAML語法：

一、基本語法

k:(空格)v：表示一對鍵值對（空格必須有）；elasticsearch

以空格的縮進來控制層級關係；只要是左對齊的一列數據，都是同一個層級的

server:
 port: 8080
 path: /hello
​

屬性和值是大小寫敏感的；

二、值的寫法

字面量：普通的值（數字，字符串，布爾）

k: v：字面直接來寫；

字符串默認不用加上單引號或者雙引號；

""：雙引號；不會轉義字符串裏面的特殊字符；特殊字符會做爲自己想表示的意思name: "zhangsan \n lisi"：輸出；zhangsan 換行 lisi

''：單引號；會轉義特殊字符，特殊字符最終只是一個普通的字符串數據

name: ‘zhangsan \n lisi’：輸出；zhangsan \n lisi

對象、Map（屬性和值）（鍵值對）：

k: v

：在下一行來寫對象的屬性和值的關係；注意縮進

對象仍是k: v的方式

friends:
 lastName: zhangsan
 age: 20

行內寫法：

friends: {lastName: zhangsan,age: 20}
數組（List、Set）：

用-值表示數組中的一個元素

pets:
 ‐ cat
 ‐ dog
 ‐ pig

行內寫法

pets: [cat,dog,pig]

3、配置文件值注入

3.一、配置文件:

person:
 lastName: hello
 age: 18
 boss: false
 birth: 2017/12/12
 maps: {k1: v1,k2: 12}
 lists:
  ‐ lisi
  ‐ zhaoliu
 dog:
  name: 小狗
  age: 12

3.二、javaBean：

/**
* 將配置文件中配置的每個屬性的值，映射到這個組件中
* @ConfigurationProperties：告訴SpringBoot將本類中的全部屬性和配置文件中相關的配置進行綁定；
* prefix = "person"：配置文件中哪一個下面的全部屬性進行一一映射
*
* 只有這個組件是容器中的組件，才能使用容器提供的@ConfigurationProperties功能；
*
*/
@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>

3.三、配置文件注入值數據校驗

 @Component
 @ConfigurationProperties(prefix = "person")
 @Validated
 public class Person {
   /**
     * <bean class="Person">
     * <property name="lastName" 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;
   private Map<String,Object> maps;
   private List<Object> lists;
   private Dog dog;
 }

3.4、@PropertySource&@ImportResource&@Bean

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

/**
* 將配置文件中配置的每個屬性的值，映射到這個組件中
* @ConfigurationProperties：告訴SpringBoot將本類中的全部屬性和配置文件中相關的配置進行綁定；
* prefix = "person"：配置文件中哪一個下面的全部屬性進行一一映射
*
* 只有這個組件是容器中的組件，才能容器提供的@ConfigurationProperties功能；
* @ConfigurationProperties(prefix = "person")默認從全局配置文件中獲取值；
*
*/
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
   /**
   * <bean class="Person">
   * <property name="lastName" 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;
}

@ImportResource：導入Spring的配置文件，讓配置文件裏面的內容生效；

Spring Boot裏面沒有Spring的配置文件，咱們本身編寫的配置文件，也不能自動識別； 想讓Spring

的配置文件生效，加載進來；須要將@ImportResource標註在一個配置類上，導入Spring的配置文件讓其生效

@ImportResource(locations = {"classpath:beans.xml"})

自定義的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.mmren.springboot.service.HelloService"></bean>
</beans>

SpringBoot推薦給容器中添加組件的方式；推薦使用全註解的方式

  1. 配置類@Configuration------>Spring配置文件

  2. 使用@Bean給容器中添加組件

    /**
    * @Configuration：指明當前類是一個配置類；就是來替代以前的Spring配置文件
    * 在配置文件中用<bean><bean/>標籤添加組件
    */
    @Configuration
       public class MyAppConfig {
       //將方法的返回值添加到容器中；容器中這個組件默認的id就是方法名
       @Bean
       public HelloService helloService02(){
       System.out.println("配置類@Bean給容器中添加組件了...");
       return new HelloService();
       }
    }
    ​

3.5、配置文件佔位符

1、隨機數

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

2、佔位符獲取以前配置的值，若是沒有能夠是用 : 指定默認值

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

3.六、Profile

3.6.一、多Profile文件

咱們在主配置文件編寫的時候，文件名能夠是 application-{profile}.properties/yml

默認使用application.properties的配置；

3.6.二、yml支持多文檔塊方式
server:
 port: 8081
spring:
 profiles:
 active: prod
‐‐‐
server:
 port: 8083
spring:
 profiles: dev
‐‐‐
server:
 port: 8084
 spring:
profiles: prod #指定屬於哪一個環境
​
​
3.6.三、激活指定profile

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

二、命令行：

java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev； 能夠直接在測試的時候，配置傳入命令行參數

三、虛擬機參數；

-Dspring.profiles.active=dev

3.七、配置文件加載位置

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

3.八、外部配置加載順序

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

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

  2. jar包內部的application-{profile}.properties或application.yml(帶spring.profile)配置文件

再來加載不帶profile

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

  2. jar包內部的application.properties或application.yml(不帶spring.profile)配置文件

10.@Configuration註解類上的@PropertySource

11.經過SpringApplication.setDefaultProperties指定的默認屬性全部支持的配置加載來源；

參考官方文檔

3.九、自動配置原理

配置文件到底能寫什麼？怎麼寫？自動配置原理； 配置文件能配置的屬性參照

3.9.一、自動配置原理：

1）、SpringBoot啓動的時候加載主配置類，開啓了自動配置功能 @EnableAutoConfiguration

2）、@EnableAutoConfiguration 做用：

  • 利用AutoConfigurationImportSelector給容器中導入一些組件

  • 能夠查看selectImports()方法的內容；

  • List 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
​

每個這樣的 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:封裝配置文件中相關屬性；

3.9.二、細節

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屬性；來讓控制檯打印自動配置報告，這樣咱們就能夠很方便的知道哪些自動配置類生效；

​
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程