Spring boot 配置文件詳解 (properties 和yml )

来源:https://www.cnblogs.com/thelovelybugfly/archive/2018/11/12/9944447.html
-Advertisement-
Play Games

從其他框架來看 我們都有自己的配置文件， hibernate有hbm，mybatis 有properties， 同樣， Spring boot 也有全局配置文件。 Springboot使用一個全局的配置文件，而且配置文件的名字是固定的。 有兩種 application.properties appl ...


從其他框架來看 我們都有自己的配置文件， 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  等更適合做配置文件 

舉個慄子：

以 修改埠為例 ： 

yml ： 

server:
  port: 8081


xml ：
<server>
    <port>8081</port>
</server>
 xml 配置 將太多的浪費在了標簽上面。

 yml 基本語法：

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

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

server:
    port: 8081
    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: 18}

  • 　　數組（List、Set）：

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

pets:
 - cat
 - dog
 - pig

行內寫法
pets: [cat,dog,pig]

  • 　　配置文件註入

javaBean :

可以導入配置文件處理器依賴，以後編寫配置就會有代碼提示；

代碼展示配置文件註入屬性值 ： 

 1 package com.example.webservice.bean;
 2 
 3 import org.springframework.boot.context.properties.ConfigurationProperties;
 4 import org.springframework.stereotype.Component;
 5 
 6 import java.util.Date;
 7 import java.util.List;
 8 import java.util.Map;
 9 
10 /**
11  *
12  * ConfigurationProperties(prefix ="person") 將本類中的所有屬性和配置文件中的相關配置進行綁定
13  * prefix ="person  表示對哪個文件進行綁定
14  * Component 表示這是一個容器， 只有在容器中  ConfigurationProperties 才能使用
15 */
16 @Component
17 @ConfigurationProperties(prefix = "person")
18 public class Person {
19 
20      private String name;
21      private Integer age;
22      private boolean man;
23      private Date birth;
24      private Map<String,Object>map;
25      private List<Object>list ;
26      private Son son ;
27 
28 .....省略get/set  以及toString 方法 
29 
30 }
31 
32 
33 package com.example.webservice.bean;
34 
35 public class Son {
36 
37     private String name;
38     private Integer age ;
39 
40     public String getName() {
41         return name;
42     }
43 
44     public Integer getAge() {
45         return age;
46     }
47 
48     public void setName(String name) {
49         this.name = name;
50     }
51 
52     public void setAge(Integer age) {
53         this.age = age;
54     }
55 
56     @Override
57     public String toString() {
58         return "Son{" + "name='" + name + '\'' + ", age=" + age + '}';
59     }
60 }
61 
62 
63 properties文件綁定的寫法 
64 #註釋方法 Ctrl + /
65 person.name=爸爸
66 person.age=45
67 person.man=true
68 person.birth=2019/8/8
69 person.map.k1=h1
70 person.map.k2=h2
71 person.list=a,1,son
72 person.son.name=兒子
73 person.son,age=20
74 
75 
76 yml 文件綁定的寫法： 
77 
78 person:
79   name: 爸爸
80   age: 25
81   birth: 2018/2/8
82   man: true
83   list:
84     - a
85     - 2
86     - son
87   map: {key1:value1,key2:value2}
88   son:
89     name: 兒子
90     age: 5


