1. 程式人生 > >Spring Boot核心原理-自動配置

Spring Boot核心原理-自動配置

作者簡介:朱清,畢業於電子科技大學,現任職冰鑑科技高階研發經理,主導冰鑑風控系統架構設計和研發。

之前在公司內部推行spring boot時,有同事跟我提到過,感覺換到spring boot這個框架後,好處是小白也能迅速上手寫業務程式碼了。但是呢,這種情況下新手很容易寫得雲裡霧裡的,因為完全不知道背後的原理是什麼,相對比在學習spring時需要深刻理解ioc、搞一堆繁瑣的配置來說,的確缺少了被迫跳出舒適區去學習一些原理的過程,那麼今天就講講,為什麼spring boot能夠如此簡單的讓我們迅速上手。

Spring boot出現之後,得益於“習慣優於配置”這個理念,再也沒有繁瑣的配置、難以整合的內容(大多數流行第三方技術都被整合在內)。 那麼背後實現的核心原理到底是什麼呢? 其實是spring 4.x提供的基於條件配置bean的能力。

Spring boot關於自動配置的原始碼在spring-boot-autoconfigure-x.x.x.x.jar中,主要包含了如下圖所示的配置(並未截全):

圖片描述

我們可以在這裡看見所有spring boot為我們做的自動配置。通過在application.properties中設定屬性:debug=true,可以通過控制檯的輸出觀察自動配置啟動的情況:(以下有刪減,建議自己執行一下看看)

=========================
AUTO-CONFIGURATION REPORT
Positive matches:
————————
 - @ConditionalOnClass
classes found: org.springframework.web.servlet.DispatcherServlet (OnClassCondition)
- found web application StandardServletEnvironment (OnWebApplicationCondition) Negative matches: ----------------- ActiveMQAutoConfiguration did not match - required @ConditionalOnClass classes not found:
javax.jms.ConnectionFactory,org.apache.activemq.ActiveMQConnectionFactory (OnClassCondition)

執行原理

在第一次使用spring boot的時候,大家都會驚訝於@SpringBootApplication這個註解,有了它馬上就能夠讓整個應用跑起來。實際上它只是一個組合註解,包含@Configuration、@EnableAutoConfiguration、@ComponentScan這三個註解。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Configuration
@EnableAutoConfiguration
@ComponentScan
public @interface SpringBootApplication {
    Class<?>[] exclude() default {};
    String[] excludeName() default {};
    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackages"
    )
    String[] scanBasePackages() default {};
    @AliasFor(
        annotation = ComponentScan.class,
        attribute = "basePackageClasses"
    )
    Class<?>[] scanBasePackageClasses() default {};
}

它的核心功能是由@EnableAutoConfiguration這個註解提供的,我們來看看@EnableAutoConfiguration的原始碼:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({EnableAutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    Class<?>[] exclude() default {};
    String[] excludeName() default {};
}

這裡的關鍵功能是@Import註解匯入的配置功能
EnableAutoConfigurationImportSelector使用SpringFactoriesLoader.loadFactoryNames方法來掃描具有META-INF/spring.factories檔案的jar包,spring-boot-autoconfigure-x.x.x.x.jar裡就有一個spring.factories檔案,這個檔案中聲明瞭有哪些要自動配置。

下面我們來分析一下spring boot autoconfigure裡面的MongoAutoConfiguration(mongodb的自動配置),相信你就會明白這套自動配置機制到底是怎麼一回事兒:

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package org.springframework.boot.autoconfigure.mongo;
import com.mongodb.MongoClient;
import com.mongodb.MongoClientOptions;
import java.net.UnknownHostException;
import javax.annotation.PreDestroy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.mongo.MongoProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
@Configuration
@ConditionalOnClass({MongoClient.class})  
@EnableConfigurationProperties({MongoProperties.class}) //開啟屬性注入。
@ConditionalOnMissingBean(
    type = {"org.springframework.data.mongodb.MongoDbFactory"}
) 
public class MongoAutoConfiguration {
    @Autowired
    private MongoProperties properties;
    @Autowired(
        required = false
    )
    private MongoClientOptions options;
    @Autowired
    private Environment environment;
    private MongoClient mongo;
    public MongoAutoConfiguration() {
    }
    @PreDestroy
    public void close() {
        if(this.mongo != null) {
            this.mongo.close();
        }
    }
    @Bean //使用java配置,當容器中沒有這個bean的時候執行初始化
    @ConditionalOnMissingBean
    public MongoClient mongo() throws UnknownHostException {
        this.mongo = this.properties.createMongoClient(this.options, this.environment);
        return this.mongo;
    }
}

首先這被@Configuration註解了,是一個配置類,當滿足以下條件這個bean被裝配:

  • 當MongoClient在類路徑下。

  • 當容器中沒有org.springframework.data.mongodb.MongoDbFactory這類bean的時候。

此外,我們可以看一下通過@EnableConfigurationProperties({MongoProperties.class}) 自動注入的屬性(這是習慣優於配置的最終落地點):

@ConfigurationProperties(
    prefix = "spring.data.mongodb"
)
public class MongoProperties {
    public static final int DEFAULT_PORT = 27017;
    private String host;
    private Integer port = null;
    private String uri = "mongodb://localhost/test";
    private String database;
    private String authenticationDatabase;
    private String gridFsDatabase;
    private String username;
    private char[] password;
    private Class<?> fieldNamingStrategy;

    ......
}

所以在我們什麼都不幹的情況下,只需要引入spring-data-mongodb這個依賴再加上預設的MongoDB server我們就能夠快速整合MongoDB,用MongodbTemplate訪問資料庫。

同時我們可以通過在application.yaml中修改spring.data.mongodb相關的引數就能夠修改連線配置,如:

spring:
    data:
        mongodb:
            host: localhost
            port: 27017
            username: chingzhu
            password: test123
            database: icekredit

利用這套原理,我們也可以輕鬆地把目前spring boot還未整合的、我們自己要使用的第三方技術自動整合起來。

現在,不知道你對spring boot的機制有一個清楚的認識了嗎?

附:常見org.springframework.boot.autoconfigure.condition包下的條件註解意思

@ConditionalOnBean:當容器裡有指定的bean的條件下。

@ConditionalOnMissingBean:當容器裡不存在指定bean的條件下。

@ConditionalOnClass:當類路徑下有指定類的條件下。

@ConditionalOnMissingClass:當類路徑下不存在指定類的條件下。

@ConditionalOnProperty:指定的屬性是否有指定的值,比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true),代表當xxx.xxx為enable時條件的布林值為true,如果沒有設定的情況下也為true。