Spring MVC 框架学习3 - 文件的上传

项目的代码稍后放在我的github上

https://github.com/Atk-9527/springmvc
day02 里面的 maven_springmvc_upload 文件

Spring MVC 实现文件上传

1. 文件上传的回顾

1.1 文件上传的必要条件

1. form 表单的 enctype 取值必须是：multipart/form-dat(默认值是:application/x-www-form-urlencoded)
2. enctype:是表单请求正文的类型B method 属性取值必须是 Post
3. 提供一个文件选择域

1.2 文件上传的原理分析

当 form 表单的 enctype 取值不是默认值后，request.getParameter()将失效。enctype=”application/x-www-form-urlencoded”时，form 表单的正文内容是：key=value&key=value&key=value

当 form 表单的 enctype 取值为 Mutilpart/form-data 时，请求正文内容就变成：

每一部分都是 MIME 类型描述的正文

分界符：

-----------------------------7de1a433602ac

协议头：

Content-Disposition: form-data; name=“userName”

协议的正文：

aaa

-----------------------------7de1a433602ac

Content-Disposition: form-data;

name=“file”;

filename=“C:\Users\zhy\Desktop\fileupload_demofile\b.txt”

协议的类型（MIME类型）：

Content-Type: text/plain

bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb-----------------------------7de1a433602ac–

1.3 借助第三方组件实现文件上传

使用 Commons-fileupload 组件实现文件上传，需要导入该组件相应的支撑 jar 包：Commons-fileupload 和commons-io。

commons-io 不属于文件上传组件的开发 jar 文件，但Commons-fileupload 组件从 1.1 版本开始，它工作时需要 commons-io 包的支持。

2. 传统方式的文件上传

2.1 说明

传统方式的文件上传，指的是我们上传的文件和访问的应用存在于同一台服务器上。

并且上传完成之后，浏览器可能跳转。

2.2 实现步骤

1. 环境的搭建：

创建 webapp 骨架的 maven 项目

添加依赖：

 <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>4.12</version>
      <scope>test</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-context</artifactId>
      <version>5.1.9.RELEASE</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-web</artifactId>
      <version>5.1.9.RELEASE</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>5.1.9.RELEASE</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>provided</scope>
    </dependency>
    <!-- https://mvnrepository.com/artifact/javax.servlet.jsp/javax.servlet.jsp-api -->
    <dependency>
      <groupId>javax.servlet.jsp</groupId>
      <artifactId>javax.servlet.jsp-api</artifactId>
      <version>2.3.3</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.9.10</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.9.10</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.9.10</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.4</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.6</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.sun.jersey/jersey-core -->
    <dependency>
      <groupId>com.sun.jersey</groupId>
      <artifactId>jersey-core</artifactId>
      <version>1.18.1</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.sun.jersey/jersey-client -->
    <dependency>
      <groupId>com.sun.jersey</groupId>
      <artifactId>jersey-client</artifactId>
      <version>1.18.1</version>
    </dependency>
  </dependencies>

配置完项目目录：

在 webapp 下创建index.jsp：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>

    <h2>传统文件上传</h2>
    <form action="file/fileUpload" method="post" enctype="multipart/form-data">
        选择文件: <input type="file" name="upload"/><br/>
        <input type="submit" value="上传"/>
    </form>

</body>
</html>

在 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" >

<web-app>
  <display-name>Archetype Created Web Application</display-name>
  <!-- 前端控制器 -->
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:springmvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>
  <filter>
    <filter-name>characterEncodingFilter</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>characterEncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

在 springmvc 配置文件中配置视图解析器：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/mvc
       http://www.springframework.org/schema/mvc/spring-mvc.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd">
    <!-- 开启注解扫描 -->
    <context:component-scan base-package="com.springmvc"></context:component-scan>

    <!-- 视图解析器 -->
    <bean id="resourceViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
        <property name="prefix" value="/WEB-INF/pages/"></property>
        <property name="suffix" value=".jsp"></property>
    </bean>

    <!-- 告诉前端控制器，哪些静态资源不拦截 -->
    <mvc:resources location="/js/" mapping="/js/**"></mvc:resources>

    <!-- 配置文件解析器对象 -->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
        <property name="maxUploadSize" value="10485760"/>
    </bean>

    <!-- 开启 springmvc 框架注解的支持 -->
    <mvc:annotation-driven></mvc:annotation-driven>
</beans>

2. 实现

编写控制器：

@Controller
@RequestMapping("/file")
public class FileUploadController {

    /**
     * 文件上传
     *
     * @return
     */
    @RequestMapping("/fileUpload")
    public String fileUpload(HttpServletRequest request) throws Exception {
        System.out.println("文件上传");
        // 使用 fileUpload 组件完成文件上传
        // 上传的位置
        String path = request.getSession().getServletContext().getRealPath("/uploads/");
        // 判断该路径是否存在
        File file = new File(path);
        if (!file.exists()) {
            // 创建该文件夹
            file.mkdirs();
        }
        // 解析 request 对象，获得上传文件项
        DiskFileItemFactory factory = new DiskFileItemFactory();
        ServletFileUpload upload = new ServletFileUpload(factory);
        // 解析request
        List<FileItem> items = upload.parseRequest(request);
        // 遍历
        for (FileItem item : items) {
            // 进行判断，当前 item 对象是否是上传文件项
            if (item.isFormField()) {
                // 说明是普通的表单项
            } else {
                // 说明上传文件项
                // 获取上传文件的名称
                String fileName = item.getName();
                // 把文件的名称设置成唯一值
                String s = UUID.randomUUID().toString().replace("-", "");
                fileName = s + "_" + fileName;
                // 完成文件上传
                item.write(new File(path, fileName));
                // 删除临时文件
                item.delete();
            }
        }
        return "success";
    }
}

