如果您開始使用Spring Boot或一般的“Spring”,請首先閱讀本節。 它回答了基本的“什麼?”,“如何?”和“爲什麼?”的問題。 它包括Spring Boot簡介以及安裝說明。 然後,我們將引導您構建您的第一個Spring Boot應用程序,並在我們討論時討論一些核心原則。
8.Spring Boot簡介
Spring Boot可以輕鬆創建可以運行的獨立的,生產級的基於Spring的應用程序。 我們對Spring平臺和第三方庫進行了一種自主觀點,這樣您就可以輕鬆上手了。 大多數Spring Boot應用程序只需要很少的Spring配置。
您可以使用Spring Boot創建可以使用java -jar或更傳統的war部署啓動的Java應用程序。 我們還提供了一個運行“spring腳本”的命令行工具。
我們的主要目標是:
- 爲所有Spring開發提供從根本上更快且可廣泛訪問的入門體驗。
- 開箱即用,但隨着需求開始偏離默認值而迅速擺脫困境
- 提供大型項目(例如嵌入式服務器,安全性,度量標準,運行狀況檢查和外部化配置)通用的一系列非功能性功能。
- 絕對沒有代碼生成,也不需要XML配置。
9.系統要求
Spring Boot 2.1.0.RELEASE需要Java 8或9以及Spring Framework 5.1.2.RELEASE或更高版本。
爲以下構建工具提供了構建支持:
構建工具 | 版本 |
---|---|
Maven | 3.3+ |
Gradle | 4.4+ |
9.1Servlet 容器
Spring Boot支持以下嵌入式servlet容器:
名稱 | Servlet版本 |
---|---|
Tomcat9.0 | 4.0 |
Jetty9.4 | 3.1 |
Undertow2.0 | 4.0 |
您還可以將Spring Boot應用程序部署到任何Servlet 3.1+兼容容器。
10. 安裝Spring Boot
Spring Boot可以與“經典”Java開發工具一起使用,也可以作爲命令行工具安裝。 無論哪種方式,您都 需要Java SDK v1.8或更高版本。 在開始之前,您應該使用以下命令檢查當前的Java安裝:
$ java -version
如果您不熟悉Java開發,或者想要嘗試Spring Boot,則可能需要先嚐試Spring Boot CLI(命令行界面)。 否則,請繼續閱讀“經典”安裝說明。
10.1針對Java開發人員的安裝說明
您可以像使用任何標準Java庫一樣使用Spring Boot。 爲此,請在類路徑中包含相應的spring-boot - * .jar文件。 Spring Boot不需要任何特殊工具集成,因此您可以使用任何IDE或文本編輯器。 此外,Spring Boot應用程序沒有什麼特別之處,因此您可以像運行任何其他Java程序一樣運行和調試Spring Boot應用程序。
雖然您可以複製Spring Boot jar,但我們通常建議您使用支持依賴關係管理的構建工具(例如Maven或Gradle)。
Maven安裝
Spring Boot與Apache Maven 3.3或更高版本兼容。 如果您還沒有安裝Maven,可以按照maven.apache.org上的說明進行操作。
提示
在許多操作系統上,Maven可以與軟件包管理器一起安裝。 如果您使用OSX Homebrew,請嘗試brew install maven。 Ubuntu用戶可以運行sudo apt-get install maven。 使用Chocolatey的Windows用戶可以從提升(管理員)提示符運行choco install maven。
Spring Boot依賴項使用org.springframework.boot groupId。 通常,您的Maven POM文件繼承自spring-boot-starter-parent項目,並聲明對一個或多個“Starters”的依賴關係。 Spring Boot還提供了一個可選的Maven插件來創建可執行jar。
以下清單顯示了典型的pom.xml文件:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1-SNAPSHOT</version>
<!-- 繼承Spring Boot的默認值 -->
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.0.RELEASE</version>
</parent>
<!-- 添加Web應用程序的典型依賴項 -->
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<!-- 打包爲可執行jar -->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
提示
spring-boot-starter-parent是一種使用Spring Boot的好方法,但它可能並不適合所有情況下使用。 有時您可能需要從其他父POM繼承,或者您可能不喜歡我們的默認設置。 在這些情況下,請參閱“使用不帶父POM的Spring Boot”一節,以獲取使用導入範圍的替代解決方案。
Gradle安裝
Spring Boot與Gradle 4.4及更高版本兼容。 如果您尚未安裝Gradle,則可以按照gradle.org上的說明進行操作。
可以使用org.springframework.boot組聲明Spring Boot依賴項。 通常,您的項目會聲明對一個或多個“Starters”的依賴關係。 Spring Boot提供了一個有用的Gradle插件,可用於簡化依賴聲明和創建可執行jar。
Gradle Wrapper
當您需要構建項目時,Gradle Wrapper提供了一種“獲取”Gradle的好方法。 它是一個小腳本和庫,您可以與代碼一起提交以引導構建過程。 有關詳細信息,請參閱docs.gradle.org/4.2.1/userguide/gradle_wrapper.html。
10.2 安裝Spring Boot CLI
Spring Boot CLI(命令行界面)是一個命令行工具,您可以使用它來快速使用Spring進行原型設計。 它允許您運行Groovy腳本,這意味着您擁有熟悉的類似Java的語法,而沒有太多的參考代碼。
您不需要使用CLI來使用Spring Boot,但它絕對是實現Spring應用程序的最快方法
手動安裝
您可以從Spring軟件庫下載Spring CLI發行版:
還提供最新的快照鏡像。
下載完成後,請按照解壓縮的存檔中的INSTALL.txt說明進行操作。 總之,.zip文件中的bin /目錄中有一個spring腳本(用於Windows的spring.bat)。 或者,您可以將java -jar與.jar文件一起使用(該腳本可幫助您確保正確設置類路徑)。
使用SDKMAN安裝!
SDKMAN! (軟件開發工具包管理器)可用於管理各種二進制SDK的多個版本,包括Groovy和Spring Boot CLI。 獲取SDKMAN! 從sdkman.io中,使用以下命令安裝Spring Boot:
$ sdk install springboot
$ spring --version
Spring Boot v2.1.0.RELEASE
如果您爲CLI開發功能並希望輕鬆訪問您構建的版本,請使用以下命令:
$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-2.1.0.RELEASE-bin/spring-2.1.0.RELEASE/
$ sdk default springboot dev
$ spring --version
Spring CLI v2.1.0.RELEASE
前面的說明安裝了一個名爲dev實例的spring的本地實例。 它指向您的目標構建位置,因此每次重建Spring Boot時,spring都是最新的。
您可以通過運行以下命令來查看它:
$ sdk ls springboot
================================================================================
Available Springboot Versions
================================================================================
> + dev
* 2.1.0.RELEASE
================================================================================
+ - local version
* - installed
> - currently in use
================================================================================
OSX Homebrew安裝
如果您使用的是Mac並使用Homebrew,則可以使用以下命令安裝Spring Boot CLI:
$ brew tap pivotal/tap
$ brew install springboot
Homebrew將spring安裝到/usr/local/bin.
注意事項
如果您沒有看到公式,那麼您的brew安裝可能已過時。 在這種情況下,請運行brew update並再試一次。
MacPorts安裝
如果您使用的是Mac並使用MacPorts,則可以使用以下命令安裝Spring Boot CLI:
$ sudo port install spring-boot-cli
命令行補全
Spring Boot CLI包含爲BASH和zsh shell提供命令完成的腳本。 您可以在任何shell中獲取腳本(也稱爲spring),或者將其放入個人或系統範圍的bash完成初始化中。 在Debian系統上,系統範圍的腳本位於/ shell-completion / bash中,當新shell啓動時,該目錄中的所有腳本都會執行。 例如,要使用SDKMAN!安裝,請手動運行腳本,請使用以下命令:
$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring <HIT TAB HERE>
grab help jar run test version
注意事項
如果使用Homebrew或MacPorts安裝Spring Boot CLI,則命令行完成腳本會自動註冊到shell。
Windows Scoop安裝
如果您使用的是Windows並使用Scoop,則可以使用以下命令安裝Spring Boot CLI:
> scoop bucket add extras
> scoop install springboot
Scoop 安裝 spring 到 ~/scoop/apps/springboot/current/bin.
注意事項
如果您沒有看到應用清單,則您的scoop安裝可能已過時。 在這種情況下,運行scoop update並再試一次。
快速啓動Spring CLI示例
您可以使用以下Web應用程序來測試您的安裝。 首先,創建一個名爲app.groovy的文件,如下所示:
@RestController
class ThisWillActuallyRun {
@RequestMapping("/")
String home() {
"Hello World!"
}
}
然後從shell運行它,如下所示:
$ spring run app.groovy
注意事項
隨着依賴項的下載,應用程序的第一次運行速度很慢。 後續運行要快得多。
在您喜歡的Web瀏覽器中打開localhost:8080。 您應該看到以下輸出:
Hello World!
10.3 從早期版本的Spring Boot升級
如果要從早期版本的Spring Boot升級,請查看項目Wiki上的“遷移指南”,其中提供了詳細的升級說明。 另請查看“發行說明”,瞭解每個版本的“新的和值得注意的”功能列表。
升級到新功能版本時,某些屬性可能已重命名或刪除。 Spring Boot提供了一種在啓動時分析應用程序環境和打印診斷的方法,還可以在運行時臨時遷移屬性。 要啓用該功能,請將以下依賴項添加到項目中:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-properties-migrator</artifactId>
<scope>runtime</scope>
</dependency>
警告
添加到環境後期的屬性(例如使用@PropertySource時)將不會被考慮在內。
注意事項
完成遷移後,請確保從項目的依賴項中刪除此模塊。
要升級現有CLI安裝,請使用相應的軟件包管理器命令(例如,brew upgrade),或者,如果手動安裝CLI,請按照標準說明操作,記住更新PATH環境變量以刪除任何舊引用。
開發您的第一個Spring Boot應用程序
本節介紹如何開發一個簡單的“Hello World!”Web應用程序,該應用程序突出了Spring Boot的一些主要功能。 我們使用Maven來構建這個項目,因爲大多數IDE都支持它。
提示
spring.io網站包含許多使用Spring Boot的“入門”指南。 如果您需要解決指定的問題,請先檢查一下。
您可以通過轉到start.spring.io並從依賴關係搜索器中選擇“Web”啓動器來快捷執行以下步驟。 這樣做會生成一個新的項目結構,以便您可以立即開始編碼。 有關更多詳細信息,請查看Spring Initializr文檔。
在開始之前,打開終端並運行以下命令以確保安裝了有效的Java和Maven版本:
$ java -version
java version "1.8.0_102"
Java(TM) SE Runtime Environment (build 1.8.0_102-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.102-b14, mixed mode)
$ mvn -v
Apache Maven 3.5.4 (1edded0938998edf8bf061f1ceb3cfdeccf443fe; 2018-06-17T14:33:14-04:00)
Maven home: /usr/local/Cellar/maven/3.3.9/libexec
Java version: 1.8.0_102, vendor: Oracle Corporation
注意事項
此示例需要在其自己的文件夾中創建。 後續說明假如您已創建了合適的文件夾,並且它在您當前的目錄中。
11.1 創建POM
我們需要從創建Maven pom.xml文件開始。 pom.xml是用於構建項目的配置。 打開您喜歡的文本編輯器並添加以下內容:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>myproject</artifactId>
<version>0.0.1-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.0.RELEASE</version>
</parent>
<!-- 這裏還要添加其他行... -->
</project>
上面的清單應該爲您提供有效的構建。 您可以通過運行mvn包來測試它(現在,您可以忽略“jar將爲空 - 沒有內容被標記爲包含!”警告)。
注意事項
此時,您可以將項目導入IDE(大多數現代Java IDE包括對Maven的內置支持)。 爲簡單起見,我們繼續爲此示例使用純文本編輯器。
11.2 添加Classpath依賴項
Spring Boot提供了許多“Starters”,可以將jar添加到類路徑中。 我們的示例應用程序已經在POM的父節中使用了spring-boot-starter-parent。 spring-boot-starter-parent是一個特殊的啓動器,提供有用的Maven默認值。 它還提供了一個依賴項管理部分,以便您可以省略“blessed”依賴項的版本標記。
其他“Starters”提供了在開發特定類型的應用程序時可能需要的依賴項。 由於我們正在開發Web應用程序,因此我們添加了spring-boot-starter-web依賴項。 在此之前,我們可以通過運行以下命令來查看當前的內容:
$ mvn dependency:tree
[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
mvn dependency:tree命令打印項目依賴項的樹表示。 您可以看到spring-boot-starter-parent本身不提供依賴關係。 要添加必要的依賴項,請編輯pom.xml並在父節下面添加spring-boot-starter-web依賴項:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
如果再次運行mvn dependency:tree,您會看到現在有許多其他依賴項,包括Tomcat Web服務器和Spring Boot本身。
編寫代碼
要完成我們的應用程序,我們需要創建一個Java文件。 默認情況下,Maven從src / main / java編譯源代碼,因此您需要創建該文件夾結構,然後添加名爲src / main / java / Example.java的文件以包含以下代碼:
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.web.bind.annotation.*;
@RestController
@EnableAutoConfiguration
public class Example {
@RequestMapping("/")
String home() {
return "Hello World!";
}
public static void main(String[] args) throws Exception {
SpringApplication.run(Example.class, args);
}
}
雖然這裏的代碼不多,但還是有很多代碼。 我們將在接下來的幾節中逐步介紹重要部分。
@RestController和@RequestMapping註解
我們的Example類的第一個註釋是@RestController。 這被稱爲構造型註釋。 它爲閱讀代碼的人提供了提示,而對於Spring來說,該類扮演着特定的角色。 在這種情況下,我們的類是一個Web @Controller,所以Spring在處理傳入的Web請求時會考慮它。
@RequestMapping註釋提供“路由”信息。 它告訴Spring,任何帶有/ path的HTTP請求都應該映射到home方法。 @RestController註釋告訴Spring將結果字符串直接渲染回調用者。
提示
@RestController和@RequestMapping註釋是Spring MVC註釋。 (它們不是特定於Spring Boot的。)有關更多詳細信息,請參閱Spring參考文檔中的MVC部分。
@EnableAutoConfiguration註解
第二個類級註釋是@EnableAutoConfiguration。 這個註釋告訴Spring Boot根據你添加的jar依賴關係“猜測”你想要如何配置Spring。 由於spring-boot-starter-web添加了Tomcat和Spring MVC,因此自動配置假定您正在開發Web應用程序並相應地設置Spring。
啓動器和自動配置
自動配置旨在與“啓動器”配合使用,但這兩個概念並不直接相關。 您可以自由選擇並在首發之外選擇jar依賴項。 Spring Boot仍然盡力自動配置您的應用程序。
“main” 方法
我們的應用程序的最後一部分是main方法。 這只是遵循應用程序入口點的Java約定的標準方法。 我們的main方法通過調用run來委託Spring Boot的SpringApplication類。 SpringApplication引導我們的應用程序,啓動Spring,然後啓動自動配置的Tomcat Web服務器。 我們需要將Example.class作爲參數傳遞給run方法,以告訴SpringApplication是主要的Spring組件。 args數組也被傳遞以暴露任何命令行參數。
11.4 運行示例
此時,您的應用程序應該可以工作。 由於您使用了spring-boot-starter-parent POM,因此您可以使用一個有用的運行目標來啓動應用程序。 鍵入mvn spring-boot:從根項目目錄運行以啓動應用程序。 您應該看到類似於以下內容的輸出:
$ mvn spring-boot:run
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.1.0.RELEASE)
....... . . .
....... . . . (log output here)
....... . . .
........ Started Example in 2.222 seconds (JVM running for 6.514)
通過遊覽器打開localhost:8080,你將看到一下輸出:
Hello World!
要正常退出應用程序,請按ctrl-c。
11.5 創建一個可執行的Jar
我們通過創建一個完全自包含的可執行jar文件來完成我們的示例,我們可以在生產中運行它。 可執行jar(有時稱爲“fat jar”)是包含已編譯類以及代碼需要運行的所有jar依賴項的歸檔。
可執行的jar和Java
Java沒有提供加載嵌套jar文件的標準方法(jar文件本身包含在jar中)。 如果您要分發自包含的應用程序,這可能會有問題。
爲了解決這個問題,許多開發人員使用“buer”jar。 uber jar將所有應用程序依賴項中的所有類打包到一個存檔中。 這種方法的問題在於很難看出應用程序中有哪些庫。 如果在多個jar中使用相同的文件名(但具有不同的內容),也可能會有問題。
Spring Boot採用不同的方法,讓你直接嵌套jar。
要創建可執行jar,我們需要將spring-boot-maven-plugin添加到我們的pom.xml中。 爲此,請在依賴項部分下方插入以下行:
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
注意事項
spring-boot-starter-parent POM包含<executions>配置以綁定重新打包目標。 如果您不使用父POM,則需要自己聲明此配置。 有關詳細信息,請參閱插件文檔。
保存pom.xml並從命令行運行mvn package,如下所示:
$ mvn package
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building myproject 0.0.1-SNAPSHOT
[INFO] ------------------------------------------------------------------------
[INFO] .... ..
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ myproject ---
[INFO] Building jar: /Users/developer/example/spring-boot-example/target/myproject-0.0.1-SNAPSHOT.jar
[INFO]
[INFO] --- spring-boot-maven-plugin:2.1.0.RELEASE:repackage (default) @ myproject ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
如果查看目標目錄,則應該看到myproject-0.0.1-SNAPSHOT.jar。 該文件大小應爲10 MB左右。 如果你想查看內部,你可以使用jar tvf,如下所示:
$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar
您還應該在目標目錄中看到名爲myproject-0.0.1-SNAPSHOT.jar.original的小得多的文件。 這是Maven在Spring Boot重新打包之前創建的原始jar文件。
要運行該應用程序,請使用java -jar命令,如下所示:
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.1.0.RELEASE)
....... . . .
....... . . . (log output here)
....... . . .
........ Started Example in 2.536 seconds (JVM running for 2.864)
和之前一樣,要退出應用程序,請按ctrl-c。
12. 接下來要閱讀的內容
希望本節提供了一些Spring Boot基礎知識,讓您開始編寫自己的應用程序。 如果您是面向任務的開發人員類型,您可能希望跳轉到spring.io並查看一些入門指南,這些指南解決了特定的“我如何使用Spring?”問題。 我們還有特定於Spring Boot的“操作方法”參考文檔。
Spring Boot存儲庫還有一堆可以運行的示例。 樣本獨立於其餘代碼(也就是說,您無需構建其餘代碼來運行或使用示例)。
否則,下一步是閱讀 Part III, “使用Spring Boot”.如果你真的很不耐煩,你也可以跳過去閱讀有關Spring Boot功能的內容。