SpringBoot初體驗及原理解析

阿豪聊乾貨發表於2018-06-04
Spring Boot

一、前言

​　　上篇文章，我們聊到了SpringBoot得以實現的幕後推手，這次我們來用SpringBoot開始HelloWorld之旅。SpringBoot是Spring框架對“約定大於配置(Convention over Configuration)”理念的最佳實踐。SpringBoot應用本質上就是一個基於Spring框架的應用。我們大多數程式猿已經對Spring特別熟悉了，那隨著我們的深入挖掘，會發現SpringBoot中並沒有什麼新鮮事，如果你不信，那就一起走著瞧唄！

二、SpringBoot初體驗

首先，我們按照下圖中的步驟生成一個SpringBoot專案：

　　

解壓後的專案檔案在idea中開啟以後，我們會看到如下的專案結構：

　　

這時候，我們在com.hafiz.springbootdemo包下新建controller包，然後再在該包下面新建DemoController.java檔案，內容如下：

package com.hafiz.springbootdemo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author hafiz.zhang
 * @description: first spring boot controller
 * @date Created in 2018/6/3 16:49.
 */
@RestController
public class DemoController {

    @GetMapping("/hello")
    public String sayHello(String name) {
        return "Hello, " + name;
    }
}

然後我們執行SpringbootDemoApplication.java這個main方法，啟動成功後，在控制檯中會出現以下日誌，證明專案啟動成功：

　　

我們從日誌中可以看出，已經註冊了get方式的/hello的路徑以及名為/error的路徑，並且專案在tomat中執行在8080埠，然後我們在瀏覽器中訪問localhost:8080/hello?name=hafiz.zhang會看到如下資訊：

這樣我們就完成了demo專案的開發，先不用這裡面到底發生了啥，我就想問問你：是不是很爽？完全沒有傳統專案的繁瑣的xml配置，爽到爆有木有？搭建一個專案骨架只要幾秒鐘！這就是SpringBoot帶給我們的便利~ 就是這麼神奇！就是這麼牛逼！

三、專案簡單解析

首先我們來看，生成好的專案中的SpringbootDemoApplication.java檔案，內容如下：

package com.hafiz.springbootdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class SpringbootDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootDemoApplication.class, args);
    }
}

程式碼很簡單，但最耀眼的就是@SpringBootApplication註解以及在main方法中執行的SpringAppliation.run()了，那我們要揭開SpringBoot應用的奧祕，很明顯就要拿這二位開刀了！

@SpringBootApplication註解解析

先看看@SpringBootApplication註解的原始碼：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
    ...
}

我們看到@SpringBootApplication其實是一個複合的註解，起主要作用的就是@SpringBootConfiguration、@EnableAutoConfiguration以及@ComponentScan 三個註解組成，所以如果我們把SpringBoot啟動類改寫成如下方式，整個SpringBoot應用依然可以與之前的啟動類功能一樣：

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
        @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public class SpringbootDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootDemoApplication.class, args);
    }
}

因為我們每次新建專案時都要寫上三個註解來完成配置，這顯然太繁瑣了，SpringBoot就為我們提供了@SpringBootApplication這樣一個複合註解來簡化我們的操作。簡直不能再貼心一點了！

@SpringBootConfiguration註解解析

接著我們來看@SpringBootConfiguration註解的原始碼：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
}

我們可以看到，這裡面依舊沒有什麼新東西，它SpringBoot為了區別@Configuration而新提供的專屬於SpringBoot的註解，功能和@Configuration一模一樣。而這裡的@Configuration註解對於我們來說並不陌生，我們在上篇文章中進行了詳細的介紹。SpringBoot的啟動類標註了這個註解，毫無疑問，它本身也是個IoC容器的配置類。瞭解到了這裡，我們其實可以把SpringBoot的啟動類來拆成兩個類，拆完以後就非常清楚明瞭了：

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class DemoConfiguration {

}

public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoConfiguration.class, args);
    }
}

所以呢，啟動類DemoApplication其實就是一個標準的Standalone型別的Java程式的main函式啟動類，也並沒有什麼特殊的東西。

@EnableAutoConfiguration 的神奇之處

看到這貨，我們不僅聯想出Spring 中很多以“@Enable”開頭的註解，比如：@EnableScheduling、@EnableCaching以及@EnableMBeanExport等，@EnableAutoConfiguration註解的理念和工作原理和它們其實一脈相承。簡單的來說，就是該註解藉助@Import註解的支援，Spring的IoC容器收集和註冊特定場景相關的Bean定義：

  • @EnableScheduling是通過@Import將Spring排程框架相關的bean都載入到IoC容器。
  • @EnableMBeanExport是通過@Import將JMX相關的bean定義載入到IoC容器。

