超级详细的SpringMVC基础

@Zeal

于 2024-05-17 13:31:59 发布

阅读量1.2k

点赞数 34

分类专栏： Spring框架文章标签： springmvc

本文链接：https://blog.csdn.net/m0_69266818/article/details/139002303

版权

Spring框架专栏收录该内容

10 篇文章 0 订阅

订阅专栏

SpringMVC简介

背景

Servlet属于web层开发技术，技术特点：

每个请求都需要创建一个Servlet进行处理
创建Servlet存在重复操作
代码灵活性低，开发效率低

SpringMVC概述

SpringMVC是一种基于Java实现MVC模型的轻量级Web框架
官网**：**SpringMVC
优点：
- 使用简单、开发便捷(相比于Servlet)
- 灵活性强

技术体系定位

web程序通过浏览器访问前端页面，发送异步请求到后端服务器
后台服务器采用三层架构进行功能开发
- 表现层负责接收请求和数据然后将数据转交给业务层
- 业务层负责调用数据层完成数据库表的增删改查，并将结果返给表现层
- 表现层将数据转换成json格式返回给前端
前端页面将数据进行解析最终展示给用户。

表现层采用SpringMVC框架，SpringMVC主要负责的内容有:

controller如何接收请求和数据
如何将请求和数据转发给业务层
如何将响应数据转换成json发回到前端

快速入门

目的

基于SpringMvc快速开发一个web应用

需求

搭建一个SpringMvc工程，定义UserController.save()方法处理/save请求，返回"{‘module’:‘springmvc’}"

步骤

创建Maven项目，并导入对应的jar包
创建控制器类
创建配置类
创建Tomacat的Servlet容器配置类

代码实现

创建maven项目，并导入对应的jar包

     <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>3.1.0</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.2.10.RELEASE</version>
    </dependency>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>8080</port>
          <path>/</path>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

说明：servlet的坐标为什么需要添加?

scope是maven中jar包依赖作用范围的描述，
如果不设置默认是compile在在编译、运行、测试时均有效
如果运行有效的话就会和tomcat中的servlet-api包发生冲突，导致启动报错
provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突

创建控制器类

//2.制作控制器类，等同于Servlet
//2.1必须是一个spring管理的bean
//2.2定义具体处理请求的方法
//2.3设置当前方法的访问路径
//2.4设置响应结果为String类型数据
@Controller
public class UserController {
    
    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "springmvc";
    }
}

创建配置类

//3.定义配置类加载Controller对应的bean
@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
}

创建Tomacat的Servlet容器配置类

//4.定义servlet容器的配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springMVC配置
    protected WebApplicationContext createServletApplicationContext() {
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置Tomcat接收的请求哪些归SpringMVC处理
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //设置spring相关配置
    protected WebApplicationContext createRootApplicationContext() {
        return null;
    }
}

配置Tomacat环境

启动运行项目并浏览器访问

测试工具

PostMan简介

代码编写完后，我们要想测试，只需要打开浏览器直接输入地址发送请求即可。但是我们如果我们发送的是GET请求可以直接使用浏览器，但是如果要发送的是POST请求呢?
如果要求发送的是post请求，我们就得准备页面在页面上准备form表单，测试起来比较麻烦。所以我们就需要借助一些第三方工具，如PostMan.

PostMan是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件
作用：常用于进行接口测试
特征
- 简单
- 实用
- 美观
- 大方

PostMan安装

网址：https://app.getpostman.com/app/download/win64
安装完成后按照提示进行注册

使用

创建WorkSpace工作空间

发送请求

保存当前请求

**注意:**第一次请求需要创建一个新的目录，后面就不需要创建新目录，直接保存到已经创建好的目录即可。

知识点总结

@Controller：设定SpringMVC的核心控制器bean
@RequestMapping：设置当前控制器方法请求访问路径
@ResponseBody：设置当前控制器方法响应内容为当前返回值，无需解析

请求与参数处理

请求路径

团队多人开发，每人设置不同的请求路径，冲突问题该如何解决?
解决思路:为不同模块设置模块名作为请求路径前置

@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'module':'user save'}";
    }
    
    @RequestMapping("/delete")
    @ResponseBody
    public String delete(){
        System.out.println("user delete ...");
        return "{'module':'user delete'}";
    }
}

@Controller
@RequestMapping("/book")
public class BookController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("book save ...");
        return "{'module':'book save'}";
    }
}

注意：

当类上和方法上都添加了@RequestMapping注解，前端发送请求的时候，要和两个注解的value值相加匹配才能访问到。
@RequestMapping注解value属性前面加不加/都可以

请求方式

@RequestMapping没有设置请求方式，默认支持以下八种请求类型

指定请求方式后将不在支持其他类型请求类型

参数

基本数据类型

发送方式

URL地址传参

表单传参

接收参数

形参与参数名相同，此时可以直接获取请求参数

形参与参数名不同，需要设置@RequestParam绑定请求参数与方法形参

@RequestParam：绑定请求参数与处理器方法形参间的关系

