四(2)springMVC框架

sweetcuter

于 2022-09-25 07:54:03 发布

阅读量487

点赞数

分类专栏：阶段四-常用框架文章标签： java

本文链接：https://blog.csdn.net/sweetcuter/article/details/127033699

版权

本文详细介绍了SpringMVC框架，从入门案例到RESTful风格的应用，涵盖了请求映射、参数传递、响应处理、SSM整合等多个方面。通过实例讲解了Controller的加载控制、PostMan工具的使用，以及异常处理和页面数据交互。文章还探讨了SSM整合的配置流程和功能模块开发，包括数据层、业务层和表现层的实现，最后讨论了拦截器的配置和使用。

摘要由CSDN通过智能技术生成

第二章 SpringMVC

今日目标

能够知道SpringMVC的优点
能够编写SpringMVC入门案例
能够使用PostMan发送请求
能够掌握普通类型参数传递
能够掌握POJO类型参数传递
能够掌握json数据参数传递
能够掌握响应json数据
能够掌握rest风格快速开发
能够完成基于restful页面数据交互案例

一. SpringMVC简介

1.1 SpringMVC概述

问题导入

SpringMVC框架有什么优点？

1. SpringMVC概述

SpringMVC是一种基于Java实现MVC模型的轻量级Web框架

优点
- 使用简单，开发便捷（相比于Servlet）
- 灵活性强

1.2 入门案例

问题导入

在Controller中如何定义访问路径，如何响应数据？

1. 实现步骤