而@EnableAutoConfiguration註解也是藉助@Import將所有複合配置條件的bean定義載入到IoC容器，僅此而已！而@EnableAutoConfiguration註解的原始碼如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(EnableAutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

這其中最關鍵的就是@Import(EnableAutoConfigurationImportSelector.class)了，它藉助EnableAutoConfigurationImportSelector.class可以幫助SpringBoot應用將所有符合條件的@Configuration配置類都載入到當前SpringBoot建立並使用的IoC容器，就像一個“八爪魚”一樣。

　　

下面我們給出EnableAutoConfigurationImportSelector.java的父類AutoConfigurationImportSelector.java的部分原始碼，來解釋和驗證上圖：

public class AutoConfigurationImportSelector
        implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware,
BeanFactoryAware, EnvironmentAware, Ordered {
    protected List<AutoConfigurationImportFilter> getAutoConfigurationImportFilters() {
        return SpringFactoriesLoader.loadFactories(AutoConfigurationImportFilter.class,
                this.beanClassLoader);
    }
    protected List<AutoConfigurationImportListener> getAutoConfigurationImportListeners() {
        return SpringFactoriesLoader.loadFactories(AutoConfigurationImportListener.class,
                this.beanClassLoader);
    }
}

以上原始碼可以看出，@EnableAutoConfiguration正是藉助SpringFactoriesLoader的支援，才能完成如此偉大的壯舉！

幕後英雄SpringFactoriesLoader詳解

SpringFactoriesLoader屬於Spring框架專屬的一種擴充套件方案(其功能和使用方式類似於Java的SPI方案:java.util.ServiceLoader)，它的主要功能就是從指定的配置檔案META-INF/spring.factories中載入配置，spring.factories是一個非常經典的java properties檔案，內容格式是Key=Value形式，只不過這Key以及Value都非常特殊，為Java類的完整類名(Fully qualified name)，比如：

com.hafiz.service.DemoService=com.hafiz.service.impl.DemoServiceImpl,com.hafiz.service.impl.DemoServiceImpl2

然後Spring框架就可以根據某個型別作為Key來查詢對應的型別名稱列表了，SpringFactories原始碼如下：

public abstract class SpringFactoriesLoader {

    private static final Log logger = LogFactory.getLog(SpringFactoriesLoader.class);

    public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

    public static <T> List<T> loadFactories(Class<T> factoryClass, ClassLoader classLoader){
        ...
    }

    public static List<String> loadFactoryNames(Class<?> factoryClass, ClassLoader classLoader) {
        ...
    }
    // ...
}

對於@EnableAutoConfiguraion來說，SpringFactoriesLoader的用途和其本意稍微不同，它本意是為了提供SPI擴充套件，而在@EnableAutoConfiguration這個場景下，它更多的是提供了一種配置查詢的功能的支援，也就是根據@EnableAutoConfiguration的完整類名org.springframework.boot.autoconfigure.EnableAutoConfiguration作為Key來獲取一組對應的@Configuration類：

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

在SpringBoot的autoconfigure依賴包中的META-INF檔案下的spring.factories檔案中，我們可以找到以上內容，這就很好的解釋了為什麼。

總結來說，@EnableAutoConfiguration能實現自動配置的原理就是：SpringFactoriesLoader從classpath中搜尋所有META-INF/spring.fatories檔案，並將其中Key[org.springframework.boot.autoconfigure.EnableAutoConfiguration]對應的Value配置項通過反射的方式例項化為對應的標註了@Configuration的JavaConfig形式的IoC容器配置類，然後彙總到當前使用的IoC容器中。

非必須的@ComponentScan解析

為什麼說這個註解是非必需的呢？因為我們知道作為Spring框架裡的老成員，@ComponentScan的功能就是自動掃描並載入複合條件的元件或Bean定義，最終將這些bean定義載入到當前使用的容器中。這個過程，我們可以手工單個進行註冊，不是一定要通過這個註解批量掃描和註冊，所以說@ComponentScan是非必需的。

所以，如果我們當前應用沒有任何bean定義需要通過@ComponentScan載入到當前SpringBoot應用對應的IoC容器，那麼，去掉@ComponentScan註解，當前的SpringBoot應用依舊可以完美執行！那是不是到目前為止，依舊沒有什麼新鮮的事物出現？

關於我們用到的@RestController以及@GetMapping

@RestController註解也是一個複合註解，沒啥新東西，就是自動返回json型別的資料，原始碼如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    String value() default "";
}

@GetMapping註解也是一個複合註解，依舊沒啥新東西，就是用來定義只支援GET請求的URL，原始碼如下：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@RequestMapping(method = RequestMethod.GET)
public @interface GetMapping {
    ...
}

四、總結

　　剛開始沒有深入接觸SpringBoot的時候，感覺這貨真的好神奇，竟然可以省去那麼多搭建步驟。這特麼簡直就是開發人員的福音啊，再回頭想想這貨為啥會火呢？我們都知道近幾年微服務的概念很火，很多企業也開始把自己的專案做成微服務了，那隨著專案越來越多，按照我們以前那種方式配置專案，很繁瑣，光建立專案就要耗費很大的精力和時間，這個時候拯救世界的SpringBoot出現了，它簡化了配置方式，實乃應運而生，順勢而為啊！再不火，沒天理不是。下篇文章我們來聊一聊SpringBoot的啟動流程。期待的小夥伴，評論扣1.

​

相關文章