POJO

简单数据类型一般处理的是参数个数比较少的请求，如果参数比较多，那么后台接收参数的时候就比较复杂，这个时候我们可以考虑使用POJO数据类型。

POJO参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数

新增POJO类
URL地址请求或表单请求
后台接收参数

注意：

POJO参数接收，前端GET和POST发送请求数据的方式不变。
请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

嵌套POJO

新增加POJO类(user->address)
URL地址请求或表单请求

后台接收数据

注：请求参数key的名称要和POJO中属性的名称一致，否则无法封装

数组

请求参数名与形参对象属性名相同且请求参数为多个，定义数组类型即可接收参数

url地址请求或表单请求

后台接收数据

集合

List

不加@RequestParam注解会报错
错误原因：SpringMVC将List看做是一个POJO对象来处理，将其创建一个对象并准备把前端的数据封装到对象中，但是List是一个接口无法创建对象，所以报错。
正确接收方式：

集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系
对于简单数据类型使用数组会比集合更简单些。

接收方式：和List方式一样，都需要加@RequestParam注解

Date日期类型

请求

后台接收数据

@RequestMapping("/dateParam")
@ResponseBody
public String dateParam(Date date,@DateTimeFormat(pattern = "yyyy-MM-dd") Date date2,@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") Date date3){
    System.out.println("date:"+date);
    System.out.println("date2:"+date2);
    System.out.println("date3:"+date3);
    return "{'module':'dateParam'}";
}

别忘了在SpringMvcConfig配置类上加@EnableWebMvc

注

SpringMvc默认时间格式为 yyyy/MM/dd
其他时间格式需要使用@DateTimeFormat转换

@DateTimeFormat：设定日期时间格式字符串

File文件类型

添加fileupload依赖

<!--添加fileupload依赖-->
<dependency>
  <groupId>commons-fileupload</groupId>
  <artifactId>commons-fileupload</artifactId>
  <version>1.3.3</version>
</dependency>

配置解析器

SpringMvcConfig 中配置 multipartResolver解析器,这里Bean的名称是固定的，否则无法生效

@Bean("multipartResolver")
public CommonsMultipartResolver multipartResolver (){
    CommonsMultipartResolver resolver = new CommonsMultipartResolver();
    resolver.setDefaultEncoding("UTF-8");
    resolver.setMaxUploadSize(1024*1024);
    return resolver;
}

post请求方式

后台接收参数

@RequestMapping("/fileParam")
@ResponseBody
public String fileParam(MultipartFile file){
    if(!file.isEmpty()){
        try {
            file.transferTo(new File("D://test.txt"));
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    return "{'module':'file'}";
}

JSON类型

现在比较流行的开发方式为异步调用。前后台以异步方式进行交换，传输的数据使用的是JSON,所以前端如果发送的是JSON数据，后端该如何接收?

准备

SpringMVC默认使用的是jackson来处理json的转换，所以需要在pom.xml添加jackson依赖

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.9.0</version>
</dependency>

开启SpringMVC注解支持

在SpringMVC的配置类中开启SpringMVC的注解支持，这里面就包含了将JSON转换成对象的功能。

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}

json请求与接收

注意： 接收json数据，需要在形参变量前加 @RequestBody注解
JSON对象数据请求

后端接收

@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user) {
    System.out.println(user);
    return "{'module':'pojoParamForJson'}";
}

JSON普通数组，JSON对象数据就是json内容不同。

中文乱码处理

Get请求中文乱码

修改pom.xml来解决GET请求中文乱码问题

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port><!--tomcat端口号-->
          <path>/</path> <!--虚拟目录-->
          <uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
        </configuration>
      </plugin>
    </plugins>
  </build>

Post请求乱码

配置过滤器

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

响应结果处理

前期准备

编写User类

public class User {
    private String name;
    private int age;
    //getter...setter...toString省略
}

webapp下创建page.jsp

<html><body><h2>Hello Spring MVC!</h2></body></html>

响应界面

  @RequestMapping("/toJumpPage")
    //注意
    //1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
    //2.方法需要返回String
    public String toJumpPage(){
        System.out.println("跳转页面");
        return "page.jsp";
    }

响应字符串

@RequestMapping("/toText")
@ResponseBody
public String toText(){
    return "hello,springmvc";
}

响应JSON结果

返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖@ResponseBody注解和@EnableWebMvc注解

@RequestMapping("/toJson")
@ResponseBody
public User toJson(){
    User user = new User();
    user.setName("itheima");
    user.setAge(15);
    return user;
}

@ResponseBody：设置当前控制器返回值作为响应体

类型转换器

在数据的传递过程中存在很多类型的转换，SpringMVC来做这个类型转换的，SpringMVC通过实现Converter接口、HttpMessageConverter接口来实现类型转换
Converter：用于实现简单数据型的类型转换逻辑的SPI
https://docs.spring.io/spring-framework/reference/core/validation/convert.html#core-convert-Converter-API

