淺析SpringBoot自動配置的原理及實作

目錄

Spring-Boot的自動配置功能是什么？

1.什么是spring-Boot？

2.spring-Boot的自動配置功能

Spring-Boot 自動配置核心注解

1.@SpringBootApplication

小結：

Starter依賴的原理-以Mybits為例

1.spring.factories

2.MybatisAutoConfiguration.class

小結

自定義starter

1.開發快遞鳥

2. 將kuaidiniao打包安裝到本地倉庫 mvn clean install

3.開發kuaidniao-spring-boot-starter,加依賴

4.創建spring.factories檔案

5.開發自動配置類

6.開發屬性類

7.安裝快遞鳥starter mvn clean install

8.在Spring-Boot專案中測驗，添加starter依賴，并以前綴關鍵字添加屬性

9.Test

總結圖

Spring-Boot的自動配置功能是什么？

1.什么是spring-Boot？

　Spring Boot實作了自動配置，降低了專案搭建的復雜度，它主要是為了解決使用Spring框架需要進行大量的配置太麻煩的問題，所以它并不是用來替代Spring的解決方案，而是和Spring框架緊密結合用于提升Spring開發者體驗的工具，同時它集成了大量常用的第三方庫配置(例如Jackson, JDBC, Mongo, Redis, Mail等等)，Spring Boot應用中這些第三方庫幾乎可以零配置的開箱即用(out-of-the-box)，

2.spring-Boot的自動配置功能

還記得曾經為了引入一個框架，而在spring的xml檔案里面寫一大堆的配置或者以注解的形式，定義一大堆的配置類，簡直不要太繁瑣，稍不注意還很容易出錯，終于有一天，springboot出現了，簡直就是天使般的存在，自從用上springboot，腰也不疼了，頭發掉的也少了，這一切都源于Springboot自動配置的特性，
Springboot遵循“約定優于配置”的原則，使用注解對一些常規的配置項做默認配置，減少或不使用xml配置，讓你的專案快速運行起來，Springboot還為大量的開發常用框架封裝了starter，如今引入框架只要引入一個starter，你就可以使用這個框架，只需少量的配置甚至是不需要任何配置，

Spring-Boot 自動配置核心注解

1.@SpringBootApplication

@SpringBootApplication位于xxxApplication啟動類中，進入它的原始碼看看

//以下四個為元注解，不是重點剖析物件
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited

//標記為配置類
@SpringBootConfiguration
//啟動自動配置
@EnableAutoConfiguration
//掃包，以當前類（Application類啟動類）所在的包為基包遞回掃描
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
........
........
}

重點關注的兩個注解@SpringBootConfiguration、@EnableAutoConfiguration的原始碼

//忽略元注解
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented

//標識出當前類為配置類
@Configuration

//為 Spring 的模式注解添加索引，以提升應用啟動性能
//@Repository	@Component	@Service @Controller @Configuration(模式注解)
@Indexed
public @interface SpringBootConfiguration {
.......
.......
}

//忽略元注解
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited

//自動配置所有的包
@AutoConfigurationPackage

//引入自動篩選注解類去篩選需要配置的bean
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
......
......
}

小結：

• Application是一個配置類，支持直接@Bean配置bean
• 默認啟動了自動配置AutoConfiguration
• 包掃描，以當前類（Application類啟動類）所在的包為基包遞回掃描，要求所有的包與Application同級

Starter依賴的原理-以Mybits為例

找到mybits的spring.factories檔案以及自動配置類

1.spring.factories

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.mybatis.spring.boot.autoconfigure.MybatisLanguageDriverAutoConfiguration,\
org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration

2.MybatisAutoConfiguration.class

// *標記是一個配置類
@Configuration  

//條件開關，類路徑上存在SqlSessionFactory、SqlSessionFactoryBean
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class }) 

//要求有一個DataSource的Bean
@ConditionalOnSingleCandidate(DataSource.class)

//*啟動配置屬性,關聯了一個配置屬性類
@EnableConfigurationProperties(MybatisProperties.class)

//指定在某些自動配置類之后執行自動配置
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration implements InitializingBean {

    //配置屬性類，用于配置核心啟動類所需引數    
    private final MybatisProperties properties;

    ...
    
  @Bean // *該方法為你創建一個SQLSessionFactory，并且注冊成springBean，它是Mybits啟動所必須的sql會話工廠
  @ConditionalOnMissingBean
  public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean factory = new SqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        ...
        return factory.getObject();

    }
    
}

