SpringBoot2.x入门:引入web模块

Stella981
• 阅读 578

前提

这篇文章是《SpringBoot2.x入门》专辑的第3篇文章,使用的SpringBoot版本为2.3.1.RELEASEJDK版本为1.8

主要介绍SpringBootweb模块引入,会相对详细地分析不同的Servlet容器(如TomcatJetty等)的切换,以及该模块提供的SpringMVC相关功能的使用。

依赖引入

笔者新建了一个多模块的Maven项目,这次的示例是子模块ch1-web-module

SpringBootweb模块实际上就是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容器是嵌入式(EmbeddedTomcat,配合打包成一个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:设置映射参数,包括请求方法、请求的路径、接收或者响应的内容类型等等,衍生注解为GetMappingPostMappingPutMappingDeleteMappingPatchMapping
  • @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模式启动一下:

SpringBoot2.x入门:引入web模块

Tomcat默认的启动端口是8080,启动完毕后见日志如下:

SpringBoot2.x入门:引入web模块

用用浏览器访问http://localhost:8080/ch1/hello?name=thrwoable可见输出如下:

SpringBoot2.x入门:引入web模块

至此,一个简单的基于spring-boot-starter-web开发的web应用已经完成。

切换Servlet容器

有些时候由于项目需要、运维规范或者个人喜好,并不一定强制要求使用Tomcat作为Servlet容器,常见的其他选择有JettyUndertow,甚至Netty等。以JettyUndertow为例,切换为其他嵌入式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>

SpringBoot2.x入门:引入web模块

**切换为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>

SpringBoot2.x入门:引入web模块

小结

这篇文章主要分析了如何基于SpringBoot搭建一个入门的web服务,还简单介绍了一些常用的SpringMVC注解的功能,最后讲解如何基于spring-boot-starter-web切换底层的Servlet容器。学会搭建MVC应用后,就可以着手尝试不同的请求方法或者参数,尝试常用注解的功能。

代码仓库

这里给出本文搭建的web模块的SpringBoot应用的仓库地址(持续更新):

(本文完 c-2-d e-a-20200703 23:09 PM)

技术公众号《Throwable文摘》(id:throwable-doge),不定期推送笔者原创技术文章(绝不抄袭或者转载):

SpringBoot2.x入门:引入web模块

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
2个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Java修道之路,问鼎巅峰,我辈代码修仙法力齐天
<center<fontcolor00FF7Fsize5face"黑体"代码尽头谁为峰,一见秃头道成空。</font<center<fontcolor00FF00size5face"黑体"编程修真路破折,一步一劫渡飞升。</font众所周知,编程修真有八大境界:1.Javase练气筑基2.数据库结丹3.web前端元婴4.Jav
Stella981 Stella981
2年前
Python之time模块的时间戳、时间字符串格式化与转换
Python处理时间和时间戳的内置模块就有time,和datetime两个,本文先说time模块。关于时间戳的几个概念时间戳,根据1970年1月1日00:00:00开始按秒计算的偏移量。时间元组(struct_time),包含9个元素。 time.struct_time(tm_y
Stella981 Stella981
2年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Easter79 Easter79
2年前
SpringBoot2.x入门:引入web模块
前提这篇文章是《SpringBoot2.x入门》专辑的第3篇文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8。主要介绍SpringBoot的web模块引入,会相对详细地分析不同的Servlet容器(如Tomcat、Jetty等)的切换,以及该模块提供的Spring
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
8个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这