javaWeb学习记录：文件上传与下载

在web开发中经常需要上传或下载文件，这篇文章记录一下文件上传和下载需要注意的知识点。

文件上传

上传对form表单的要求

• method方法必须是POST，不能是GET
• 新加一个属性enctype，值为”multipart/form-data”
• 文件表单项<input>的类型为file，即type=”file”

简单的例子：

<form action="xxx" method="post" enctype="multipart/form-data">
  用户名；<input type="text" name="username"/><br/>
  照　片：<input type="file" name="photo"/><br/>
  <input type="submit" value="上传"/>
</form>

上传对servlet的要求

之前写web时，要获取表单项的某个值，我们用request.getParametere(“xxx”)方法，但是再处理上传文件的表单时，不能用这个方法，即便form里有一些表单项的类型是text也不行。
这时要用到apache的commons组件提供的上传组件-fileupload。需要两个jar包。核心包：commons-fileupload.jar；
依赖包：commons-io.jar。

使用fileupload组件的步骤如下：
1. 创建工厂类DiskFileItemFactory对象：DiskFileItemFactory factory = new DiskFileItemFactory()
2. 使用工厂创建解析器对象：ServletFileUpload fileUpload = new ServletFileUpload(factory)
3. 使用解析器来解析request对象：List<FileItem> list = fileUpload.parseRequest(request)

第三步得到表单里的所有表单项，每个表单项是一个FileItem对象，一个表单中存在文件字段和普通字段，可以使用FileItem类的isFormField()方法来判断表单字段是否为普通字段，返回true则是普通字段，否则为文件字段。
FileItem类一些常用的方法如下：

• String getName()：获取文件字段的文件名称；
• String getString()：获取字段的内容，如果是文件字段，那么获取的是文件内容，当然上传的文件必须是文本文件；
• String getFieldName()：获取字段名称，例如：<input type=”text” name=”username”/>，返回的是username；
• String getContentType()：获取上传的文件的类型，例如：text/plain。
• int getSize()：获取上传文件的大小；
• boolean isFormField()：判断当前表单字段是否为普通文本字段，如果返回false，说明是文件字段；
• InputStream getInputStream()：获取上传文件对应的输入流；
• void write(File)：把上传的文件保存到指定文件中。

代码实例

表单

<form action="<c:url value='/UploadServlet'/>" method="post" enctype="multipart/form-data">
    姓名：<input type="text" name="username" /><br/>
    照片：<input type="file" name="photo" /><br/>
    <input type="submit" value="上传" />
</form>

servlet

package com.upload.servlet;

import java.io.File;
import java.io.IOException;
import java.util.List;

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

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

public class UploadServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        //得到工厂
        DiskFileItemFactory factory = new DiskFileItemFactory();
        //创建解析器
        ServletFileUpload sfu = new ServletFileUpload(factory);

        try {
            //解析request，得到FileItem集合
            List<FileItem> list = sfu.parseRequest(request);
            FileItem file1 = list.get(0);
            FileItem file2 = list.get(1);

            System.out.println("普通表单项演示：" + file1.getFieldName() + "=" + 
                    file1.getString("utf-8"));
            System.out.println("文件表单项演示：");
            System.out.println("Content-type:" + file2.getContentType());
            System.out.println("filename:" + file2.getName());
            System.out.println("size:" + file2.getSize());

            //保存文件
            File destFile = new File("f:/dj.jpg");
            try {
                file2.write(destFile);
            } catch (Exception e) {
                e.printStackTrace();
            }
        } catch (FileUploadException e) {
            e.printStackTrace();
        }

    }

}

输出结果

文件上传需要注意的细节

文件必须保存到WEB-INF下

如果没有把用户上传的文件存放到WEB-INF目录下，那么用户就可以通过浏览器直接访问上传的文件，这是非常危险的。为了不让用户通过浏览器直接访问文件，需要把文件保存到WEB-INF目录下！
通常我们会在WEB-INF目录下创建一个uploads目录来存放上传的文件，而在Servlet中找到这个目录需要使用ServletContext的getRealPath(String)方法，如下语句：

ServletContext servletContext = this.getServletContext();
String savepath = servletContext.getRealPath(“/WEB-INF/uploads”);

文件名称相关问题

1.有的浏览器(IE6)上传的文件名是绝对路径，这需要切割！比如文件名为C:\files\beaty.jpg

String filename = file.getName();
int index = filename.lastIndexOf("\\");
if(index != -1) {//说明是绝对路径
    filename = filename.substring(index+1);
}

2.文件名乱码或者普通表单项乱码。主要是文件名含有中文的问题。commons-fileupload组件为我们提供了两种设置编码的方式：
- request.setCharacterEncoding(String)：这种方式是我们最为熟悉的方式了；
- fileUpload.setHeaderEncdoing(String)：这种方式的优先级高与前一种。

3.文件同名问题；我们需要为每个文件添加名称前缀，这个前缀要保证不能重复。处理这一问题的手段是使用UUID生成唯一名称，然后再使用“_”连接文件上传的原始名称。

存放目录打散

