Spring Boot實戰:逐行釋義HelloWorld

liuxiaopeng發表於2017-12-26

一、前言

   研究Spring boot也有一小段時間了,最近會將研究東西整理一下給大家分享,大概會有10~20篇左右的部落格,整個系列會以一個簡單的部落格系統作為基礎,因為光講理論很多東西不是特別容易理解,並且如果每次通過一個簡單的小程式也無法系統的把握好一些知識點,所以就以一個簡單的系統作為基礎來講,看看通過spring boot如何實現一個完整系統。本系列除了Spring boot基本的知識點之外,還會涉及到Spring boot與資料庫、快取(redis)、訊息佇列等的結合以及多例項部署等方面的內容。有興趣的同學可以關注一下。

二、Spring boot 簡介

   Spring boot 從名稱上就可以看出,它是基於Spring的一個框架,所以不熟悉Spring的同學還是得先去學習一下Spring。其次,Spring boot幫我們整合很多常用的功能,使得整個配置更加簡單。用過Spring的同學應該知道,雖然Spring一直在努力的減少配置的複雜性,但是,配置一個完全可用的(web)環境還是挺麻煩的,比如需要配置日誌、資料庫、快取等,然後再配置tomcat,最後將程式釋出到tomcat目錄下。而Spring boot則幫我們大大簡化了這個過程,它提供了很多starter,只要引入對應的jar包就可以了。例如,我們需要整合tomcat,只需要引入tomcat的starter即可:

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

  備註:本文的例子都是基於Maven來實現的,所以如果不熟悉Maven,可以先去看下怎麼用,如果熟悉gradle的話,也可以根據情況對配置做相應調整。

  我們可以從官方文件上檢視Spring boot提供的starter:

  這裡我只擷取了一小部分,可以看到Spring boot支援快取、批處理、mq、es等等,完整的列表參考官方文件。其他就不多解釋了,後續通過示例來講解整個Spring boot功能,我們先看Spring boot來如何實現一個web版的Hello World!

三、Hello World程式

  3.1 Hello World 原始碼

  第一步:匯入jar包

 <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.8.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

  第二步:編寫控制器類  

package com.pandy.blog;

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

import java.util.HashMap;
import java.util.Map;

@Controller
public class HelloWorld {
    @RequestMapping("/hello")
    @ResponseBody
    public Map<String, Object> hello() {
        Map<String, Object> map = new HashMap<>();
        map.put("hello", "world");
        return map;
    }
}

  第三步:編寫啟動類(入庫)

package com.pandy.blog;

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

@SpringBootApplication
public class Application {

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

 執行該類的main方法,然後訪問http://localhost:8080/hello,就可以看到如下結果:

  是不是感覺很開心?一行配置都沒有,就可以直接執行一個Web應用。不過開心完以後有沒有想過這是怎麼實現的呢?接下來我們一行一行解析上面的程式碼,雖然行數不多,但是還是有很多東西值得我們去學習和理解的。

  3.2 pom檔案分析

  我們先從pom檔案入手,pom檔案裡面只引入了兩個依賴項。第一個是spring-boot-starter-parent,熟悉Maven的朋友應該知道,Maven也可以跟類一樣,從父pom檔案中繼承配置。我們可以看下spring-boot-starter-parent的pom檔案,由於篇幅問題,這裡面只看兩部分,其他東西比較容易理解,大家可以自己讀一下。第一個部分是:

  該檔案又繼承了另一個pom檔案,即spring-boot-dependencies,這個檔案其實就是包含了一大堆的jar,其作用是統一管理spring boot所依賴的jar包的版本,所以之後大家可以看到,各個元件裡面引入jar的時候就不再需要再指定版本號了。另一個地方需要說明一下是配置檔案的管理:

  大家可以看到,預設情況下會將/src/main/resources目錄下的檔案作為資原始檔加入到classpath下,另外,這個地方的僅僅對application*.yml,application*.yaml,application*.properties三種檔案進行過濾。這個過濾是指什麼呢?大家配置過spring mvc的人應該都知道,配置資料庫時,我們通常將資料庫的資訊配置在一個properties檔案中,然後在spring的配置檔案中通過<property name="driverClass" value="${jdbc.driver}" /> 的形式引入,這個filter的作用就是在編譯的時候將配置檔案中配置的名值對替換到spring的配置檔案中${xxx}字元,但這個功能不是必要的,即使不進行替換,Spring也能在執行時讀取到配置項。

  總結一下:spring-boot-starter-parent的作用::

  1)jar包的版本管理。

  2)配置檔案的過濾。

  3)常用外掛管理。

  spring-boot-starter-parent最核心的功能是管理了Spring boot所依賴的所有jar包。不過通parent的方式有一個很明顯的問題,很多公司自己有自己的parent檔案,而maven是沒辦法配置多個parent的。如果不使用spring-boot-starter-parent,那應該怎麼做??實際上Spring boot提供了另一種方式來解決這個問題,就是在自己的pom檔案中加入spring boot的依賴的管理:

