Spring MVC 基础知识

发表于 2022-04-06 更新于 2022-04-09 分类于 java

Spring MVC 的中央控制器是 DispatcherServlet;应用控制器拆分为处理器映射器 HandlerMapping 进行处理器管理和视图解析器 ViewResolver 进行视图管理。提供了强大的约定大于配置的契约式编程支持。

请求流程

用户发起请求，请求被SpringMVC中央控制器(DispatherServlet)捕获
中央控制器(DispatherServlet)解析URL获取请求的URI，根据URI调用处理器映射器 HandlerMapping
中央控制器(DispatherServlet)获得返回的 HandlerExecutionChain (包括 Handler 对象和Handler对象对应的拦截器 HandlerIntercepter)
中央控制器(DispatherServlet)根据获得的 HandlerExecutionChain 选择一个合适的 HandlerAdapter (如果成功获得 HandlerAdapter 后，此时将开始执行拦截器的 preHanlder() 方法)
HanlderAdapter 根据请求的 Handler 适配并执行对应的 Handler; HandlerAdapter 提取 Request 中的模型数据，填充 Handler 入参，开始执行 Handler(Controller) 。在填充Hanlder的入参过程中，根据配置Spring将做一些额外的工作。
HttpMessageConveter 将请求消息（如Json、xml等数据）转换成一个对象，将对象转换为指定的响应信息。

数据转换：对请求消息进行数据转换，如 String 转换成 Integer、 Double 等数据格式。
数据格式化：如将字符串转换成数字或日前
数据验证：验证数据的有效性（长度、格式等），验证结果存储到 BindingResult 或 Error 中。

Hnadler 执行完毕，返回一个 ModelAndView 对象给 HandlerAdapter
HandlerAdapter 适配器将执行结果 ModelAndView 返回给中央控制器(DispatherServlet)
中央控制器(DispatherServlet)接收到 ModelAndView 后，请求对应的视图解析器 ViewResolver
视图解析器 ViewResolver 解析 ModelAndView 后返回对应的视图 View
渲染视图并返回渲染后的视图给中央控制器(DispatherServlet)
中央控制器(DispatherServlet)将渲染后的页面响应给用户或客户端

环境搭建

开发环境

Idea + Maven + Jdk1.8 + Jetty

创建工程

添加依赖包

修改pom.xml中Jdk版本为1.8

pom.xml

<properties>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <maven.compiler.source>1.8</maven.compiler.source>
  <maven.compiler.target>1.8</maven.compiler.target>
</properties>

添加依赖包

spring-web
spring-webmvc
javax.servlet-api

pom.xml

<dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>5.3.18</version>
  </dependency>
  <dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>5.3.18</version>
  </dependency>
  <dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
  </dependency>
</dependencies>

配置Maven插件

maven-compiler-plugin 编译插件

pom.xml

<plugin>
  <artifactId>maven-compiler-plugin</artifactId>
  <version>3.8.0</version>
  <configuration>
    <source>1.8</source>
    <target>1.8</target>
    <encoding>utf-8</encoding>
  </configuration>
</plugin>

jetty-maven-plugin jetty容器插件，也可以使用tomcat容器插件

command启动命令： jetty:run

pom.xml

<!-- jetty 配置 启动报404错误 原因未知 未解决 -->
<plugin>
  <groupId>org.eclipse.jetty</groupId>
  <artifactId>jetty-maven-plugin</artifactId>
  <!-- jdk1.8 使用9.4版本的jetty -->
  <version>9.4.45.v20220203</version>
  <configuration>
    <scanIntervalSeconds>10</scanIntervalSeconds>
    <!-- 设置端口号 可选配置 -->
    <httpConnector>
      <port>8000</port>
    </httpConnector>
    <!-- 设置项目路径 可选配置 -->
    <webAppConfig>
      <contextPath>/admin</contextPath>
    </webAppConfig>
  </configuration>
</plugin>

tomcat 插件配置

command启动命令： tomcat7:run

pom.xml

<!-- tomcat7 配置 -->
<!-- 启动命令 tomcat7:run -->
<plugin>
  <groupId>org.apache.tomcat.maven</groupId>
  <artifactId>tomcat7-maven-plugin</artifactId>
  <version>2.2</version>
  <configuration>
    <!-- 设置根路径 可选配置 -->
    <!-- 访问地址是 http://localhost:8080/admin/....-->
    <path>/admin</path>
    <uriEncoding>UTF-8</uriEncoding>
    <server>tomcat7</server>
  </configuration>