一个目录下不应该存放过多的文件，一般一个目录存放1000个文件就是上限了，如果过多，那么打开目录时就会很“卡”。也就是说，我们需要把上传的文件放到不同的目录中。但是也不能为每个上传的文件一个目录，这种方式会导致目录过多。所以我们应该采用某种算法来“打散”！这里使用hash算法来打散。

上传文件的大小限制

限制上传文件的大小很简单，ServletFileUpload类的setFileSizeMax(long)就可以了。参数就是上传文件的上限字节数，例如servletFileUpload.setFileSizeMax(1024*10)表示上限为10KB。一旦上传的文件超出了上限，那么就会抛出FileUploadBase.FileSizeLimitExceededException异常。我们可以在Servlet中获取这个异常，然后向页面输出“上传的文件超出限制”。
上传文件的表单中可能允许上传多个文件，有时我们需要限制一个请求的大小。也就是说这个请求的最大字节数（所有表单项之和）！实现这一功能也很简单，只需要调用ServletFileUpload类的setSizeMax(long)方法即可。
例如fileUpload.setSizeMax(1024 * 10);，显示整个请求的上限为10KB。当请求大小超出10KB时，ServletFileUpload类的parseRequest()方法会抛出FileUploadBase.SizeLimitExceededException异常。

缓存大小与临时目录

当上传较大的文件时，fileupload组件不可能把文件都保存在内存中，那样内存吃不消。10KB是缓存的默认大小，超过这个值了，它会把文件保存到硬盘上，如果没有超出，那么就保存在内存中。
设置缓存大小与临时目录：new DiskFileItemFactory(20*1024, new File(“F:/temp”))

综合以上细节，代码如下：

package com.upload.servlet;

import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.UUID;

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

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadBase;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

public class UploadServlet extends HttpServlet {
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        //得到工厂
        DiskFileItemFactory factory = new DiskFileItemFactory();
        //设置缓存大小和目录
        //DiskFileItemFactory factory = new DiskFileItemFactory(20*1024, new File("F:/temp"));

        //创建解析器
        ServletFileUpload sfu = new ServletFileUpload(factory);
        sfu.setHeaderEncoding("utf-8");
        //解析之前，设置上传文件大小的限制
        sfu.setFileSizeMax(10*1024);//限制单个文件大小
        sfu.setSizeMax(1024*1024);//限制整个表单数据大小

        try {
            //解析request，得到FileItem集合
            List<FileItem> list = sfu.parseRequest(request);
            FileItem file2 = list.get(1);//文件表单项

            /*
             * 保存文件
             */

            //1.处理文件名绝对路径问题
            String fileName = file2.getName();//获取文件名
            int index = fileName.lastIndexOf("\\");
            if(index != -1){
                fileName = fileName.substring(index+1);
            }

            //2.给文件名加前缀，UUID，防止重名
            String saveName = UUID.randomUUID().toString() + "_" + fileName;

            //3.文件保存到WEB-INF目录下，打散目录
            String root = this.getServletContext().getRealPath("/WEB-INF/uploads/");
            //得到hash code
            int hashCode = fileName.hashCode();
            String hex = Integer.toHexString(hashCode);

            //获得hex的前两个字母，与root连接在一起得到一个完整的路径
            File dirFile = new File(root,hex.charAt(0) + "/" + hex.charAt(1));
            //创建目录链,自动创建整个路径里不存在的文件夹
            dirFile.mkdirs();
            //创建目标文件
            File destFile = new File(dirFile,saveName);

            //保存文件
            file2.write(destFile);

        } catch (FileUploadException e) {
            if(e instanceof FileUploadBase.FileSizeLimitExceededException){
                request.setAttribute("mag", "文件大小超出10K，请重新选择要上传的文件！");
                request.getRequestDispatcher("/index.jsp").forward(request, response);
            }
        }catch (Exception e) {
            e.printStackTrace();
        }

    }

}

文件下载

被下载的资源必须放到WEB-INF目录下（只要用户不能通过浏览器直接访问就OK），然后通过Servlet完成下载。

jsp页面代码：

<a href="<c:url value='/DownloadServlet?path=a.jpg'/>">a.jpg</a><br/>
<a href="<c:url value='/DownloadServlet?path=中国.jpg'/>">中国.jpg</a><br/>

servlet代码：

package com.upload.servlet;

import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.net.URLEncoder;

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

import org.apache.commons.io.IOUtils;

public class DownloadServlet extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        String filename = request.getParameter("path");
        filename = new String(filename.getBytes("ISO-8859-1"),"utf-8");

        //通过文件名称获取MIME类型
        String contentType = this.getServletContext().getMimeType(filename);
        String contentDisposition = "attachment;filename=" + 
                    URLEncoder.encode(filename, "utf-8");

        //设置头
        response.setHeader("Content-Type", contentType);
        response.setHeader("Content-Disposition", contentDisposition);

        String filepath = this.getServletContext().getRealPath("/WEB-INF/uploads/" + filename); 
        File file = new File(filepath);

        IOUtils.copy(new FileInputStream(file), response.getOutputStream()); 
    }
}