<dependencyManagement>
     <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>1.5.9.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

  其實從上面的分析可以看到,這個也是spring-boot-starter-parent 的pom檔案的parent,而這個pom檔案裡面主要就是管理了一大堆的jar包版本。所以匯入這個後,就不需要自己再去做版本管理,各個starter會自己根據需要匯入對應的jar,但版本號由spring-boot-dependencies統一管理。但是這樣的話,spring-boot-starter-parent中的外掛就無法使用,並且預設配置檔案的過濾功能也沒有了。不過這沒什麼影響,一方面這些功能不是必須的,另一方面如果需要,自己新增也是件很容易的事情。  

  3.3 HelloWorld類解析:

  我們再看下HelloWorld這個類,用過Spring mvc應該知道,其實這個類跟Spring boot沒半毛錢關係,業務程式碼更是沒任何跟spring相關的東西,這也是spring一直奉行的一個原則,侵入性極小,這也是Spring成功的一個主要原因。這個類裡面跟spring相關的是三個註解,即@Controller,@RequestMapping,@ResponseBody,但是這三個註解也都是Spring mvc提供的。跟Spring boot沒有太多聯絡,在這我就不細講了,如果不是很清楚,可以去看下Spring MVC的內容,三個註解的基本作用如下:

  • Controller:標識為一個控制器,spring會自動例項化該類。
  • RequestMapping:url對映。
  • ResponseBody:將返回結果自動轉換為json串。

  3.4 Application類解析

  最後我們看下Application這個類,你會發現這個類的東西更少,總共就一行有用的程式碼,即SpringApplication.run(Application.class, args);這個方法的作用是載入Application這個類,那Application這個類有什麼特別之處嗎?可以看一下,其實這個類的唯一特殊的地方是一個註解@SpringBootApplication,所以Spring boot的執行肯定跟這個註解有著諸多的聯絡,我們可以看下這個註解的原始碼:

@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 {

  該註解的主要方法就不說了,大家看下就知道,主要是為上面這些註解提供別名。該註解上前四個註解(@Target(ElementType.TYPE),@Retention(RetentionPolicy.RUNTIME),@Documented,@Inherited)大家應該都知道,不熟悉的朋友自己去看下JDK如何實現自定義的註解。我們詳細解釋一下後面三個註解:@SpringBootConfiguration,@EnableAutoConfiguration,@ComponentScan。

  先看一下SpringBootConfiguration,這個註解比較簡單,原始碼如下:

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

  這個註解僅僅是繼承了@Configuration,大家應該知道,Spring提供三種方式的配置:(1)xml檔案配置(2)annotation配置(3)Java 類配置。而@Configuration就是用於標識一個類為配置類的註解。Spring 4以後比較推崇通過Java類的方式來進行配置,所以Spring boot也傾向於這種方配置式。並且從原始碼可以看出,SpringBootConfiguration的作用就是標識類為配置類。

  接下來我們看一下@EnableAutoConfiguration註解,這個註解的原始碼有點複雜,在這不做細講,後面的文章再詳細解析期實現方式。這裡說一下該註解的作用,它的主要功能是實現自動配置,什麼叫做自動配置?就是Spring boot會根據你引入的jar包做一些自動的配置,例如,在classpath有HSQLDB的jar,spring boot就會自動給你配置一個記憶體資料庫。在這個例子裡面我們也可以看到,因為我們引入了Spring-mvc、tomcat等相關的jar,spring boot就會猜測你是一個web工程,然後就會自動做一些spring mvc的配置,比如對靜態資源的支援、將返回結果自動轉為json格式資料的支援等。這些都是自動配置的結果。對Spring Enable*註解熟悉的同學應該能夠更容易理解這個註解,因為Spring中有很多類似的註解。

  最後我們再看下@ComponentScan,這個註解不是Spring boot提供的,而是Spring提供的,Spring掃描的包或類,即哪些包和類會自動納入Spring IoC容器的管理,IoC根據配置對這些類進行例項化。

   現在我們再總結一下SpringBootConfiguration這個註解的作用:

  1)標誌該類為一個配置類。
  2)指定掃描的包,便於Spring IoC容器對其進行例項和生命週期的管理。
  3)自動配置,通過引入的jar包,猜測使用者的意圖進行自動化配置。

四、總結

   本文詳細分析了Spring boot實現的一個web版的Hello World,通過這個例子,我們瞭解了Spring boot的基本操作,並通過對每行的程式碼的分析,對Spring boot的原理有了一個大致的瞭解。總體來講,Spring boot 統一管理了jar包,然後會根據我們選擇的starter來進行自動化配置,通過這種方式來解決複雜的依賴管理,精簡配置,從而使得開發者能夠更加專注於自己的業務,而不需要做那些很複雜的配置工作。同時,Spring boot這種快速、輕量級的服務也非常適合微服務架構,這個後續有機會再跟大家分享,歡迎繼續關注。

相關文章