SpringMVC学习03:文件上传

文件上传的原理

实现文件上传的前提

1. <form>表单的enctype属性取值必须是multipart/form-data(默认值是application/x-www-form-urlencoded),表示表单内容是分块的.这时request对象的getParameter()方法将失效.

2. <form>表单的method属性取值必须是post,因为get请求长度有限制.

3. 提供一个<input/>标签,用来选择上传文件.

   <form action="/fileUpload/uploadHandler" method="post" enctype="multipart/form-data">
       param1<input type="text" name="param1"/><br/>
       param2<input type="text" name="param2"/><br/>
       选择文件<input type="file" name="fileParam"/><br/>
       <input type="submit" value="上传文件"/>
   </form>
   

   当然,也可以通过Ajax请求的方式上传文件

   // 构建数据
   var data = new FormData()
   data.append('name', $('[name=name]').val())
   data.append('file', $('[name=thumb]')[0].files[0]) // file 对象
   
   // 提交
   $.ajax('/fileUpload/uploadHandler',{
       method: 'POST',
       data: data,
       processData: false,    // 默认 | 不处理数据
       contentType: false     // 默认 | 不设置内容类型
       ...
   })
   

   关于如何使用Ajax发送文件,可以参考这篇文章JQuery 教程 - 简明教程

4. 引用文件上传的相关jar包

   <dependency>
       <groupId>commons-fileupload</groupId>
       <artifactId>commons-fileupload</artifactId>
       <version>1.3.1</version>
   </dependency>
   <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
       <version>2.4</version>
   </dependency>
   

文件表单内容

因为我们设置了enctype属性取值为multipart/form-data,因此在请求参数头中会有一项Content-Type:multipart/form-data; boundary=----WebKitFormBoundaryOMtUEa1sSZ3ayCfC,表示当前表单内容数据是分块的,每两块之间以----WebKitFormBoundaryOMtUEa1sSZ3ayCfC分界.

服务器通过遍历每一块数据,找到文件所在的数据块并执行保存.

文件上传的三种实现

使用JavaEE进行文件上传

传统的JavaEE文件上传思路是通过解析request对象,获取表单中的上传文件项并执行保存.

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

	@RequestMapping("/javaEE")
    public String fileupload1(HttpServletRequest request) throws Exception {
  
        // 创建目录保存上传的文件
        String path = request.getSession().getServletContext().getRealPath("/uploads/");
        File file = new File(path);
        if (!file.exists()) {
            file.mkdirs();
        }

        // 创建ServletFileUpload来解析request
        ServletFileUpload upload = new ServletFileUpload(new DiskFileItemFactory());
        List<FileItem> items = upload.parseRequest(request);
        // 遍历解析的结果,寻找上传文件项
        for (FileItem item : items) { 
            if (!item.isFormField()) {
                // 不是普通表单项,说明是文件上传项
                
                // 服务器中保存的文件名
                String filename = UUID.randomUUID().toString().replace("-", "") + "_" + item.getName();
                // 上传文件
                item.write(new File(path, filename));
                // 删除临时文件
                item.delete();
            }
        }

        return "success";
    }
}

使用SpringMVC进行单服务器文件上传

可以使用SpringMVC提供的文件解析器实现文件上传,在Spring容器中注入文件解析器CommonsMultipartResolver对象如下:

<!-- 配置文件解析器,其id是固定的,必须为multipartResolver -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    <!-- 设置文件的最大尺寸 -->
    <property name="maxUploadSize" value="10485760"/>
</bean>

只要在处理器方法的参数列表中定义一个与表单文件项同名的MultipartFile参数,就可以将上传的文件绑定到该MultipartFile对象上,调用其transferTo(File file)方法即可保存文件.

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

	@RequestMapping("/springMVC")
    public String fileupload2(HttpServletRequest request, @RequestParam("fileParam") MultipartFile upload) throws Exception {
        
        // 创建目录保存上传的文件
        String path = request.getSession().getServletContext().getRealPath("/uploads/");
        File file = new File(path);
        if (!file.exists()) {
            file.mkdirs();
        }

        // 服务器中保存的文件名
        String filename = UUID.randomUUID().toString().replace("-", "") + "_" + upload.getOriginalFilename();
        // 上传文件
        upload.transferTo(new File(path,filename));

        return "success";
    }
}

使用SpringMVC进行跨服务器文件上传

我们可以引入jersey库进行服务器间通信,实现将文件上传到一个专用的文件服务器,需要在pom.xml中引入jersey库的坐标如下:

<dependency>
    <groupId>com.sun.jersey</groupId>
    <artifactId>jersey-core</artifactId>
    <version>1.18.1</version>
</dependency>
<dependency>
    <groupId>com.sun.jersey</groupId>
    <artifactId>jersey-client</artifactId>
    <version>1.18.1</version>
</dependency>

在处理器方法中创建Client对象实现服务器间通信,将文件上传到文件服务器上,代码如下:

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

	@RequestMapping("/betweenServer")
    public String fileupload3(@RequestParam("fileParam") MultipartFile upload) throws Exception {
        System.out.println("跨服务器文件上传...");

        // 文件服务器URL
        String fileServerPath = "http://localhost:9090/uploads/";	
        
        // 获取服务器中保存的文件名
        String filename = UUID.randomUUID().toString().replace("-", "") + "_" + upload.getOriginalFilename();

        // 创建客户端对象并在文件服务器上创建资源
        Client client = Client.create();
        WebResource webResource = client.resource(fileServerPath + filename);
        webResource.put(upload.getBytes());

        return "success";
    }
}

编写处理文件的工具类

我们将上述程序中对文件的处理封装成抽象类FileUtil:

package cn.maoritian.utils;

import java.io.File;
import java.io.FileOutputStream;
import java.util.UUID;

public class FileUtil {

    // 上传文件
    public static void uploadFile(byte[] file, String filePath, String fileName) throws Exception {
        File targetFile = new File(filePath);
        if (!targetFile.exists()) {
            targetFile.mkdirs();
        }
        FileOutputStream out = new FileOutputStream(filePath + fileName);
        out.write(file);
        out.flush();
        out.close();
    }

    // 删除文件,返回值表示是否删除成功
    public static boolean deleteFile(String fileName) {
        File file = new File(fileName);
        // 如果文件路径所对应的文件存在，并且是一个文件，则直接删除
        if (file.exists() && file.isFile()) {
            if (file.delete()) {
                return true;
            } else {
                return false;
            }
        } else {
            return false;
        }
    }

    // 重命名文件
    public static String renameToUUID(String fileName) {
        return UUID.randomUUID() + "." + fileName.substring(fileName.lastIndexOf(".") + 1);
    }
}

保存文件的操作可简化为如下三句:

String fileName = FileUtil.renameToUUID(uploadFile.getOriginalFilename());
String filePath = request.getSession().getServletContext().getRealPath("/uploads/");
FileUtil.uploadFile(uploadFile.getBytes(), filePath, fileName);