額外補充，可忽略：條件開關可以分為多種：

@ConditionalOnBean：當容器里有指定Bean的條件下
@ConditionalOnClass：當類路徑下有指定的類的條件下
@ConditionalOnExpression：基于SpEL運算式為true的時候作為判斷條件才去實體化
@ConditionalOnJava：基于JVM版本作為判斷條件
@ConditionalOnJndi：在JNDI存在的條件下查找指定的位置
@ConditionalOnMissingBean：當容器里沒有指定Bean的情況下
@ConditionalOnMissingClass：當容器里沒有指定類的情況下
@ConditionalOnWebApplication：當前專案時Web專案的條件下
@ConditionalOnNotWebApplication：當前專案不是Web專案的條件下
@ConditionalOnProperty：指定的屬性是否有指定的值
@ConditionalOnResource：類路徑是否有指定的值
@ConditionalOnOnSingleCandidate：當指定Bean在容器中只有一個，或者有多個但是指定首選的Bean

配置屬性類MybitsProperties.class的成員變數可以在Spring-Boot專案中的resource/application.yml或是application.priperties的外化組態檔中通過列印前綴關鍵字進行設定

小結

自動配置流程：META-INF/spring.factories---> MybatisAutoConfigraution---> MybatisPropeties (prefix )---> application.yml里的mybatis開頭的所有配置

MybatisAutoConfigraution 負責自動配置

MybatisPropeties 存盤外化配置資料

自定義starter

1.開發快遞鳥

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;
import java.security.MessageDigest;
import java.util.HashMap;
import java.util.Map;

public class KuaiDiNiaoQueryAPI {

 * ID和Key請到官網申請：http://www.kdniao.com/ServiceApply.aspx


    //電商ID 我的用戶名
    private String EBusinessID;

    //電商加密私鑰，快遞鳥提供，注意保管，不要泄漏
    private String AppKey;

    //請求url
    private String ReqURL;

    public KuaiDiNiaoQueryAPI(ExprsTrackConfig config){
        this.EBusinessID=config.getUserKey();
        this.AppKey=config.getUserSecret();
        this.ReqURL=config.getApiUrl();
    }


    /**
     * Json方式 查詢訂單物流軌跡
     * @param expCode  物流公司的編碼
     * @param expNo    物流號
     * @return 查詢結果
     * @throws Exception
     */
    public String getOrderTracesByJson(String expCode, String expNo) throws Exception{
        String requestData= "{'OrderCode':'','ShipperCode':'" + expCode + "','LogisticCode':'" + expNo + "'}";

        Map<String, String> params = new HashMap<String, String>();
        params.put("RequestData", urlEncoder(requestData, "UTF-8"));
        params.put("EBusinessID", EBusinessID);
        params.put("RequestType", "1002");
        String dataSign=encrypt(requestData, AppKey, "UTF-8");
        params.put("DataSign", urlEncoder(dataSign, "UTF-8"));
        params.put("DataType", "2");

        String result=sendPost(ReqURL, params);

        //根據公司業務處理回傳的資訊......

        return result;
    }

    /**
     * MD5加密
     * @param str 內容
     * @param charset 編碼方式
     * @throws Exception
     */
    @SuppressWarnings("unused")
    private String MD5(String str, String charset) throws Exception {
        MessageDigest md = MessageDigest.getInstance("MD5");
        md.update(str.getBytes(charset));
        byte[] result = md.digest();
        StringBuffer sb = new StringBuffer(32);
        for (int i = 0; i < result.length; i++) {
            int val = result[i] & 0xff;
            if (val <= 0xf) {
                sb.append("0");
            }
            sb.append(Integer.toHexString(val));
        }
        return sb.toString().toLowerCase();
    }

    /**
     * base64編碼
     * @param str 內容
     * @param charset 編碼方式
     * @throws UnsupportedEncodingException
     */
    private String base64(String str, String charset) throws UnsupportedEncodingException {
        String encoded = base64Encode(str.getBytes(charset));
        return encoded;
    }

    @SuppressWarnings("unused")
    private String urlEncoder(String str, String charset) throws UnsupportedEncodingException{
        String result = URLEncoder.encode(str, charset);
        return result;
    }