測試類 ： 
在我們的test 文件夾下 ：
package 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)
@SpringBootTest
public 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 {

    /**
     * <bean class="Person">
     *      <property name="name" value="字面量/${key}從環境變數、配置文件中獲取值/#{SpEL}"></property>
     * <bean/>
     */

   //name必須是郵箱格式
    @Email
    //@Value("${person.name}")
    private String name;
    //@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;
。。。。。get/set /toString

  •  @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="name" value="字面量/${key}從環境變數、配置文件中獲取值/#{SpEL}"></property>
     * <bean/>
     */

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

```

  •  @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 {

    //將方法的返回值添加到容器中；容器中這個組件預設的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置類@Bean給容器中添加組件了...");
        return new HelloService();
    }
}

  • 配置文件占位符

 1、隨機數

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

 2、占位符獲取之前配置的值，如果沒有可以是用:指定預設值

 1 properties
 2 person.last-name=張三${random.uuid}
 3 person.age=${random.int}
 4 person.birth=2017/12/15
 5 person.boss=false
 6 person.maps.k1=v1
 7 person.maps.k2=14
 8 person.lists=a,b,c
 9 person.dog.name=${person.hello:hello}_dog
10 person.dog.age=15

3、Profile
1、多Profile文件
我們在主配置文件編寫的時候，文件名可以是   application-{profile}.properties/yml
預設使用application.properties的配置；
 2、yml支持多文檔塊方式

 1 server:
 2   port: 8081
 3 spring:
 4   profiles:
 5     active: prod
 6 ---
 7 server:
 8   port: 8083
 9 spring:
10   profiles: dev
11 ---
12 server:
13   port: 8084
14 spring:
15   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、虛擬機參數；
​        -Dspring.profiles.active=dev
5、配置文件載入位置

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

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

```properties
# 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
```
View Code

 

 每一個這樣的  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類中封裝者‘；配置文件能配置什麼就可以參照某個功能對應的這個屬性類

1 @ConfigurationProperties(prefix = "spring.http.encoding")  //從配置文件中獲取指定的值和bean的屬性進行綁定
2 public class HttpEncodingProperties {
3 
4    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 =========================
 2 AUTO-CONFIGURATION REPORT
 3 =========================
 4 Positive matches:（自動配置類啟用的）
 5 -----------------
 6    DispatcherServletAutoConfiguration matched:
 7       - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
 8       - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)
 9         
10 Negative matches:（沒有啟動，沒有匹配成功的自動配置類）
11 -----------------
12    ActiveMQAutoConfiguration:
13       Did not match:
14          - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)
15    AopAutoConfiguration:
16       Did not match:
17          - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • web前端（3）—— html標簽及web頁面結構
    本節內容簡單介紹下html都有哪些標簽 還是百度首頁，查看源代碼看看： 我把源代碼複製下來另存為html文件里： 註意：網頁文件的尾碼都是html或者htm 我這用的pycharm編輯器（Python編輯器，也可以編輯web頁面），編輯器有很多種，比如notepad... ...
  • webpack緩存
    緩存 緩存如何工作 web中的緩存 web緩存的優勢 web緩存的問題 webpack緩存原理 可以通過命中緩存，以降低網路流量，使網站載入速度更快，然而，如果我們在部署新版本時不更改資源的文件名，瀏覽器可能會認為它沒有被更新，就會使用它的緩存版本。由於緩存的存在，當你需要獲取新的代碼時，就會顯得很 ...
  • jQuery -- 光陰似箭（二）：jQuery效果的使用
    jQuery -- 知識點回顧篇（二）：jQuery效果的使用 1. jQuery 效果 -- 隱藏和顯示: 使用 hide() 和 show() 方法來隱藏和顯示 HTML 元素。 2. jQuery 效果 - 淡入淡出 (1) fadeIn() 方法用於淡入已隱藏的元素。 (2) fadeOut ...
  • django中model欄位與屬性
    model field 類型1、AutoField 一個自增的IntegerField，一般不直接使用，Django會自動給每張表添加一個自增的primary key。2、BigIntegerField 64位整數， -9223372036854775808 到 922337203685477580 ...
  • 撩課-Java每天10道面試題第3天
    21.final, finally, finalize的區別 22、finally是在異常處理時 23. Java中的String，StringBuilder，StringBuffer三者的區別? 24.GC是什麼? 為什麼要有GC? 25.構造器如何工作？ 26.構造器Constructor是否可 ...
  • c/c++ 多線程 boost的讀寫(reader-writer)鎖
    多線程 boost的讀寫(reader writer)鎖 背景：保護很少更新的數據結構時，c++標準庫沒有提供相應的功能。 例如：有個DNS條目緩存的map，基本上很少有更新，大部分都是讀取，但是偶爾也會有更新，這種情況下，如果在讀取的函數裡加上std::mutex就過於悲觀了，每次只能有一個線程讀 ...
  • 不改一行代碼定位線上性能問題
    最近時運不佳，幾乎天天被線上問題騷擾。前幾天剛解決了一個 HashSet 的併發問題，周六又來了一個性能問題。 ...
  • 學生選課面試題
    https://blog.csdn.net/zhangchen124/article/details/74062747:轉至 第一題採用集合實現。 第二題 ER-圖 SQL 博主就不截圖了。 ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類