1 创建web工程（Maven结构）
2 设置tomcat服务器，加载web工程(tomcat插件）
3 导入坐标（SpringMVC+Servlet）
4 定义处理请求的功能类（UserController）
5 编写SpringMVC配置类，加载处理请求的Bean。
6 加载SpringMVC配置，并设置SpringMVC请求拦截的路径

2. 代码实现

【第一步】创建web工程（Maven结构）

【第二步】设置tomcat服务器，加载web工程(tomcat插件）

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

【第三步】导入坐标（SpringMVC+Servlet）

<dependencies>
    <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>
</dependencies>

注意事项：

1. 课程版本基于Spring主版本5.2.10.RELEASE制作
2. 导入spring-webmvc坐标自动依赖spring相关坐标

【第四步】定义处理请求的功能类（UserController）

//定义表现层控制器bean
@Controller
public class UserController {
   
    //设置映射路径为/save，即外部访问路径
    @RequestMapping("/save")
    //设置当前操作返回结果为指定json数据（本质上是一个字符串信息）
    @ResponseBody
    public String save(){
   
        System.out.println("user save ...");
        return "{'info':'springmvc'}";
    }
}

注 : 对于SpringMVC而言，Controller方法返回值默认表示要跳转的页面，没有对应的页面就会报错。如果不想跳转页面而是响应数据，那么就需要在方法上使用@ResponseBody注解。

【第五步】编写SpringMVC配置类，加载处理请求的Bean。

//springmvc配置类，本质上还是一个spring配置类
@Configuration
@ComponentScan("com.itheima.controller")
public class SpringMvcConfig {
   
}

【第六步】加载SpringMVC配置，并设置SpringMVC请求拦截的路径

//web容器配置类
public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
   
    //加载springmvc配置类，产生springmvc容器（本质还是spring容器）
    protected WebApplicationContext createServletApplicationContext() {
   
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类
        ctx.register(SpringMvcConfig.class);
        return ctx;
    }

    //设置由springmvc控制器处理的请求映射路径
    protected String[] getServletMappings() {
   
        return new String[]{
   "/"};
    }

    //加载spring配置类
    protected WebApplicationContext createRootApplicationContext() {
   
        return null;
    }
}

3. 运行结果

4. 案例注解和类解析

@Controller注解

类型：类注解
位置：SpringMVC控制器类定义上方
作用：设定SpringMVC的核心控制器bean

@Controller
public class UserController {
   
}

@RequestMapping注解

类型：方法注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法请求访问路径

@RequestMapping("/save")
public void save(){
   
    System.out.println("user save ...");
}

注意：其实@RequestMapping注解还可以写到类上面，笔记后面会介绍到。

@ResponseBody注解

类型：方法注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法响应内容为当前返回值，无需解析

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

AbstractDispatcherServletInitializer类

AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
AbstractDispatcherServletInitializer提供三个接口方法供用户实现
- createServletApplicationContext()方法，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围。
```
//加载springmvc配置类，产生springmvc容器（本质还是spring容器）
protected WebApplicationContext createServletApplicationContext() {
     
    AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
    ctx.register(SpringMvcConfig.class);
    return ctx;
}
```
- getServletMappings()方法，设定SpringMVC对应的请求映射路径，设置为/表示拦截所有请求，任意请求都将转入到SpringMVC进行处理。
```
//设置由springmvc控制器处理的请求映射路径
protected String[] getServletMappings() {
     
    return new String[]{
     "/"};
}
```
- createRootApplicationContext()方法，如果创建Servlet容器时需要加载非SpringMVC对应的bean，使用当前方法进行，使用方式同createServletApplicationContext()
```
//加载spring配置类
protected WebApplicationContext createRootApplicationContext() {
     
    return null;
}
```

5. 入门程序开发总结

一次性工作
- 创建工程，设置服务器，加载工程
- 导入坐标
- 创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径
- SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）
多次工作
- 定义处理请求的控制器类
- 定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）

1.3 入门案例工作流程分析

1. 启动服务器初始化过程

服务器启动，执行ServletContainersInitConfig类，初始化web容器
执行createServletApplicationContext方法，创建了WebApplicationContext对象
加载SpringMvcConfig配置类
执行@ComponentScan加载对应的bean
加载UserController，每个@RequestMapping的名称对应一个具体的方法
执行getServletMappings方法，定义所有的请求都通过SpringMVC

2. 单次请求过程

发送请求localhost/save
web容器发现所有请求都经过SpringMVC，将请求交给SpringMVC处理
解析请求路径/save
由/save匹配执行对应的方法save(）
执行save()
检测到有@ResponseBody直接将save()方法的返回值作为响应求体返回给请求方

1.4 Controller加载控制

问题导入

因为功能不同，如何避免Spring错误的加载到SpringMVC的bean？

1. Controller加载控制与业务bean加载控制

SpringMVC相关bean（表现层bean）
Spring控制的bean
1. 业务bean（Service）
2. 功能bean（DataSource等）

问题: 因为功能不同，如何避免Spring错误的加载到SpringMVC的bean

加载Spring控制的bean的时候排除掉SpringMVC控制的bean

SpringMVC相关bean加载控制
1. SpringMVC加载的bean对应的包均在com.itheima.controller包内

Spring相关bean加载控制

方式一：Spring加载的bean设定扫描范围为com.itheima，排除掉controller包内的bean
方式二：不区分Spring与SpringMVC的环境，加载到同一个环境中
方式三：Spring加载的bean设定扫描范围为精准范围，例如service包、dao包等

@ComponentScan({
     "com.itheima.service","com.itheima.dao"})
//现在使用的是MyBatis自动代理的方式创建实现对象, 这个对象并不是我们定义出来的, 现在写不写扫描dao包都不影响Bean的加载, 但是不写通用性会差.
//一. 因为一旦不用自动代理对象,则无法加载数据层Bean,无法读写数据.
//二. 一旦不同MyBatis技术, 用其他的数据层实现技术, 仍然没有数据层bean
//所以, 写上扫描dao包通用性好

2. 排除controller包内的bean

@ComponentScan

类型：类注解
属性
- excludeFilters：排除扫描路径中加载的bean，需要指定类别（type）与具体项（classes）
- includeFilters：加载指定的bean，需要指定类别（type）与具体项（classes）

@Configuration
@ComponentScan(value = "com.itheima",
               excludeFilters = @ComponentScan.Filter(
                   type = FilterType.ANNOTATION,
                   classes = Controller.class
               )
              )
public class SpringConfig {
   
}

注 : 用Spring扫描包如果扫到SpringMVC配置类的@Configuration , 则也会用它的@ComponentScan, 这样的化, 过滤就没效果了, 所以一般把SpringMVC配置类的@Configuration注释掉, 或者放入别的包中.

3. Bean的加载格式

public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    
    protected WebApplicationContext createServletApplicationContext() {
    
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        ctx.register(SpringMvcConfig.class);
        return ctx;  
    }   
    protected WebApplicationContext createRootApplicationContext() {
     
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();      
        ctx.register(SpringConfig.class);        
        return ctx;  
    }   
    protected String[] getServletMappings() {
    
        return new String[]{
   "/"}; 
    }
}

简化格式

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer{
   
    protected Class<?>[] getServletConfigClasses() {
   
        return new Class[]{
   SpringMvcConfig.class}
    };
    protected String[] getServletMappings() {
   
        return new String[]{
   "/"};
    }
    protected Class<?>[] getRootConfigClasses() {
   
        return new Class[]{
   SpringConfig.class};
    }
}

1.5 PostMan

1. PostMan介绍

Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。
作用：常用于进行接口测试

2. PostMan安装

双击资料中的“Postman-win64-8.3.1-Setup.exe”即可自动按照，打开之后需要注册，如果底部有如下链接，可以点击跳过注册

3. PostMan的使用

创建WorkSpace工作空间

发送请求获取json数据

保存当前请求

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

二. 请求与响应

2.1 请求映射路径

问题导入

@RequestMapping注解注解可以写在哪？有什么作用？

1. @RequestMapping注解

名称：@RequestMapping
类型：方法注解类注解
位置：SpringMVC控制器方法定义上方
作用：设置当前控制器方法请求访问路径，如果设置在类上统一设置当前控制器方法请求访问路径前缀
范例

@Controller
//类上方配置的请求映射与方法上面配置的请求映射连接在一起，形成完整的请求映射路径
@RequestMapping("/user")
public class UserController {
   
    //请求路径映射
    @RequestMapping("/save") //此时save方法的访问路径是：/user/save
    @ResponseBody
    public String save(){
   
        System.out.println("user save ...");
        return "{'module':'user save'}";
    }
}

2.2 请求参数

1. 发送普通类型参数

问题导入

如何解决POST请求中文乱码问题？

GET请求传递普通参数

普通参数：url地址传参，地址参数名与形参变量名相同，定义形参即可接收参数

//普通参数：请求参数与形参名称对应即可完成参数传递
@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(String name ,int age){
   
    System.out.println("普通参数传递 name ==> "+name);
    System.out.println("普通参数传递 age ==> "+age);
    return "{'module':'common param'}";
}

问题：如果同学们传递的参数是中文试试，你们会发现接收到的参数出现了中文乱码问题。
原因：tomcat 8.5版本之后GET请求就不再出现中文乱码问题，但是我们使用的是tomcat7插件，所以会出现GET请求中文乱码问题。
解决：在pom.xml添加tomcat7插件处配置UTF-8字符集，解决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请求传递普通参数

普通参数：form表单post请求传参，表单参数名与形参变量名相同，定义形参即可接收参数

//普通参数：请求参数与形参名称对应即可完成参数传递
@RequestMapping("/commonParam")
@ResponseBody
public String commonParam(String name ,int age){
   
    System.out.println("普通参数传递 name ==> "+name);
    System.out.println("普通参数传递 age ==> "+age);
    return "{'module':'common param'}";
}

问题：我们发现，POST请求传递的参数如果包含中文那么就会出现中文乱码问题，说明我们之前配置的tomcat插件uri路径编解码字符集无法解决POST请求中文乱码问题。那么如何解决呢？

POST请求中文乱码处理

在加载SpringMVC配置的配置类中指定字符过滤器。

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};
    }
}