    /**
     * 電商Sign簽名生成
     * @param content 內容
     * @param keyValue Appkey
     * @param charset 編碼方式
     * @throws UnsupportedEncodingException ,Exception
     * @return DataSign簽名
     */
    @SuppressWarnings("unused")
    private String encrypt (String content, String keyValue, String charset) throws UnsupportedEncodingException, Exception
    {
        if (keyValue != null)
        {
            return base64(MD5(content + keyValue, charset), charset);
        }
        return base64(MD5(content, charset), charset);
    }

    /**
     * 向指定 URL 發送POST方法的請求
     * @param url 發送請求的 URL
     * @param params 請求的引數集合
     * @return 遠程資源的回應結果
     */
    @SuppressWarnings("unused")
    private String sendPost(String url, Map<String, String> params) {
        OutputStreamWriter out = null;
        BufferedReader in = null;
        StringBuilder result = new StringBuilder();
        try {
            URL realUrl = new URL(url);
            HttpURLConnection conn =(HttpURLConnection) realUrl.openConnection();
            // 發送POST請求必須設定如下兩行
            conn.setDoOutput(true);
            conn.setDoInput(true);
            // POST方法
            conn.setRequestMethod("POST");
            // 設定通用的請求屬性
            conn.setRequestProperty("accept", "*/*");
            conn.setRequestProperty("connection", "Keep-Alive");
            conn.setRequestProperty("user-agent",
                    "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1;SV1)");
            conn.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
            conn.connect();
            // 獲取URLConnection物件對應的輸出流
            out = new OutputStreamWriter(conn.getOutputStream(), "UTF-8");
            // 發送請求引數
            if (params != null) {
                StringBuilder param = new StringBuilder();
                for (Map.Entry<String, String> entry : params.entrySet()) {
                    if(param.length()>0){
                        param.append("&");
                    }
                    param.append(entry.getKey());
                    param.append("=");
                    param.append(entry.getValue());
                    //System.out.println(entry.getKey()+":"+entry.getValue());
                }
                //System.out.println("param:"+param.toString());
                out.write(param.toString());
            }
            // flush輸出流的緩沖
            out.flush();
            // 定義BufferedReader輸入流來讀取URL的回應
            in = new BufferedReader(
                    new InputStreamReader(conn.getInputStream(), "UTF-8"));
            String line;
            while ((line = in.readLine()) != null) {
                result.append(line);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        //使用finally塊來關閉輸出流、輸入流
        finally{
            try{
                if(out!=null){
                    out.close();
                }
                if(in!=null){
                    in.close();
                }
            }
            catch(IOException ex){
                ex.printStackTrace();
            }
        }
        return result.toString();
    }


    private static char[] base64EncodeChars = new char[] {
            'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
            'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
            'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
            'Y', 'Z', 'a', 'b', 'c', 'd', 'e', 'f',
            'g', 'h', 'i', 'j', 'k', 'l', 'm', 'n',
            'o', 'p', 'q', 'r', 's', 't', 'u', 'v',
            'w', 'x', 'y', 'z', '0', '1', '2', '3',
            '4', '5', '6', '7', '8', '9', '+', '/' };

    public static String base64Encode(byte[] data) {
        StringBuffer sb = new StringBuffer();
        int len = data.length;
        int i = 0;
        int b1, b2, b3;
        while (i < len) {
            b1 = data[i++] & 0xff;
            if (i == len)
            {
                sb.append(base64EncodeChars[b1 >>> 2]);
                sb.append(base64EncodeChars[(b1 & 0x3) << 4]);
                sb.append("==");
                break;
            }
            b2 = data[i++] & 0xff;
            if (i == len)
            {
                sb.append(base64EncodeChars[b1 >>> 2]);
                sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);
                sb.append(base64EncodeChars[(b2 & 0x0f) << 2]);
                sb.append("=");
                break;
            }
            b3 = data[i++] & 0xff;
            sb.append(base64EncodeChars[b1 >>> 2]);
            sb.append(base64EncodeChars[((b1 & 0x03) << 4) | ((b2 & 0xf0) >>> 4)]);
            sb.append(base64EncodeChars[((b2 & 0x0f) << 2) | ((b3 & 0xc0) >>> 6)]);
            sb.append(base64EncodeChars[b3 & 0x3f]);
        }
        return sb.toString();
    }
}


//配置類

public class ExprsTrackConfig {

    /**
     * 用戶key
     */
    private String userKey;

    /**
     * 用戶密碼
     */
    private String userSecret;