/**
*	S: the source type
*	T: the target type
*/
public interface Converter<S, T> {
    @Nullable
    //该方法就是将从页面上接收的数据(S)转换成我们想要的数据类型(T)返回
    T convert(S source);
}

HttpMessageConverter：用于转换HTTP请求和响应的策略接口，使用该接口实现了JSON、XML等数据类型的转换
https://docs.spring.io/spring-framework/reference/web/webmvc/mvc-config/message-converters.html

注：简单数据类型可以自动实现类型转换，JSON等类型需要开启@EnableWebMvc注解，根据类型匹配对应的类型转换器。

总结

REST分格

RESTful分格简介

REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格

当我们想表示一个网络资源的时候，可以使用两种方式:

传统风格资源描述形式
- http://localhost/user/getById?id=1 查询id为1的用户信息
- http://localhost/user/saveUser 保存用户信息
REST风格描述形式
- http://localhost/user/1
- http://localhost/user

传统方式一般是一个请求url对应一种操作，这样做不仅麻烦，也不安全，因为会程序的人读取了你的请求url地址，就大概知道该url实现的是一个什么样的操作。

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
- http://localhost/users 查询全部用户信息 GET（查询）
- http://localhost/users/1 查询指定用户信息 GET（查询）
- http://localhost/users 添加用户信息 POST（新增/保存）
- http://localhost/users 修改用户信息 PUT（修改/更新）
- http://localhost/users/1 删除用户信息 DELETE（删除）

请求的方式比较多，但是比较常用的就4种，分别是GET,POST,PUT,DELETE。
按照不同的请求方式代表不同的操作类型。

发送GET请求是用来做查询
发送POST请求是用来做新增
发送PUT请求是用来做修改
发送DELETE请求是用来做删除

快速体验

环境准备

创建一个web的maven项目
pom.xml添加Spring依赖
创建对应的配置类
编写实体类
编写Controller类

修改Result分格

以delete举例

知识点总结

@PathVariable：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应
形参注解对比

区别：

注解	类型	作用	备注
@RequestParam	形参注解	接收：1.url地址参数2.表单参数
@RequestBody	形参注解	接收json参数	一个处理器方法只能使用一次
@PathVariable	形参注解	接收路径参数

应用：

后期开发中，发送请求参数超过1个时，以json格式为主，@RequsetBody为主
如果发送非json格式数据，选用@RequestParam接收请求参数
采用RESTful进行开发，当参数数量较少时，例如一个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

简化注解

@RestController //@Controller + ReponseBody
@RequestMapping("/books")
public class BookController {
    
	//@RequestMapping(method = RequestMethod.POST)
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

    //@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

    //@RequestMapping(method = RequestMethod.PUT)
    @PutMapping
    public String update(@RequestBody Book book){
        System.out.println("book update..." + book);
        return "{'module':'book update'}";
    }

    //@RequestMapping(value = "/{id}",method = RequestMethod.GET)
    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..." + id);
        return "{'module':'book getById'}";
    }

    //@RequestMapping(method = RequestMethod.GET)
    @GetMapping
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
    
}

@RestController：设置当前控制器类为RESTful风格，等同于@Controller与@ResponseBody的组合
@GetMapping：设置当前控制器方法请求访问路径与请求路径，每种对应一个请求动作，对应GET请求

页面访问处理

拷贝静态页面

访问pages目录下的books.html

打开浏览器输入http://localhost/pages/books.html
错误原因

SpringMvc拦截了静态资源，根据/pages/books.html去controller找对应的方法，找不到所有会报404的错误
SpringMVC为什么会拦截静态资源呢？

解决方案

SpringMVC需要将静态资源进行放行

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}

或实现WebMvcConfigurer接口

扩展

技术架构

组件介绍

DispatcherServlet：前端控制器，是整体流程控制的中心，由其调用其它组件处理用户的请求，有效的降低了组件间的耦合性
HandlerMapping：处理器映射器，负责根据用户请求找到对应具体的Handler处理器
Handler：处理器，业务处理的核心类，通常由开发者编写，描述具体的业务
HandlAdapter：处理器适配器，通过它对处理器进行执行
View Resolver：视图解析器，将处理结果生成View视图
View：视图，最终产出结果，常用视图如jsp、html

源码解析

找到源码位置，了解调用关系

找到Servlet容器配置类的继承类 AbstractDispatcherServletInitializer
找到 registerDispatcherServlet 方法

根据createDispatcherServlet 方法找到 DispatcherServlet类
DispatcherServlet中找到 doDispatch 方法

Debug源码

调用 getHandler方法：从HandlerMapping中获取处理器链 HandlerExecutionChain
调用 getHandlerAdapter方法：从处理器链中获取处理器适配器 HandlerAdapter
调用处理器适配器方法 handle ：执行处理器，返回ModelAndView
调用processDispatchResult方法：解析返回值
- ModelAndView != null => 调用视图解析器 viewResolver
- ModelAndView == null => 不再调用视图解析器（加上@ResponseBody后不再走视图解析器）