2.3 五种类型参数传递

问题导入

当请求参数名与形参变量名不同，该如何接收请求参数？

1. 普通参数

普通参数：当请求参数名与形参变量名不同，使用@RequestParam绑定参数关系

//普通参数：请求参数名与形参名不同时，使用@RequestParam注解关联请求参数名称与形参名称之间的关系
@RequestMapping("/commonParamDifferentName")
@ResponseBody
public String commonParamDifferentName(@RequestParam("name") String userName , int age){
   
    System.out.println("普通参数传递 userName ==> "+userName);
    System.out.println("普通参数传递 age ==> "+age);
    return "{'module':'common param different name'}";
}

名称：@RequestParam
类型：形参注解
位置：SpringMVC控制器方法形参定义前面
作用：绑定请求参数与处理器方法形参间的关系
参数：
- required：是否为必传参数
- defaultValue：参数默认值

2. POJO类型参数

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

public class User {
   
    private String name;
    private int age;
    //同学们自己添加getter/setter/toString()方法
}

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
   
    System.out.println("pojo参数传递 user ==> "+user);
    return "{'module':'pojo param'}";
}

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

3. 嵌套POJO类型参数

POJO对象中包含POJO对象

public class User {
   
    private String name;
    private int age;
    private Address address;
    //同学们自己添加getter/setter/toString()方法
}
public class Address {
   
    private String province;
    private Strin