    /**
     * 請求地址
     */
    private String apiUrl;




    public String getUserKey() {
        return userKey;
    }

    public void setUserKey(String userKey) {
        this.userKey = userKey;
    }

    public String getUserSecret() {
        return userSecret;
    }

    public void setUserSecret(String userSecret) {
        this.userSecret = userSecret;
    }

    public String getApiUrl() {
        return apiUrl;
    }

    public void setApiUrl(String apiUrl) {
        this.apiUrl = apiUrl;
    }
}


//配置屬性類

public class App 
{
    public static void main(String[] args) throws Exception {
        ExprsTrackConfig config = new ExprsTrackConfig();
        config.setApiUrl("http://api.kdniao.com/Ebusiness/EbusinessOrderHandle.aspx");
        config.setUserKey("自行申請注冊");
        config.setUserSecret("自行申請注冊");
        KuaiDiNiaoQueryAPI api = new KuaiDiNiaoQueryAPI(config);

        String yzpy = api.getOrderTracesByJson("SF", "單號");
        System.out.println(yzpy);
    }}

2. 將kuaidiniao打包安裝到本地倉庫 mvn clean install

3.開發kuaidniao-spring-boot-starter,加依賴

 <properties>
<spring-boot.version>2.5.3</spring-boot.version>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>

    <!--    自定義boot-starter必須有的依賴-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter</artifactId>
      <version>${spring-boot.version}</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot</artifactId>
      <version>${spring-boot.version}</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-autoconfigure</artifactId>
      <version>${spring-boot.version}</version>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-configuration-processor</artifactId>
      <version>${spring-boot.version}</version>
      <optional>true</optional>
    </dependency>



    <dependency>
      <groupId>com.woniuxy.class58</groupId>
      <artifactId>kuaidiniao</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>

4.創建spring.factories檔案

org.springframework.boot.autoconfigure.EnableAutoConfiguration=KuaiDiNiaoAutoConfiguration類路徑

5.開發自動配置類

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(KuaiDiNiaoProperties.class)
public class KuaiDiNiaoAutoConfiguration {

    @Autowired
    private KuaiDiNiaoProperties kuaiDiNiaoProperties;


    @Bean
    public KuaiDiNiaoQueryAPI kuaiDiNiaoQueryAPI(){
        ExprsTrackConfig config = new ExprsTrackConfig();
        //讀取外化配置，并將賦給相應的屬性
        config.setApiUrl(kuaiDiNiaoProperties.getApiUrl());
        config.setUserKey(kuaiDiNiaoProperties.getUserKey());
        config.setUserSecret(kuaiDiNiaoProperties.getUserSecret());
        KuaiDiNiaoQueryAPI kuaiDiNiaoQueryAPI = new KuaiDiNiaoQueryAPI(config);

        return kuaiDiNiaoQueryAPI;
    }

}

6.開發屬性類

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "kuaidiniao")
public class KuaiDiNiaoProperties {

    private String apiUrl;

    private String userKey;

    private String userSecret;

    public String getApiUrl() {
        return apiUrl;
    }

    public void setApiUrl(String apiUrl) {
        this.apiUrl = apiUrl;
    }

    public String getUserKey() {
        return userKey;
    }

    public void setUserKey(String userKey) {
        this.userKey = userKey;
    }

    public String getUserSecret() {
        return userSecret;
    }

    public void setUserSecret(String userSecret) {
        this.userSecret = userSecret;
    }

    @Override
    public String toString() {
        return "KuaiDiNiaoProperties{" +
                "apiUrl='" + apiUrl + '\'' +
                ", userKey='" + userKey + '\'' +
                ", userSecret='" + userSecret + '\'' +
                '}';
    }
}

7.安裝快遞鳥starter mvn clean install

8.在Spring-Boot專案中測驗，添加starter依賴，并以前綴關鍵字添加屬性

9.Test

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import query.KuaiDiNiaoQueryAPI;

import javax.annotation.Resource;

@Controller
public class KuaiDiNiaoQuery {

    @Resource
    private KuaiDiNiaoQueryAPI kuaiDiNiaoQueryAPI;


    @RequestMapping("/query")
    //將javaBean轉為json輸出并在前端頁面列印
    @ResponseBody
    public String query(String kd, String no) throws Exception {
        return kuaiDiNiaoQueryAPI.getOrderTracesByJson(kd,no);
    }
}

總結圖