2. 程式人生 > >springboot 配置檔案以及自動配置

springboot 配置檔案以及自動配置

阿新 • • 發佈：2018-12-19

1.springboot 預設配置檔案

        SpringBoot使用預設的全域性的配置檔案，application.properties / application.yml,配置檔名固定。

2.為什麼需要配置檔案

        我們知道SpringBoot在底層給我們自動做了一些配置，所以springboot專案不編寫配置檔案也可以正常執行，但是根據我們的具體開發我們需要修改SpringBoot自動配置的預設值

；

3.讀取application.yml配置檔案

  • Person.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;//此處省略Dog類的bean實現，只有兩個簡單的屬性{name:steven,age:2}

    @Override
    public String toString() {
        return "Person [lastName=" + lastName + ", age=" + age + ", boss="
                + boss + ", birth=" + birth + ", maps=" + maps + ", lists="
                + lists + ", dog=" + dog + "]";
    }
    //此處省略get set 方法
 

    ...
  • application.yml
person:
    lastName: zhansan
    age: 18
    boss: false
    birth: 2017/12/12
    maps: {k1: 12,k2: 12}
    lists:
        - lisi
        - wangwu
    dog:
        name: steven
        age: 2
  • Test.java
@RunWith(SpringRunner.class)
@SpringBootTest
public class Test{

    @Autowired
    Person person;

    @Test
    public void contextLoads() {
        System.out.println(person);
    }

}

//Person{lastName='zhansan', age=18, boss=false, birth=Tue Dec 12 00:00:00 CST 2017, 
//maps={k1=12, k2=12}, lists=[lisi, wangwu], dog=Dog{name='steven', age=2}}

        這個簡單的demo就完成了，也得到了我們期望的結果，其中最重要的是@ConfigurationProperties，@Component這兩個註解。

  • @ConfigurationProperties：告訴SpringBoot將本類中的所有屬性和配置檔案中相關的配置進行繫結；
  • @ConfigurationProperties(prefix = "person"):預設從全域性配置檔案中獲取值；

  • prefix = "person"：配置檔案中哪個（person）下面的所有屬性進行一一對映；

  • 只有這個元件是容器中的元件，才能使用容器提供的@ConfigurationProperties功能； 所有我們為Person類加上@Component註解

4.自動配置原理

1. SpringBoot啟動的時候載入主配置類，開啟了自動配置功能 @EnableAutoConfiguration

SpringBoot啟動類
SpringBootApplication

2.@EnableAutoConfiguration 作用：利用EnableAutoConfigurationImportSelector給容器中匯入一些元件

EnableAutoConfiguration
    EnableAutoConfigurationImportSelector在1.5中已經棄用，這裡我們不深究，看到它的父類AutoConfigurationImportSelector中的selectImports方法
selectImports
         List configurations = getCandidateConfigurations(annotationMetadata, attributes);獲取候選的配置

3.getCandidateConfigurations()方法呼叫了SpringFactoriesLoader.loadFactoryNames（）方法，下面我們具體來看看這個方法的實現

getCandidateConfigurations方法
loadFactoryNames方法
這裡寫圖片描述
         掃描所有jar包類路徑下 META‐INF/spring.factories;
        把掃描到的這些檔案的內容包裝成properties物件;
        從properties中獲取到EnableAutoConfiguration.class類（類名）對應的值，然後把他們新增在容器中;
        即將 類路徑下 META-INF/spring.factories裡面配置的所有EnableAutoConfiguration的值加入到了容器中。

4..META-INF/spring.factories內容

spring.factories位置

# 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

5.具體分析HttpEncodingAutoConfiguration原理

@Configuration
@EnableConfigurationProperties(HttpEncodingProperties.class)
@ConditionalOnWebApplication
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {

    private final HttpEncodingProperties properties;

    public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
        this.properties = properties;
    }

    @Bean //給容器中新增一個元件，這個元件的某些值需要從properties中獲取，properties中的個屬性是和配置檔案繫結的。
    @ConditionalOnMissingBean(CharacterEncodingFilter.class)//容器沒有CharacterEncodingFilter元件時生效
    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;
    }
}
  • @Configuration : 定義配置類。
  • @EnableConfigurationProperties(HttpEncodingProperties.class)：啟動指定類的ConfigurationProperties功能；
    將配置檔案中對應的值和HttpEncodingProperties繫結起來；並把HttpEncodingProperties加入到ioc容器中。
  • `@ConditionalOnWebApplication：判斷當前應用是否是web應用，如果是，當前配置類生效
  • @ConditionalOnClass(CharacterEncodingFilter.class)`：判斷當前專案有沒有這個類,CharacterEncodingFilter：SpringMVC中解決亂碼的過濾器。
  • @ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled", matchIfMissing = true)：//判斷配置檔案中是否存在某個配置 spring.http.encoding.enabled；matchIfMissing表示，即使我們配置檔案中不配置spring.http.encoding.enabled=true，也是預設生效的；
  • @Conditional註解（Spring註解版），條件註解，通過判斷類路徑下有沒有相應配置的jar包來確定是否載入和自動配置這個類。
  • 所有在配置檔案中能配置的屬性都是在xxxxProperties類中封裝的，配置檔案的配置項就可以參照其對應的這個屬性類。