3. spring mvc 方式上传

3.1 实现原理

我们使用表单提交一个文件，前端控制器拦截浏览器发送来的请求，发现该请求带有文件，所以，调用文件解析器。

文件解析器解析request的请求，拿到上传的文件。

通过参数绑定的方式，传给控制器。使用控制器中的对应方法，完成文件的上传。

3.2 实现示例

JSP：

    <h2>Spring mvc 文件上传</h2>
    <form action="file/fileUpload2" method="post" enctype="multipart/form-data">
        选择文件: <input type="file" name="upload"/><br/>
        <input type="submit" value="上传"/>
    </form>

控制器：

    /**
     * Spring MVC文件上传
     *
     * @return
     */
    @RequestMapping("/fileUpload2")
    public String fileUpload2(HttpServletRequest request, MultipartFile upload) throws Exception {
        System.out.println("spring mvc 文件上传");
        // 使用 fileUpload 组件完成文件上传
        // 上传的位置
        String path = request.getSession().getServletContext().getRealPath("/uploads/");
        // 判断该路径是否存在
        File file = new File(path);
        if (!file.exists()) {
            // 创建该文件夹
            file.mkdirs();
        }
        // 说明上传文件项
        // 获取上传文件的名称
        String filename = upload.getOriginalFilename();
        // 把文件的名称设置成唯一值
        String uuid = UUID.randomUUID().toString().replace("-", "");
        filename = uuid + "_" + filename;
        // 完成文件上传
        upload.transferTo(new File(path, filename));
        return"success";
}

4. springmvc 跨服务器方式的文件上传

4.1 分服务器的目的

在实际开发中，我们会有很多处理不同功能的服务器。例如：

应用服务器：负责部署我们的应用

数据库服务器：运行我们的数据库

缓存和消息服务器：负责处理大并发访问的缓存和消息

文件服务器：负责存储用户上传文件的服务器。

(注意：此处说的不是服务器集群）

分服务器处理的目的是让服务器各司其职，从而提高我们项目的运行效率。

4.2 实现示例

准备两个 tomcat 服务器：

tomcat9 为上传文件服务器，进行如下配置：

tomcat8 存放文件的服务器，进行如下配置：

---

创建一个新的webapp 的maven项目，并配置好的tomcat8服务器分配给该项目。该项目能运行

---

在之前文件上传的项目中，编写以下代码：

引入jar包：

    <!-- https://mvnrepository.com/artifact/com.sun.jersey/jersey-core -->
    <dependency>
      <groupId>com.sun.jersey</groupId>
      <artifactId>jersey-core</artifactId>
      <version>1.18.1</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/com.sun.jersey/jersey-client -->
    <dependency>
      <groupId>com.sun.jersey</groupId>
      <artifactId>jersey-client</artifactId>
      <version>1.18.1</version>
    </dependency>

JSP：

    <h2>Spring mvc 跨服务器文件上传</h2>
    <form action="file/fileUpload3" method="post" enctype="multipart/form-data">
        选择文件: <input type="file" name="upload"/><br/>
        <input type="submit" value="上传"/>
    </form>

控制器：

    /**
     * Spring MVC文件上传
     *
     * @return
     */
    @RequestMapping("/fileUpload3")
    public String fileUpload3(MultipartFile upload) throws Exception {
        System.out.println("spring mvc 跨服务器文件上传");
        // 定义上传文件服务器路径
        String path = "http://localhost:9090/maven_springmvc_file_upload_server/";
        // 说明上传文件项
        // 获取上传文件的名称
        String filename = upload.getOriginalFilename();
        // 把文件的名称设置成唯一值
        String uuid = UUID.randomUUID().toString().replace("-", "");
        filename = uuid + "_" + filename;
        // 创建客户端对象
        Client client = Client.create();
        // 和图片服务器进行连接
        WebResource resource = client.resource(path + filename);
        // 上传文件
        resource.put(upload.getBytes());
        return"success";
    }

4.3 错误的排查

在进行测试的时候，会出现两个错误：

第一个：

上传服务器发生500错误，而存放文件服务器发生405错误。

原因：

tomcat 服务器默认只能进行读取操作。

解决：

配置tomcat根目录下的conf文件夹中的web.xml，在其中的servlet标签中添加以下代码：

        <init-param>
            <param-name>readonly</param-name>
            <param-value>false</param-value>
        </init-param>

---

第二个：

上传服务器发生500错误，而存放文件服务器发生409错误。

愿意：

控制器代码没有创建文件夹的语句，所以项目的工作空间中并没有uploads文件夹。

解决：

添加文件夹即可：