</plugin>

jetty 插件配置

pom.xml

<!-- jetty 配置 -->
<!-- 启动命令 jetty:run -->
<plugin>
  <groupId>org.eclipse.jetty</groupId>
  <artifactId>jetty-maven-plugin</artifactId>
  <version>9.4.45.v20220203</version>
  <configuration>
    <scanIntervalSeconds>10</scanIntervalSeconds>
    <!-- 设置端口号 可选配置 -->
    <httpConnector>
      <port>8080</port>
    </httpConnector>
    <!-- 设置根路径 可选配置 -->
    <!-- 访问地址是 http://localhost:8080/admin/....-->
    <webAppConfig>
      <contextPath>/admin</contextPath>
    </webAppConfig>
  </configuration>
</plugin>

完整的pom.xml

pom.xml

<?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>

  <groupId>org.example</groupId>
  <artifactId>shsxt-spring-mvc-base</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>

  <name>shsxt-spring-mvc-base Maven Webapp</name>
  <!-- FIXME change it to the project's website -->
  <url>http://www.example.com</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.source>1.8</maven.compiler.source>
    <maven.compiler.target>1.8</maven.compiler.target>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.11</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.3.18</version>
    </dependency>
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <finalName>shsxt-spring-mvc-base</finalName>
    <pluginManagement><!-- lock down plugins versions to avoid using Maven defaults (may be moved to parent pom) -->
      <plugins>
        <plugin>
          <artifactId>maven-clean-plugin</artifactId>
          <version>3.1.0</version>
        </plugin>
        <!-- see http://maven.apache.org/ref/current/maven-core/default-bindings.html#Plugin_bindings_for_war_packaging -->
        <plugin>
          <artifactId>maven-resources-plugin</artifactId>
          <version>3.0.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>3.8.0</version>
          <configuration>
            <source>1.8</source>
            <target>1.8</target>
            <encoding>utf-8</encoding>
          </configuration>
        </plugin>
        <plugin>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>2.22.1</version>
        </plugin>
        <plugin>
          <artifactId>maven-war-plugin</artifactId>
          <version>3.2.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-install-plugin</artifactId>
          <version>2.5.2</version>
        </plugin>
        <plugin>
          <artifactId>maven-deploy-plugin</artifactId>
          <version>2.8.2</version>
        </plugin>
        <!-- tomcat7 配置 -->
        <!-- 启动命令 tomcat7:run -->
        <plugin>
          <groupId>org.apache.tomcat.maven</groupId>
          <artifactId>tomcat7-maven-plugin</artifactId>
          <version>2.2</version>
          <configuration>
            <!-- 设置根路径 可选配置 -->
            <!-- 访问地址是 http://localhost:8080/admin/....-->
            <path>/admin</path>
            <uriEncoding>UTF-8</uriEncoding>
            <server>tomcat7</server>
          </configuration>
        </plugin>
        <!-- jetty 配置 -->
        <!-- 启动命令 jetty:run -->
        <plugin>
          <groupId>org.eclipse.jetty</groupId>
          <artifactId>jetty-maven-plugin</artifactId>
          <version>9.4.45.v20220203</version>
          <configuration>
            <scanIntervalSeconds>10</scanIntervalSeconds>
            <!-- 设置端口号 可选配置 -->
            <httpConnector>
              <port>8080</port>
            </httpConnector>
            <!-- 设置根路径 可选配置 -->
            <!-- 访问地址是 http://localhost:8080/admin/....-->
            <webAppConfig>
              <contextPath>/admin</contextPath>
            </webAppConfig>
          </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

创建 servlet-context.xml

在 src/main/resources 资源目录下新建 servlet-context.xml 文件。
如果项目没有源代码目录，需要手动新建 java 源代码目录