//從配置檔案中獲取指定的值和bean的屬性進行繫結
@ConfigurationProperties(prefix = "spring.http.encoding")
public class HttpEncodingProperties {

    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
    ...
}
小結：
1）、SpringBoot啟動會載入大量的自動配置類；
2）、首先檢查SpringBoot預設的自動配置類是否滿足我們的需求；
3）、具體檢視這個自動配置類中配置了哪些元件；
4）、給容器中的自動配置類新增元件的時候，會從properties類中獲取某些屬性。我們就可以在配置檔案中指定這
些屬性的值；
5）、xxxxAutoConfigurartion：自動配置類，給容器中新增元件；xxxxProperties:封裝配置檔案中相關屬性；

[email protected]派生註解瞭解

核心：@Conditional指定的條件成立，才給容器中新增元件，配置類裡面的所有內容才生效；即,自動配置類必須在一定的條件下才能生效；

@ConditionalOnJava：系統的java版本是否符合要求
@ConditionalOnBean：容器中存在指定Bean；
@ConditionalOnMissingBean ：容器中不存在指定Bean；
@ConditionalOnExpression ：滿足SpEL表示式指定
@ConditionalOnClass ：系統中有指定的類
@ConditionalOnMissingClass： 系統中沒有指定的類
@ConditionalOnSingleCandidate ：容器中只有一個指定的Bean，或者這個Bean是首選Bean
@ConditionalOnProperty：系統中指定的屬性是否有指定的值
@ConditionalOnResource ：類路徑下是否存在指定資原始檔
@ConditionalOnWebApplication ：當前是web環境
@ConditionalOnNotWebApplication ：當前不是web環境

檢視生效的配置類：
啟用 debug=true屬性，來檢視控制檯列印的自動配置報告。

=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches://匹配成功，啟用的自動配置類
-----------------

   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)

   DispatcherServletAutoConfiguration.DispatcherServletConfiguration matched:
      - @ConditionalOnClass found required class 'javax.servlet.ServletRegistration'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - Default DispatcherServlet did not find dispatcher servlet beans (DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition)
    ...
    ...
    ...

Negative matches://匹配失敗，未啟用的自動配置類
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

   AopAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)

    ...
    ...

相關推薦

springboot 配置檔案以及自動配置

1.springboot 預設配置檔案         SpringBoot使用預設的全域性的配置檔案，application.properties / application.yml,配置檔名固定。

SpringBoot 入門篇（二） SpringBoot常用註解以及自動配置

一、SpringBoot常用註解 二、SpringBoot自動配置機制 一、SpringBoot常用註解   在上一篇文章中https://blog.csdn.net/zhichao_qzc/article/details/806421

nginx安裝路徑，查詢配置檔案以及如何配置

      比較小白的問題，就是安裝完nginx，想看配置和安裝路徑的時候，總是是要花一些時間才能找到，所以就總結一下。 一、nginx的安裝路徑 1、ps -ef | grep nginx 顯示如下： 先解釋一下命令的意思： ps ： 將某個

SpringBoot開發詳解（二）--SpringBoot的配置檔案以及註解

轉載自：https://blog.csdn.net/qq_31001665/article/details/69938750 一、Spring Boot註解 通過上一篇文章，我們已經快速構建了一個spring boot的專案，那spring boot專案和我們之前使用的springMVC專案

關於springboot 配置檔案、Aop配置以及jdbc配置

首先說一下springboot這個框架它的好處：第一傳統的ssm配置難度高，而springboot這個框架大大減低的整合框架難度，提高了開發效率，這是springboot比較手捧的原因之一。在這裡從網上查詢一下關於springboot優點的資料為一下幾點：1、spring b

SpringBoot中SpringMVC的自動配置以及擴充套件

