SpringBoot自動配置實現的詳細步驟

Posted on by

springboot如何實現

在之前的 helloworld 示例中，已經初步體會到 springboot 自動導入依賴、完成配置的爽快瞭。

那麼，springboot 是如何實現的呢？

一、依賴管理特性

先看下上一篇內容示例中的pom.xml：

<!--導入父工程-->
  <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.3.4.RELEASE</version>
  </parent>
  <dependencies>
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
  </dependencies>

這裡添加瞭一個父項目，另外隻導入瞭一個依賴spring-boot-starter-web，最後我們所有相關的包就進來瞭。

整個過程中，無需關心導包問題。

1. 父項目

每一個 springboot 工程都有一個父項目，一般都是用來做依賴管理的。

父項目中可能會申明很多的依賴，那麼子項目隻要繼承瞭父項目，後續在添加依賴的時候就不需要添加版本號瞭。

以上述為例，父項目使用的是2.3.4.RELEASE的 springboot 版本，所以下面添加的依賴，就無需再寫版本號。

(1)父項目如何管理版本

可以按住ctrl，然後單擊這個父項目進入一探究竟。

進來後發現他也有一個父項目spring-boot-dependencies。

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-dependencies</artifactId>
    <version>2.3.4.RELEASE</version>
  </parent>

繼續進入到spring-boot-dependencies，在下面可以看到一個properties標簽：

這裡幾乎聲明瞭全部我們在開發中可能會用到的 jar 包的版本。

繼續往下可以看到具體的依賴管理dependencyManagement，這裡引用的就是properties裡申明的版本。

舉個例子：

左側我看到有個包是logback，那麼就在裡面搜索下，發現這裡定義好的版本就是1.2.3。

所以說，父項目的主要功能就是依賴管理，幾乎聲明瞭開發中常用的依賴的版本號。

(2)使用指定的版本

如果不要使用自動仲裁出的版本，而使用指定版本也是可以的。

比如 mysql 版本，自動仲裁的結果是8.0.21，但是我隻想用5.1.43的版本。

添加一個properties標簽，在裡面申明版本即可。

<properties>
      <mysql.version>5.1.43</mysql.version>
  </properties>

再看下導入的依賴，就已經變成指定的版本瞭。

2. 場景啟動器

再來看下最開始導入的一個依賴spring-boot-starter-web:

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
  </dependency>

後續會見到更多的以spring-boot-starter命名的啟動器。在官方文檔裡也有詳細的說明

什麼是 starter？

starter 一組需要依賴的集合描述，也就是通常我們隻需要引入一個 starter，那麼對應的整個開發場景就會引入瞭。

比如想開始使用 Spring 和 JPA 進行數據庫訪問，那麼就在項目中引入spring-boot-starter-data-jpa依賴項。

另外，註意這裡spring-boot-starter-*開頭的是官方的啟動器命名方式。

這麼說還有非官方的？是的，如果你覺得官方給你的 starter 場景還是不能滿足你的使用需要，那麼你可以自定義 starter。

但是官方推薦自定義的命名方式使用thirdpartyproject-spring-boot-starter。

至於為什麼隻導入一個 starter 就可以導入整個場景的依賴，其實還是跟上面父項目一樣，maven 的依賴特性。

進入到spring-boot-starter-web，往下翻，就可以看到開發 web 場景所用到的依賴瞭。

所以，以後需要開發哪個場景，隻要參考官方文檔導入對應的啟動器即可。

二、自動配置

這裡再回顧一下之前的 helloworld 項目中，springboot 自動配置好瞭哪些東西：

  • 自動配好 tomcat
  • 自動配好 springMVC
  • 自動配好 web 常見功能，比如：字符編碼問題
  • 默認的包結構：主程序所在包以及下面所有子包裡的組件都會被默認掃描
  • 各種配置擁有默認值
  • 按需加載所有自動配置項
  • ……

1. 自動配置組件

不管自動配置好什麼，步驟都是：先引入、再配置。

比如 tomcat，那麼前提是先引入瞭 tomcat 依賴，這就由上面第一部分內容所講的依賴管理完成，在引入瞭 web starter 後，自動引入場景。

自動引入瞭場景，也就引入瞭這個場景下所用到的各種 jar 包，接下來就是要配置這些內容，比如 tomcat、springMVC 等等。

拿 springMVC 舉例，在之前要使用 springMVC，肯定要配置DispatcherServlet，幫我們攔截所有請求。

<servlet>
        <servlet-name>springMVC</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:springMVC.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>

現在看下之前的 helloworld 應用中，springboot 是在哪裡幫我們做好配置的。

先看主程序類：

// 標記這是一個 springboot應用，這個類是主程序類，所有啟動的入口
@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }
}

可以創建個本地變量(alt+enter)，可以看到這個是個ConfigurableApplicationContext類型。

@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
    }
}

可以使用getBeanDefinitionNames()方法，查看裡面包含瞭哪些容器，遍歷打印出來。

@SpringBootApplication
public class MainApplication {
    public static void main(String[] args) {
        // 返回IOC容器
        final ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
        // 查看容器裡的組件
        final String[] beanDefinitionNames = run.getBeanDefinitionNames();
        for (String name: beanDefinitionNames) {
            System.out.println(name);
        }
    }
}

接下來啟動應用，看下控制臺輸出。

在控制臺輸出裡ctrl+F搜索下DispatcherServlet：

發現 IOC 容器中已經有瞭對應的組件。

2. 默認的包結構

主程序所在包以及下面所有子包裡的組件都會被默認掃描，所以我們不需要配置開啟組件掃描，也可以正常使用。

但是要註意這裡的范圍：

示例中就是com.pingguo.boot包下以及所有子包都可以自動掃描。

如果你就是要放到外面，還希望被掃描到，怎麼辦？

那麼可以使用主程序類中@SpringBootApplication註解中的一個屬性scanBasePackages，擴大包的范圍即可：

@SpringBootApplication(scanBasePackages = "com.pingguo")
public class MainApplication {
    public static void main(String[] args) {
... ...

3. 各種配置擁有默認值

比如 tomcat端口，在application.properties配置文件裡使用 idea 輸入的時候，就可以看到帶有默認值8080:

點擊進去可看到後面都是綁定瞭對應的 java 類。

配置文件的值最終會綁定在對應的類上，這個類會在容器中創建對象。

4. 按需加載所有自動配置項

比如應用中隻引入瞭spring-boot-starter-web，那麼就隻有web場景的自動配置才會開啟。

springboot 中的所有自動配置，都在這裡：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure</artifactId>
    <version>2.3.4.RELEASE</version>
    <scope>compile</scope>
  </dependency>

點擊spring-boot-starter-web可以找到spring-boot-starter，再進入其中就可以看到spring-boot-autoconfigure。

三、小結

經過上面的步驟，我們開發應用就基本可以做到 0 配置，既方便又快捷。

我理解是，springboot 通過各種巧妙的封裝，把你可能要用到的場景下的一切都準備好，你需要用直接申明一下(引入場景)就好。

幫助我們徹底擺脫配置地獄，專註於業務。

以上就是SpringBoot自動配置實現詳細過程的詳細內容，更多關於SpringBoot自動配置過程的資料請關註WalkonNet其它相關文章！

推薦閱讀：