servlet-context.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/mvc
        https://www.springframework.org/schema/mvc/spring-mvc.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd">

    <!-- 开启扫描器 -->
    <context:component-scan base-package="org.example.controller"/>

    <!-- 使用默认的 servlet 来响应静态文件 -->
    <mvc:default-servlet-handler />

    <!-- 开启注解驱动 -->
    <mvc:annotation-driven />

    <!-- 配置视图解析器 -->
    <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver" id="internalResourceViewResolver">
        <!-- 前缀：在WEB-INF目录下的jsp目录下 -->
        <property name="prefix" value="/WEB-INF/jsp/"/>
        <!-- 后缀：以.jsp结尾的资源文件 -->
        <property name="suffix" value=".jsp"/>
    </bean>
</beans>

配置 web.xml

web.xml

<!DOCTYPE web-app PUBLIC
 "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
 "http://java.sun.com/dtd/web-app_2_3.dtd" >

<!-- 注意写明版本，否则el表达式不解析 -->
<web-app version="3.0"
         xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
  <display-name>Archetype Created Web Application</display-name>

  <!-- 编码过滤 utf-8 -->
  <filter>
    <filter-name>encodingFilter</filter-name>
    <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
    <init-param>
      <param-name>encoding</param-name>
      <param-value>UTF-8</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>encodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

  <!-- servlet中央控制器(请求分发器) DispatherServlet -->
  <servlet>
    <servlet-name>springMvc</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <!-- 初始化参数，在 servlet 类加载时加载的参数 -->
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:servlet-context.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>

  </servlet>

  <servlet-mapping>
    <servlet-name>springMvc</servlet-name>
    <!-- 拦截请求 "/"  代表所有请求， "*.do" 代表拦截所有.do请求 -->
    <url-pattern>/</url-pattern>
    <!-- <url-pattern>*.do</url-pattern> -->
  </servlet-mapping>
</web-app>

添加控制器

package org.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

/**
 * 控制器
 */
@Controller
public class HelloController {

    /**
     * 访问路径是 hello
     * 对应 web.xml 中的配置 <url-pattern>/</url-pattern>
     * @return
     */
    @RequestMapping("hello")
    public ModelAndView hello(){
        ModelAndView modelAndView = new ModelAndView();

        // 设置数据模型
        modelAndView.addObject("msg", "hello my world !!!");
        // 设置视图
        modelAndView.setViewName("hello");

        return modelAndView;
    }
}

添加视图页面

<%--
  Created by IntelliJ IDEA.
  User: haight
  Date: 2022/4/7
  Time: 11:00 AM
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Hello</title>
</head>
<body>
    <%-- 通过el表达式获取 ModelAndView 中的数据 --%>
    <h2>${msg}</h2>
</body>
</html>

启动服务器

tomcat7 idea 配置Run/Debug,Run命令为 tomcat7:run
jetty idea 配置Run/Debug,Run命令为 jetty:run

地址映射

映射单个地址 @RequestMapping("user") 或 @RequestMapping("/user") , 注意，地址前加不加斜杠都一样。访问地址是 http://localhost:8080/user
映射多个路径, 可以使用数组配置多个路径映射 @RequstMapping(value = {"user","users","u"}) 或 @RequstMapping({"user","users","u"})
设置类路径，在类上使用 @RequestMapping 设置这个类的基础路径（方法路径前需要加上类路径）。
1
2
3
4
5
6
7
8
@RequestMapping("users")
public class UserController{

@RequestMapping("list")
public void index(){

}
}
访问地址是 http://localhost:8080/users/list
请求方式 @RequestMapping 注解可以使用 method 属性设置 (GET | POST | PUT | DELETE 等),如 @RequestMappging(value="", method = ReqeustMethod.GET)

参数路径路径上可以设置参数

http://localhost:8080/user?id=1 “id” 是路径中的一个参数, 使用方法如下

public class UserController{

  @RequestMapping(value = "user")
  public void getUserById(String id){

  }
}

或者使用参数注解 @RequestParam

public class UserController{

  @RequestMapping(value = "user")
  public void getUserById(@RequestParam String id){

  }
}

http://localhost:8080/user/1 “1” 是路径中的一个参数, 使用方法如下

public class UserController{

  @RequestMapping("user/{id}")
  public void getUserById(@PathVariable("id") String id){

  }
}

URL参数绑定

基本数据类型

传递的参数名与方法的形参名称保持一致
如果参数未传递或参数值为null，系统会报500错误
可以通过注解 @RequestParam 设置参数的默认值，可以解决参数为空的问题
1
2
3
public void test(@RequestParam(defaultValue = 0) int id){

}
如果参数名和方法形参名称不一致，可以通过注解 @RequestParam 设置 name 属性指定参数的名称
1
2
3
4
// http://localhost:8080/user?uid=1
public void test(@RequestParam(name = "uid") int id){

}

