Spring Boot已成為當今最流行的微服務開發框架,本文是如何使用Spring Boot快速開始Web微服務開發的指南,我們將使創建一個可運行的包含內嵌Web容器(預設使用的是Tomcat)的可運行Jar包。 傳統的Spring應用程式需要配置大量的XML文件才能運行,而使用Spring Boo ...
Spring Boot已成為當今最流行的微服務開發框架,本文是如何使用Spring Boot快速開始Web微服務開發的指南,我們將使創建一個可運行的包含內嵌Web容器(預設使用的是Tomcat)的可運行Jar包。
傳統的Spring應用程式需要配置大量的XML文件才能運行,而使用Spring Boot只需極少的配置,就可以快速獲得一個正常運行的Spring應用程式,而這些配置使用的都是註解的形式,不需要再配置XML。
與Go語言的應用不同,我們知道所有的Java Web應用都必須放在servlet容器(不是像docker容器的那種容器),如Tomcat、Jetty等。Servlet容器被定位為托管web應用程式的高可用組件。
使用Java構建微服務併發布到Kubernetes平臺
Java作為多年的編程語言屆的No.1(使用人數最多,最流行),使用它來構建微服務的人也不計其數,Java的微服務框架Spring中的Spring Boot和Spring Cloud已成為當前最流行的微服務框架。
下麵是Sping技術棧所包含的技術框架圖。
當然如果在Kubernetes中運行Java語言構建的微服務應用,我們不會使用上圖中所有的技術,本節將主要講解如何使用Spring Boot構建微服務應用。
Spring的基本原理
Spring是一套Java開發框架,框架的作用就是為了減少代碼的冗餘和模塊之間的偶爾,使代碼邏輯更加清晰,主要是用了AOP(Aspect Oriented Programming,面向切麵編程)和IoC(Inversion of Control,控制反轉)容器的思想,其中AOP是利用了Java的反射機制實現的。為了便於理解AOP可以參考一個簡單的Spring的AOP例子。
準備環境
在開始Spring Boot開發之前,需要先確認您的電腦上已經有以下環境:
- JDK8
- Maven3.0+
- Intellij IDEA
JDK最好使用JDK8版本,Maven和IDEA的安裝都十分簡單,Maven的倉庫配置有必要說一下。
配置Maven
在安裝好Maven之後,預設的~/.m2
目錄下是沒有maven倉庫配置文件settings.xml
的,預設使用的是官方的倉庫,訪問速度會非常慢,我們需要配置下國內的倉庫。
創建~/.m2/settings.xml
文件,文件內容如下:
<?xml version="1.0"?> <settings> <mirrors> <mirror> <id>alimaven</id> <name>aliyun maven</name> <url>http://maven.aliyun.com/nexus/content/groups/public/</url> <mirrorOf>central</mirrorOf> </mirror> </mirrors> <profiles> <profile> <id>nexus</id> <repositories> <repository> <id>nexus</id> <name>local private nexus</name> <url>http://maven.oschina.net/content/groups/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>nexus</id> <name>local private nexus</name> <url>http://maven.oschina.net/content/groups/public/</url> <releases> <enabled>true</enabled> </releases> <snapshots> <enabled>false</enabled> </snapshots> </pluginRepository> </pluginRepositories> </profile></profiles> </settings>
其中使用的是阿裡雲的mirror,國內的下載速度非常快。
創建第一個Spring Boot應用
我們可以使用以下兩種方式創建Spring Boot應用:
- springboot
- maven
使用springboot命令創建Spring Boot應用
首先需要安裝springboot
命令行工具。
brew tap pivotal/tap brew install springboot
使用下麵的命令創建應用。
spring init --build maven --groupId com.example --version 0.0.1-SNAPSHOT --java-version 1.8 --dependencies web --name myproject myproject
--build
使用maven編譯或者是gradle--groupId
和--version
與maven的pom.xml
中的設置對應--dependencies
可以指定多個,如web
、jpa
、security
等starter
執行上述命令後,將創建如下的目錄結構:
. └── myproject ├── mvnw ├── mvnw.cmd ├── pom.xml └── src ├── main │ ├── java │ │ └── com │ │ └── example │ │ └── myproject │ │ └── MyprojectApplication.java │ └── resources │ ├── application.properties │ ├── static │ └── templates └── test └── java └── com └── example └── myproject └── MyprojectApplicationTests.java 15 directories, 6 files
運行預設的示例應用。
mvn spring-boot:run
第一次運行需要下載依賴包所以會比較耗費時間,以後每次編譯運行速度就會很快。
在瀏覽器中訪問localhost:8080將看到如下輸出:
Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback. Mon Mar 12 16:26:42 CST 2018 There was an unexpected error (type=Not Found, status=404). No message available
使用Maven創建Spring Boot應用
使用Maven創建Spring Boot應用需要執行以下步驟:
- 創建Maven工程所需的
pom.xml
文件 - 生成Maven工程
- 編譯打包發佈
創建pom.xml
為Maven項目構建創建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>1.4.1.BUILD-SNAPSHOT</version> </parent> <repositories> <repository> <id>spring-snapshots</id> <url>http://repo.spring.io/snapshot</url> <snapshots><enabled>true</enabled></snapshots> </repository> <repository> <id>spring-milestones</id> <url>http://repo.spring.io/milestone</url> </repository> </repositories> <pluginRepositories> <pluginRepository> <id>spring-snapshots</id> <url>http://repo.spring.io/snapshot</url> </pluginRepository> <pluginRepository> <id>spring-milestones</id> <url>http://repo.spring.io/milestone</url> </pluginRepository> </pluginRepositories> <!-- 添加classpath依賴 --> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- 開發者工具,當classpath下有文件更新自動觸發應用重啟 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> </dependencies> <!-- maven編譯插件,用於創建可執行jar包 --> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
現在執行mvn dependency:tree
可以看到項目中的依賴關係。
com.example:myproject:jar:0.0.1-SNAPSHOT \- org.springframework.boot:spring-boot-starter-web:jar:1.4.1.BUILD-SNAPSHOT:compile +- org.springframework.boot:spring-boot-starter:jar:1.4.1.BUILD-SNAPSHOT:compile | +- org.springframework.boot:spring-boot:jar:1.4.1.BUILD-SNAPSHOT:compile | +- org.springframework.boot:spring-boot-autoconfigure:jar:1.4.1.BUILD-SNAPSHOT:compile | +- org.springframework.boot:spring-boot-starter-logging:jar:1.4.1.BUILD-SNAPSHOT:compile | | +- ch.qos.logback:logback-classic:jar:1.1.7:compile | | | +- ch.qos.logback:logback-core:jar:1.1.7:compile | | | \- org.slf4j:slf4j-api:jar:1.7.21:compile | | +- org.slf4j:jcl-over-slf4j:jar:1.7.21:compile | | +- org.slf4j:jul-to-slf4j:jar:1.7.21:compile | | \- org.slf4j:log4j-over-slf4j:jar:1.7.21:compile | +- org.springframework:spring-core:jar:4.3.3.RELEASE:compile | \- org.yaml:snakeyaml:jar:1.17:runtime +- org.springframework.boot:spring-boot-starter-tomcat:jar:1.4.1.BUILD-SNAPSHOT:compile | +- org.apache.tomcat.embed:tomcat-embed-core:jar:8.5.5:compile | +- org.apache.tomcat.embed:tomcat-embed-el:jar:8.5.5:compile | \- org.apache.tomcat.embed:tomcat-embed-websocket:jar:8.5.5:compile +- org.hibernate:hibernate-validator:jar:5.2.4.Final:compile | +- javax.validation:validation-api:jar:1.1.0.Final:compile | +- org.jboss.logging:jboss-logging:jar:3.3.0.Final:compile | \- com.fasterxml:classmate:jar:1.3.1:compile +- com.fasterxml.jackson.core:jackson-databind:jar:2.8.3:compile | +- com.fasterxml.jackson.core:jackson-annotations:jar:2.8.3:compile | \- com.fasterxml.jackson.core:jackson-core:jar:2.8.3:compile +- org.springframework:spring-web:jar:4.3.3.RELEASE:compile | +- org.springframework:spring-aop:jar:4.3.3.RELEASE:compile | +- org.springframework:spring-beans:jar:4.3.3.RELEASE:compile | \- org.springframework:spring-context:jar:4.3.3.RELEASE:compile \- org.springframework:spring-webmvc:jar:4.3.3.RELEASE:compile \- org.springframework:spring-expression:jar:4.3.3.RELEASE:compile
這其中包括Tomcat web伺服器和Spring Boot自身。
Spring Boot 推薦的基礎 POM 文件
名稱 | 說明 |
---|---|
spring-boot-starter | 核心 POM,包含自動配置支持、日誌庫和對 YAML 配置文件的支持。 |
spring-boot-starter-amqp | 通過 spring-rabbit 支持 AMQP。 |
spring-boot-starter-aop | 包含 spring-aop 和 AspectJ 來支持面向切麵編程(AOP)。 |
spring-boot-starter-batch | 支持 Spring Batch,包含 HSQLDB。 |
spring-boot-starter-data-jpa | 包含 spring-data-jpa、spring-orm 和 Hibernate 來支持 JPA。 |
spring-boot-starter-data-mongodb | 包含 spring-data-mongodb 來支持 MongoDB。 |
spring-boot-starter-data-rest | 通過 spring-data-rest-webmvc 支持以 REST 方式暴露 Spring Data 倉庫。 |
spring-boot-starter-jdbc | 支持使用 JDBC 訪問資料庫。 |
spring-boot-starter-security | 包含 spring-security。 |
spring-boot-starter-test | 包含常用的測試所需的依賴,如 JUnit、Hamcrest、Mockito 和 spring-test 等。 |
spring-boot-starter-velocity | 支持使用 Velocity 作為模板引擎。 |
spring-boot-starter-web | 支持 Web 應用開發,包含 Tomcat 和 spring-mvc。 |
spring-boot-starter-websocket | 支持使用 Tomcat 開發 WebSocket 應用。 |
spring-boot-starter-ws | 支持 Spring Web Services。 |
spring-boot-starter-actuator | 添加適用於生產環境的功能,如性能指標和監測等功能。 |
spring-boot-starter-remote-shell | 添加遠程 SSH 支持。 |
spring-boot-starter-jetty | 使用 Jetty 而不是預設的 Tomcat 作為應用伺服器。 |
spring-boot-starter-log4j | 添加 Log4j 的支持。 |
spring-boot-starter-logging | 使用 Spring Boot 預設的日誌框架 Logback。 |
spring-boot-starter-tomcat | 使用 Spring Boot 預設的 Tomcat 作為應用伺服器。 |
所有這些 POM 依賴的好處在於為開發 Spring 應用提供了一個良好的基礎。Spring Boot 所選擇的第三方庫是經過考慮的,是比較適合產品開發的選擇。但是 Spring Boot 也提供了不同的選項,比如日誌框架可以用 Logback 或 Log4j,應用伺服器可以用 Tomcat 或 Jetty。
生成Maven工程
對於普通的Java項目或者Java Web項目可以使用下麵的命令創建maven結構:
mvn archetype:generate -DgroupId=com.example -DartifactId=myproject -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false
下表是以上參數的使用說明:
參數 | 說明 |
---|---|
mvn archetype:generate | 固定格式 |
-DgroupId | 組織標識(包名) |
-DartifactId | 項目名稱 |
-DarchetypeArtifactId | 指定ArchetypeId,maven-archetype-quickstart,創建一個Java Project;maven-archetype-webapp,創建一個Web Project |
-DinteractiveMode | 是否使用交互模式 |
這將生成以下的目錄結構:
. └── myproject ├── pom.xml └── src └── main ├── resources └── webapp ├── WEB-INF │ └── web.xml └── index.jsp 6 directories, 3 files
對於Spring Boot項目,無法使用mvn
命令直接生成,需要手動創建目錄:
mkdir -p src/main/java
創建示例代碼
創建src/main/java/Example.java
文件內容如下:
import org.springframework.boot.*; import org.springframework.boot.autoconfigure.*; import org.springframework.stereotype.*; 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
註解告訴Spring以字元串的形式渲染結果,並直接返回給調用者。@EnableAutoConfiguration
註解告訴Spring Boot根據添加的jar依賴猜測你想如何配置Spring。由於spring-boot-starter-web
添加了Tomcat和Spring MVC,所以auto-configuration將假定你正在開發一個web應用,並對Spring進行相應地設置。@RequestMapping
註解提供路由信息,它告訴Spring任何來自”/“路徑的HTTP請求都應該被映射到home
方法。
註:@RestController
和@RequestMapping
是Spring MVC中的註解(它們不是Spring Boot的特定部分)。
編譯和發佈
運行該項目有以下兩種方式。
方式1:直接mvn命令運行
mvn spring-boot:run
方式2:編譯打包成可執行jar包
mvn package java -jar target/myproject-0.0.1-SNAPSHOT.jar
不論使用哪種方式編譯,訪問localhost:8080可以看到web頁面上顯示Hello world!
。
在target
目錄下,你應該還能看到一個很小的名為myproject-0.0.1-SNAPSHOT.jar.original
的文件,這是在Spring Boot重新打包前,Maven創建的原始jar文件。實際上可運行jar包中包含了這個小的jar包。
我有一個微信公眾號,經常會分享一些Java技術相關的乾貨;如果你喜歡我的分享,可以用微信搜索“Java團長”或者“javatuanzhang”關註。
參考
- Spring官方網站
- Spring core technologies | spring.io
- Spring Boot——開發新一代Spring Java應用
- Spring MVC快速入門教程
- Spring Boot Reference Guide中文翻譯 -《Spring Boot參考指南》
- 使用 Spring Boot 快速構建 Spring 框架應用
- maven3常用命令、java項目搭建、web項目搭建詳細圖解
- Servlet教程 | runoob.com
- AOP - Aspect Oriented Programming | spring.io
- Spring Boot 入門之基礎篇(一)
- spring boot(一):入門篇
- SpringBoot入門系列:第一篇 Hello World