一、前言
研究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即可:
1
2
3
4
|
<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包
1
2
3
4
5
6
7
8
9
10
11
|
<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> |
第二步:編寫控制器類
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
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; } } |
第三步:編寫啟動類(入庫)
1
2
3
4
5
6
7
8
9
10
|
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方法,然后訪問,就可以看到如下結果:
是不是感覺很開心?一行配置都沒有,就可以直接運行一個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,那應該怎么做?難道需要自己一個一個jar包導入?實際上spring boot提供了另一種方式來解決這個問題,就是在自己的pom文件中加入spring boot的依賴的管理:
1
2
3
4
5
6
7
8
9
10
11
|
<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包。所以導入這個后,就不需要自己再一個一個jar去導入了。但是這樣的話,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的運行肯定跟這個注解有著諸多的聯系,我們可以看下這個注解的源碼:
1
2
3
4
5
6
7
8
9
10
|
@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,這個注解比較簡單,源碼如下:
1
2
3
4
5
6
|
@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這種快速、輕量級的服務也非常適合微服務架構,這個后續有機會再跟大家分享,歡迎繼續關注。
原文鏈接:https://www.cnblogs.com/paddix/archive/2017/12/26/8108094.html