SpringBoot2.x入门:引入web模块

简介: 这篇文章是《SpringBoot2.x入门》专辑的「第3篇」文章,使用的SpringBoot版本为2.3.1.RELEASE,JDK版本为1.8。主要介绍SpringBoot的web模块引入,会相对详细地分析不同的Servlet容器(如Tomcat、Jetty等)的切换,以及该模块提供的SpringMVC相关功能的使用。

微信截图_20220513113615.png


前提



这篇文章是《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模式启动一下:


微信截图_20220513113624.png


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


微信截图_20220513113630.png


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


微信截图_20220513113638.png


至此,一个简单的基于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>
复制代码


微信截图_20220513113646.png


切换为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>
复制代码


微信截图_20220513113654.png


小结



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


代码仓库



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



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

相关文章
|
24天前
|
前端开发
【前端web入门第四天】02 CSS三大特性+背景图
本文详细介绍了CSS的三大特性:继承性、层叠性和优先级,并深入讲解了背景图的相关属性,包括背景属性、背景图的平铺方式、位置设定、缩放、固定以及复合属性。其中,继承性指子元素自动继承父元素的文字控制属性;层叠性指相同属性后定义覆盖前定义,不同属性可叠加;优先级涉及选择器权重,包括行内样式、ID选择器等。背景图部分则通过具体示例展示了如何设置背景图像的位置、大小及固定方式等。
239 91
|
9天前
|
前端开发 开发者 Python
从零到一:Python Web框架中的模板引擎入门与进阶
在Web开发的广阔世界里,模板引擎是连接后端逻辑与前端展示的重要桥梁。对于Python Web开发者而言,掌握模板引擎的使用是从零到一构建动态网站或应用不可或缺的一步。本文将带你从基础入门到进阶应用,深入了解Python Web框架中的模板引擎。
14 3
|
23天前
|
前端开发
【前端web入门第五天】03 清除默认样式与外边距问题【附综合案例产品卡片与新闻列表】
本文档详细介绍了CSS中清除默认样式的方法,包括清除内外边距、列表项目符号等;探讨了外边距的合并与塌陷问题及其解决策略;讲解了行内元素垂直边距的处理技巧;并介绍了圆角与盒子阴影效果的实现方法。最后通过产品卡片和新闻列表两个综合案例,展示了所学知识的实际应用。
30 11
|
23天前
|
前端开发
|
23天前
|
弹性计算 前端开发 容器
【前端web入门第六天】02 flex布局
Flex布局是一种现代CSS布局模式,通过给父元素设置`display: flex`,其子元素可自动挤压或拉伸。它包含弹性容器和弹性盒子,主轴默认为水平方向,侧轴为垂直方向。主轴对齐方式由`justify-content`属性控制,侧轴对齐方式包括`align-items`(针对所有子元素)和`align-self`(针对单个子元素)。修改主轴方向使用`flex-direction`属性,`flex`属性用于控制子元素在主轴上的伸缩比例。此外,`flex-wrap`属性允许子元素换行,而`align-content`属性则定义多行对齐方式。
|
23天前
|
前端开发
【前端web入门第五天】01 结构伪类选择器与伪元素选择器
本文介绍了CSS中的结构伪类选择器和伪元素选择器。结构伪类选择器如`nth-child`可根据元素结构关系进行选择,例如将列表中首个`&lt;li&gt;`元素背景设为绿色。伪元素选择器用于创建装饰性内容。
|
23天前
|
SQL 安全 数据库
从入门到精通:Python Web安全守护指南,SQL注入、XSS、CSRF全防御!
【9月更文挑战第13天】在开发Python Web应用时,安全性至关重要。本文通过问答形式,详细介绍如何防范SQL注入、XSS及CSRF等常见威胁。通过使用参数化查询、HTML转义和CSRF令牌等技术,确保应用安全。附带示例代码,帮助读者从入门到精通Python Web安全。
47 6
|
23天前
|
前端开发
【前端web入门第五天】02 盒子模型基础
本文档详细介绍了CSS中的盒子模型及其组成部分,包括内容区域、内边距、边框线和外边距。通过具体示例展示了如何设置边框线、内边距及外边距,并解释了尺寸计算方法和版心居中的技巧。内容丰富,示例清晰,有助于理解盒子模型在网页布局中的应用。
|
23天前
|
前端开发
【前端web入门第六天】01 CSS浮动
这是关于CSS布局第六天学习目标的介绍,主要解决多个`&lt;div&gt;`标签在同一行显示的问题,即一个在左边,另一个在右边。文中介绍了标准流、浮动及flex布局的概念,重点推荐使用flex布局。文章详细讲解了浮动的基本使用、布局技巧及清除浮动的方法,包括额外标签法、单伪元素法、双伪元素法和`overflow`隐藏法,并提供了示例代码帮助理解。
|
23天前
|
前端开发
前端web入门第四天】03 显示模式+综合案例热词与banner效果
本文档介绍了HTML中标签的三种显示模式:块级元素、行内元素与行内块元素,并详细解释了各自的特性和应用场景。块级元素独占一行,宽度默认为父级100%,可设置宽高;行内元素在同一行显示,尺寸由内容决定,设置宽高无效;行内块元素在同一行显示,尺寸由内容决定,可设置宽高。此外,还提供了两个综合案例,包括热词展示和banner效果实现,帮助读者更好地理解和应用这些显示模式。
下一篇
无影云桌面