包装类型

传递的参数名与方法的形参名称保持一致
如果参数未传递，默认值为 null
参数类型建议使用 包装类型 防止500错误

数组类型

传递的参数名与方法的形参名称保持一致

url 如 http://localhost:8080/user?ids=1&ids=2&ids=3
1
public void test(Integet[] ids){}

JavaBean对象(实体类)

参数名与实体类的属性名称保持一致

package org.example.po;

publci class User{
  private Integer userId;
  private String userName;

  public Integer getUserId(){
    return userId;
  }

  public void setUserId(Integer userId){
    this.userId = userId;
  }

  public String getUserName(){
    return userName;
  }

  public void setUserName(String userName){
    this.userName = userName;
  }
}

url传递参数，如 http://localhost:8080/user?userId=11&userName=wang

1 2	public void test(User user){}

List类型

对于集合的绑定，一般需要使用JavaBean对象进行包装

如 User 是一个JavaBean对象,有个集合类型的属性 phones

package org.example.po;

publci class User{
  private Integer userId;
  private String userName;
  public List<String> phones;

  public Integer getUserId(){
    return userId;
  }

  public void setUserId(Integer userId){
    this.userId = userId;
  }

  public String getUserName(){
    return userName;
  }

  public void setUserName(String userName){
    this.userName = userName;
  }

  public List<String> getPhones(){
    return phones;
  }

  public void setPhones(List<String> phones){
    this.phones = phones;
  }
}

jsp表单需要使用数组提交

<form action="" method="post">
  <input name="phones[0]" value="12111">
  <input name="phones[1]" value="111111">
  <button type="submit">Submit</button>
</form>

1
2
3


@RequestMappging(value="user",method=ReqeustMethod.POST)
public void test(User user){}

Map 类型

Map最为灵活，它也需要绑定在 JavaBean 对象上，而不能直接写在Controller方法的参数中。

请求转发与重定向

SpringMVC默认采用服务器内部转发的形式展示页面信息。请求转发地址栏的地址不会改变，重定向地址会改变。

请求转发

请求转发是在服务器内部进行转发，所以地址不会改变。
请求转发以 forward: 开头

@RequestMapping("page1")
public void page1(){
  ModelAndView modelAndView = nwe ModelAndView();
  modelAndView.setViewName("page1");
  return modelAndView;
}

// 使用 forward:页面名，此时，页面 page2.jsp 位于 webapp 根目录下
@RequestMapping("page2")
public void page2(){
  ModelAndView modelAndView = nwe ModelAndView();
  modelAndView.setViewName("forward:page2.jsp");
  return modelAndView;
}

// 使用 forward:传参，视图中使用 param.参数名 的形式获取参数值，如 ${param.id}
@RequestMapping("page3")
public void page3(){
  ModelAndView modelAndView = nwe ModelAndView();
  modelAndView.setViewName("forward:page2.jsp?id=111");
  return modelAndView;
}

// 使用 forward: 路径 转发
@RequestMapping("page4")
public void page4(){
  ModelAndView modelAndView = nwe ModelAndView();
  modelAndView.setViewName("forward:page1");
  return modelAndView;
}

重定向

重定向是否发一个302的状态码给浏览器，浏览器自己去请求跳转的页面，所以地址会改变。
重定向以 redirect: 开头，使用方法与转发相同。

请求域设置

使用 ModelAndView
使用 Model
使用 HttpServletRequest
使用 MoedlMap
使用 Map

Json数据开发

@RespnseBody 该注解用于将Controller方法放回的对象，通过适当的 HttpMessageConverter 转换为指定格式后，写入到Response对象的 body 数据区。返回的数据不是 html,而是其它格式的数据，如json、xml。
@RequestBody 该注解用于读取 Request 请求的 body 数据，使用系统默认配置的 HttpMessageConverter 进行解析。参数必须是一个Json格式的字符串

引入依赖

jackson-core
jackson-databind
jackson-annotations

pom.xml

<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-core</artifactId>
  <version>2.13.2</version>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.13.2.2</version>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-annotations</artifactId>
  <version>2.13.2</version>
</dependency>