一、問題引入 我們在SSM中使用SpringMVC的時候，需要由我們自己寫SpringMVC的配置檔案，需要用到什麼就要自己配什麼，配置起來也特別的麻煩。我們使用SpringBoot的時候沒有進行配置，直接就能進行使用，這是為什麼呢？ 這是因為SpringBoot為我們自動配置好了SpringMVC

spring boot 入門1-----如何使用@Value註解讀取配置檔案以及使用@ConfigrationProperties註解

讀取.yml檔案屬性值的方式    1）如何將配置檔案中的屬性值與欄位匹配起來         @Value("${配置檔案中屬性的名}")       在application.yml檔案中   &n

使用Apollo管理Springboot配置檔案的相關配置

1，引入Maven依賴： <dependency> <groupId>com.ctrip.framework.apollo</groupId> <artifactId>apollo-client</artifactId>

一文詳解matplotlib的配置檔案以及配置方式

歡迎關注“勇敢AI”公眾號，更多python學習、資料分析、機器學習、深度學習原創文章與大家分享，還有更多電子資源、教程、資料集下載。勇敢AI，一個專注於人工智慧AI的公眾號。 ===================================================

【SpringBoot】spring-boot-自動配置原理

思考：配置檔案到底能寫什麼？怎麼寫？自動配置原理； 1.自動配置原理 springboot自動配置主演通過@EnableConfiguration,@Conditional,@EnableConfigurationProperties或者@ConfiguraionProp

springboot 配置檔案裡部分配置未生效

最近用springboot搭了個專案，上線過段時間就會出現卡死，猜測是資料庫連線池的連線被佔滿，用的連線池是druid，於是給專案加上了一個數據庫連線池監控。程式碼如下： @Configuration public class DruidConfiguration {   

springboot專案logback.xml或者logback-spring.xml中讀取不到application.yml或application.properties配置檔案中的配置解決辦法

在springboot專案中我們可能想要實現不同環境的日誌專案配置不同，比如我想讓不同環境的日誌路徑不同。 這時候我們很容易想： 1、到將日誌路徑配置在springboot的：application-dev.yml，application-prod.yml，applica

Spring Cloud 第六篇：spring cloud 整合 配置檔案以及 mybatis

在上幾篇 專案的基礎上來修改服務程式碼。 首先修改，service-hi 專案（服務提供方），pom.xml檔案如下 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://mave

啟動Java程式時，動態設定SpringBoot配置檔案中的配置

比如： springboot配置檔案中有個   spring.redis.host=localhost選項 但是這個配置可能會修改，比如指定到其他伺服器上的redis.那我們需要修改配置檔案嗎？、 答案是NO 我們可以在啟動SPringBoot程式的時候動態指定這

Spring Boot: Yaml配置檔案 以及 @ConfigurationProperties屬性獲取

Yaml配置檔案 概述 Spring Boot在支援application.properties配置檔案的同時,也支援application.yaml配置檔案. 配置檔案中的屬性,可以通過: 通過@Value註解將屬性值注入Bean中; 通過@ConfigurationProperties註解

SpringBoot 之 自定義配置檔案及讀取配置檔案application.properties或yml

讀取核心配置檔案核心配置檔案是指在resources根目錄下的application.properties或application.yml配置檔案，讀取這兩個配置檔案的方法有兩種，都比較簡單。 核心配置檔案application.properties內容如下： server.port=9090 test.m

websphere匯入.war檔案以及相關配置

最近在做一個web專案，之前一直用tomcat作為伺服器，功能強大，實惠好用，而且是免費的。但是甲方財大氣粗，買了IBM 的WebSphere伺服器，沒辦法，在實驗室又只能下載到試用版，時間又緊，看了很多WebSphere入門的文章，總算是心裡踏實些，再去甲方部署，誰知原先

python的PEXPECT模組進行交換機配置檔案的自動備份

這篇文章的正確性，沒有細細分析，但是知識點是好的: #!/usr/bin/python import sys import time import os import pexpect now = time.strftime("%y%m%d", time.localtim

4.Springboot 之 自定義配置檔案及讀取配置檔案

讀取核心配置檔案 核心配置檔案是指在resources根目錄下的application.properties或application.yml配置檔案，讀取這兩個配置檔案的方法有兩種，都比較簡單。 核心配置檔案application.properties內容如下： server.port=9090 tes

SpringBoot如何將類中屬性與配置檔案中的配置進行繫結

1 匯入配置檔案處理器，配置檔案進行繫結就會有提示。<dependency> <groupId>org.springframework.boot</groupId&