前提
這篇文章是《SpringBoot2.x入門》專輯的第3篇文章,使用的SpringBoot
版本為2.3.1.RELEASE
,JDK
版本為1.8
。
主要介紹SpringBoot
的web
模塊引入,會相對詳細地分析不同的Servlet
容器(如Tomcat
、Jetty
等)的切換,以及該模塊提供的SpringMVC
相關功能的使用。
依賴引入
筆者新建了一個多模塊的Maven
項目,這次的示例是子模塊ch1-web-module
。
SpringBoot
的web
模塊實際上就是spring-boot-starter-web
組件(下稱web
模塊),前面的文章介紹過使用BOM
全局管理版本,可以在(父)POM
文件中添加dependencyManagement
元素:
<properties>
<spring.boot.version>2.3.1.RELEASE</spring.boot.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring.boot.version}</version>
<scope>import</scope>
<type>pom</type>
</dependency>
</dependencies>
</dependencyManagement>
接來下在(子)POM
文件中的dependencies
元素引入spring-boot-starter-web
的依賴:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
項目的子POM
大致如下:
<?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>
<parent>
<groupId>club.throwable</groupId>
<artifactId>spring-boot-guide</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>ch1-web-module</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>ch1-web-module</name>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
<build>
<finalName>ch1-web-module</finalName>
<!-- 引入spring-boot-maven-plugin以便項目打包 -->
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${spring.boot.version}</version>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>
spring-boot-starter-web
模塊中默認使用的Servlet
容器是嵌入式(Embedded
)Tomcat
,配合打包成一個Jar
包以便可以直接使用java -jar xxx.jar
命令啟動。
SpringMVC的常用注解
web
模塊集成和擴展了SpringMVC
的功能,移除但兼容相對臃腫的XML
配置,這里簡單列舉幾個常用的Spring
或者SpringMVC
提供的注解,簡單描述各個注解的功能:
組件注解:
@Component
:標記一個類為Spring
組件,掃描階段注冊到IOC
容器。@Repository
:標記一個類為Repository
(倉庫)組件,它的元注解為@Component
,一般用於DAO
層。@Service
:標記一個類為Service
(服務)組件,它的元注解為@Component
。@Controller
:標記一個類為Controller
(控制器)組件,它的元注解為@Component
,一般控制器是訪問的入口,衍生注解@RestController
,簡單理解為@Controller
標記的控制器內所有方法都加上下面提到的@ResponseBody
。
參數注解:
@RequestMapping
:設置映射參數,包括請求方法、請求的路徑、接收或者響應的內容類型等等,衍生注解為GetMapping
、PostMapping
、PutMapping
、DeleteMapping
、PatchMapping
。@RequestParam
:聲明一個方法參數綁定到一個請求參數。@RequestBody
:聲明一個方法參數綁定到請求體,常用於內容類型為application/json
的請求體接收。@ResponseBody
:聲明一個方法返回值綁定到響應體。@PathVariable
:聲明一個方法參數綁定到一個URI
模板變量,用於提取當前請求URI
中的部分到方法參數中。
編寫控制器和啟動類
在項目中編寫一個控制器club.throwable.ch1.controller.HelloController
如下:
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import java.util.Optional;
@Slf4j
@Controller
@RequestMapping(path = "/ch1")
public class HelloController {
@RequestMapping(path = "/hello")
public ResponseEntity<String> hello(@RequestParam(name = "name") String name) {
String value = String.format("[%s] say hello", name);
log.info("調用[/hello]接口,參數:{},響應結果:{}", name, value);
return ResponseEntity.of(Optional.of(value));
}
}
HelloController
只提供了一個接收GET
請求且請求的路徑為/ch1/hello
的方法,它接收一個名稱為name
的參數(參數必傳),然后返回簡單的文本:${name} say hello
。可以使用衍生注解簡化如下:
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import java.util.Optional;
@Slf4j
@RestController
@RequestMapping(path = "/ch1")
public class HelloController {
@GetMapping(path = "/hello")
public ResponseEntity<String> hello(@RequestParam(name = "name") String name) {
String value = String.format("[%s] say hello", name);
log.info("調用[/hello]接口,參數:{},響應結果:{}", name, value);
return ResponseEntity.of(Optional.of(value));
}
}
接着編寫一個啟動類club.throwable.ch1.Ch1Application
,啟動類是SpringBoot
應用程序的入口,需要提供一個main
方法:
package club.throwable.ch1;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class Ch1Application {
public static void main(String[] args) {
SpringApplication.run(Ch1Application.class, args);
}
}
然后以DEBUG
模式啟動一下:
Tomcat
默認的啟動端口是8080
,啟動完畢后見日志如下:
用用瀏覽器訪問http://localhost:8080/ch1/hello?name=thrwoable
可見輸出如下:
至此,一個簡單的基於spring-boot-starter-web
開發的web
應用已經完成。
切換Servlet容器
有些時候由於項目需要、運維規范或者個人喜好,並不一定強制要求使用Tomcat
作為Servlet
容器,常見的其他選擇有Jetty
、Undertow
,甚至Netty
等。以Jetty
和Undertow
為例,切換為其他嵌入式Servlet
容器需要從spring-boot-starter-web
中排除Tomcat
的依賴,然后引入對應的Servlet
容器封裝好的starter
。
切換為Jetty
,修改POM
文件中的dependencies
元素:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐jetty</artifactId>
</dependency>
切換為Undertow
,修改POM
文件中的dependencies
元素:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<exclusions>
<exclusion>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring‐boot‐starter‐undertow</artifactId>
</dependency>
小結
這篇文章主要分析了如何基於SpringBoot
搭建一個入門的web
服務,還簡單介紹了一些常用的SpringMVC
注解的功能,最后講解如何基於spring-boot-starter-web
切換底層的Servlet
容器。學會搭建MVC
應用后,就可以着手嘗試不同的請求方法或者參數,嘗試常用注解的功能。
代碼倉庫
這里給出本文搭建的web
模塊的SpringBoot
應用的倉庫地址(持續更新):
(本文完 c-2-d e-a-20200703 23:09 PM)
技術公眾號《Throwable文摘》(id:throwable-doge),不定期推送筆者原創技術文章(絕不抄襲或者轉載):