修改配置文件

servlet-context.xml

<!-- mvc 请求映射 处理器与适配器配置 -->
<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <!-- 解决中文乱码 -->
            <property name="defaultCharset" value="UTF-8"/>
        </bean>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <!-- 解决中文乱码 -->
            <property name="defaultCharset" value="UTF-8"/>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

注解使用

package org.example.controller;

import org.example.po.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("api")
public class ApiController {

    /**
     * 返回字符串
     * @return
     */
    @RequestMapping("getName")
    @ResponseBody
    public String getName(){
        return "hello";
    }

    /**
     * 返回对象
     * @return
     */
    @RequestMapping("getObject")
    @ResponseBody
    public Object getObject(){
        User result = new User("11", "LiSi");
        return result;
    }
}

拦截器

基本概念

SpringMVC 中的拦截器 Interceptor 主要作用是拦截用户请求进行处理（返回 true 则方向，否则返回 false ），如进行权限验证。定义拦截器有两种方法：

实现接口 org.springframework.web.servlet.HandlerInterceptor
继承适配器 org.springframework.web.servlet.HandlerInterceptorAdapter

实现接口

需要实现3个接口

preHandle 在目标 Handler（方法）执行前执行，返回true，执行目标方法，返回 false 阻止目标方法执行
postHandle 在目标 Handler（方法）执行后，视图生成前执行
afterCompletion 在目标 Handler（方法）执行后，视图生成后执行

package org.example.interceptors;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // return HandlerInterceptor.super.preHandle(request, response, handler);
        // 重定向到登录页面
        // response.sendRedirect(request.getContextPath() + "/login.jsp");
        System.out.println("目标方式执行之前");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
        System.out.println("目标方式执行之后 视图生成前执行");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
        System.out.println("目标方式执行之后 视图生成后执行");
    }
}

继承适配器

已弃用，不建议使用。

拦截器配置

servlet-context.xml

<!-- 拦截器设置 方法一 -->
<!-- 拦截所有请求 -->
<mvc:interceptors>
    <bean class="org.example.interceptors.MyInterceptor"/>
</mvc:interceptors>

servlet-context.xml

<!-- 拦截器设置 方法二 推荐方法 -->
<mvc:interceptors>
    <mvc:interceptor>
        <!-- 拦截所有请求 -->
        <mvc:mapping path="/**"/>
        <!-- 排除的请求 -->
        <mvc:exclude-mapping path="/login/*"/>
        <bean class="org.example.interceptors.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

文件上传

环境配置

引入依赖

添加 commons-fileupload 依赖

pom.xml

<dependency>
  <groupId>commons-fileupload</groupId>
  <artifactId>commons-fileupload</artifactId>
  <version>1.4</version>
</dependency>

修改Spring配置

servlet-context.xml

<!-- 文件上传 -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    <!-- 允许文件上传的最大尺寸 -->
    <property name="maxUploadSize">
        <value>104857600</value>
    </property>

    <!-- 设置文件放入临时文件夹的最大最小限制，此值是阈值，低于此值保存在内存中，否则生成硬盘上的临时文件 -->
    <property name="maxInMemorySize">
        <value>4096</value>
    </property>
</bean>

单文件上传

前台页面

文件上传表单页面

upload.jsp

<%--
  Created by IntelliJ IDEA.
  User: haight
  Date: 2022/4/7
  Time: 11:29 PM
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>文件上传</title>
</head>
<body>
  <form method="post" enctype="multipart/form-data" action="uploadFile">
    文件：<input name="file" type="file" /> <button type="submit">上传</button>
  </form>
</body>
</html>

文件上传结果页面

uploadResult.jsp

<%--
  Created by IntelliJ IDEA.
  User: haight
  Date: 2022/4/7
  Time: 11:32 PM
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>上传文件结果</title>
</head>
<body>
  <h2>${msg}</h2>
</body>
</html>

后台服务

方法一使用 MultipartHttpServletRequest 获取文件信息

package org.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;

import javax.servlet.http.HttpServletRequest;
import java.io.File;

@Controller
public class UploadController {
    @PostMapping("uploadFile")
    public String uploadFile(HttpServletRequest request, Model model){
        // 得到文件上传的request对象
        MultipartHttpServletRequest multipartHttpServletRequest = (MultipartHttpServletRequest) request;

        // 得到上传文件
        // "file" 是前台表单file元素的name
        MultipartFile multipartFile = multipartHttpServletRequest.getFile("file");

        return "uploadResult";
    }
}

方法二使用注解获取文件信息

package org.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;

@Controller
public class UploadController {

    /**
     * 文件上传
     * @param request
     * @param file @RequestParam("file")中字符串 file 是表单中file元素的name值
     * @param model
     * @return
     */
    @PostMapping("uploadFile")
    public String uploadFile(HttpServletRequest request, @RequestParam("file") MultipartFile file,  Model model){
        // 判断上传文件是否为空
        if(file.isEmpty()){
            model.addAttribute("msg","上次文件不能为空");
            return "uploadResult";
        }

        // 获取项目真实路径
        String realPath = request.getServletContext().getRealPath("/");

        // 设置文件存放路径
        File filePath = new File(realPath + "/upload");

        if(!filePath.exists()){
            filePath.mkdir();
        }

        // 获取上传的文件名
        String originalFilename = file.getOriginalFilename();
        // 获取上传文件名后缀
        String siffx = originalFilename.substring(originalFilename.lastIndexOf("."));
        // 生成随机文件名
        String fileName = System.currentTimeMillis() + siffx;

        // 保存文件
        try{
            file.transferTo(new File(filePath, fileName));
            model.addAttribute("msg","上传文件成功");
        } catch (IOException e) {
            e.printStackTrace();
            model.addAttribute("msg","上传文件失败");
        }

        return "uploadResult";
    }
}

多文件上传

前台页面

<%--
  Created by IntelliJ IDEA.
  User: haight
  Date: 2022/4/7
  Time: 11:29 PM
  To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>文件上传</title>
</head>
<body>
  <form method="post" enctype="multipart/form-data" action="uploadFiles">
      <div>文件：<input name="files" type="file" /></div>
      <div>文件：<input name="files" type="file" /></div>
      <div>文件：<input name="files" type="file" /></div>
      <button type="submit">上传</button>
  </form>
</body>
</html>

后台

package org.example.controller;

import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletRequest;
import java.io.File;
import java.io.IOException;
import java.util.List;

@Controller
public class MulUploadController {

    /**
     * 文件上传
     * @param request
     * @param files @RequestParam("file")中字符串 file 是表单中file元素的name值
     * @param model
     * @return
     */
    @PostMapping("uploadFiles")
    public String uploadFile(HttpServletRequest request, @RequestParam("files") List<MultipartFile> files, Model model){

        if(files != null && files.size() > 0){
            // 获取项目真实路径
            String realPath = request.getServletContext().getRealPath("/");

            // 设置文件存放路径
            File filePath = new File(realPath + "/upload");
            try{
                for(MultipartFile file: files){
                    if(!file.isEmpty()){
                        saveFile(file, request, filePath);
                    }
                }

                model.addAttribute("msg", "上传文件成功");
            }catch(Exception ex){
                model.addAttribute("msg", "上传文件发生错误");
            }

        }
        return "uploadResult";
    }

    private void saveFile(MultipartFile file, HttpServletRequest request, File filePath) throws IOException {

        if(!filePath.exists()){
            filePath.mkdir();
        }

        // 获取上传的文件名
        String originalFilename = file.getOriginalFilename();
        // 获取上传文件名后缀
        String siffx = originalFilename.substring(originalFilename.lastIndexOf("."));
        // 生成随机文件名
        String fileName = System.currentTimeMillis() + siffx;

        // 保存文件
        try{
            file.transferTo(new File(filePath, fileName));
        } catch (IOException e) {
            e.printStackTrace();
            throw e;
        }
    }
}

请求流程

环境搭建

开发环境

创建工程

添加依赖包

创建 servlet-context.xml

配置 web.xml

添加控制器

添加视图页面

启动 服务器

地址映射

URL参数绑定

基本数据类型

包装类型

数组类型

JavaBean对象(实体类)

List类型

Map 类型

请求转发与重定向

请求转发

重定向

请求域设置

Json数据开发

引入依赖

修改配置文件

注解使用

拦截器

基本概念

实现接口

继承适配器

拦截器配置

文件上传

环境配置

引入依赖

修改Spring配置

单文件上传

前台页面

后台服务

多文件上传

全局异常

启动服务器