文件的上传

文件的上传

form表单的要求

1.       必须使用表单，而不能是超链接；

2.       表单的method必须是POST，而不能是GET；

3.       表单的enctype必须是multipart/form-data；

4.       在表单中添加file表单字段，即<input type=”file”…/>

Servlet的要求

当提交的表单是文件上传表单时，那么对Servlet也是有要求的。

首先我们要肯定一点，文件上传表单的数据也是被封装到request对象中的。

request.getParameter(String)方法获取指定的表单字段字符内容，但文件上传表单已经不在是字符内容，而是字节内容，所以失效。

 

这时可以使用request的getInputStream()方法获取ServletInputStream对象，它是InputStream的子类，这个ServletInputStream对象对应整个表单的正文部分（从第一个分隔线开始，到最后），这说明我们需要的解析流中的数据。当然解析它是很麻烦的一件事情，而Apache已经帮我们提供了解析它的工具：commons-fileupload。

 例子

form表单

<form action="<c:url value='/Upload1Servlet'/>" method="post" enctype="multipart/form-data">
        用户名：<input type="text" name="username"/><br/>
        简　历：<input type="file" name="resume"/><br/>
        <input type="submit" value="提交"/>
    </form>

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.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

public class Upload1Servlet extends HttpServlet {

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // 因为要使用response打印，所以设置其编码
                request.setCharacterEncoding("UTF-8");
                response.setContentType("text/html;charset=utf-8");
                
                // 创建工厂
                DiskFileItemFactory dfif = new DiskFileItemFactory();
                // 使用工厂创建解析器对象
                ServletFileUpload fileUpload = new ServletFileUpload(dfif);
                try {
                    // 使用解析器对象解析request，得到FileItem列表
                    List<FileItem> list = fileUpload.parseRequest(request);
                    // 遍历所有表单项
                    for(FileItem fileItem : list) {
                        // 如果当前表单项为普通表单项
                        if(fileItem.isFormField()) {
                            // 获取当前表单项的字段名称
                            String fieldName = fileItem.getFieldName();
                            // 如果当前表单项的字段名为username
                            if(fieldName.equals("username")) {
                                // 打印当前表单项的内容，即用户在username表单项中输入的内容
                                response.getWriter().print("用户名：" + fileItem.getString() + "<br/>");
                            }
                        } else {//如果当前表单项不是普通表单项，说明就是文件字段
                            String name = fileItem.getName();//获取上传文件的名称
                            // 如果上传的文件名称为空，即没有指定上传文件
                            if(name == null || name.isEmpty()) {
                                continue;
                            }
                            System.out.println(name);
                            // 获取真实路径，对应${项目目录}/uploads，当然，这个目录必须存在
                            String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");
                            // 通过uploads目录和文件名称来创建File对象
                            File file = new File(savepath, name);
                            // 把上传文件保存到指定位置
                            fileItem.write(file);
                            // 打印上传文件的名称
                            response.getWriter().print("上传文件名：" + name + "<br/>");
                            // 打印上传文件的大小
                            response.getWriter().print("上传文件大小：" + fileItem.getSize() + "<br/>");
                            // 打印上传文件的类型
                            response.getWriter().print("上传文件类型：" + fileItem.getContentType() + "<br/>");
                        }
                    }
                } catch (Exception e) {
                    throw new ServletException(e);
                }
    }}

上传文件的细节

文件名称（完整路径、文件名称）

上传文件名称可能是完整路径：

IE6获取的上传文件名称是完整路径，而其他浏览器获取的上传文件名称只是文件名称而已。浏览器差异的问题我们还是需要处理一下的。

           String name = file1FileItem.getName();

           response.getWriter().print(name);

 

使用不同浏览器测试，其中IE6就会返回上传文件的完整路径，不知道IE6在搞什么，这给我们带来了很大的麻烦，就是需要处理这一问题。

处理这一问题也很简单，无论是否为完整路径，我们都去截取最后一个“\\”后面的内容就可以了。

           String name = file1FileItem.getName();

           int lastIndex = name.lastIndexOf("\\");//获取最后一个“\”的位置

           if(lastIndex != -1) {//注意，如果不是完整路径，那么就不会有“\”的存在。

              name = name.substring(lastIndex + 1);//获取文件名称

           }

           response.getWriter().print(name);

中文乱码问题

上传文件名称中包含中文：

当上传的谁的名称中包含中文时，需要设置编码，commons-fileupload组件为我们提供了两种设置编码的方式：

l  request.setCharacterEncoding(String)：这种方式是我们最为熟悉的方式了；

l  fileUpload.setHeaderEncdoing(String)：这种方式的优先级高与前一种。

 

上传文件的文件内容包含中文：

通常我们不需关心上传文件的内容，因为我们会把上传文件保存到硬盘上！也就是说，文件原来是什么样子，到服务器这边还是什么样子！

但是如果你有这样的需求，非要在控制台显示上传的文件内容，那么你可以使用fileItem.getString(“utf-8”)来处理编码。

文本文件内容和普通表单项内容使用FileItem类的getString(“utf-8”)来处理编码。

上传文件同名问题（文件重命名）

通常我们会把用户上传的文件保存到uploads目录下，但如果用户上传了同名文件呢？这会出现覆盖的现象。处理这一问题的手段是使用UUID生成唯一名称，然后再使用“_”连接文件上传的原始名称。

例如用户上传的文件是“我的一寸照片.jpg”，在通过处理后，文件名称为：“891b3881395f4175b969256a3f7b6e10_我的一寸照片.jpg”，这种手段不会使文件丢失扩展名，并且因为UUID的唯一性，上传的文件同名，但在服务器端是不会出现同名问题的。

 

    publicvoid doPost(HttpServletRequest request, HttpServletResponse response)

           throws ServletException, IOException {

       request.setCharacterEncoding("utf-8");

       DiskFileItemFactory dfif =new DiskFileItemFactory();

       ServletFileUpload fileUpload =new ServletFileUpload(dfif);

       try {

           List<FileItem> list = fileUpload.parseRequest(request);

           //获取第二个表单项，因为第一个表单项是username，第二个才是file表单项

           FileItem fileItem = list.get(1);

           String name = fileItem.getName();//获取文件名称

          

           //如果客户端使用的是IE6，那么需要从完整路径中获取文件名称

           int lastIndex = name.lastIndexOf("\\");

           if(lastIndex != -1) {

              name = name.substring(lastIndex + 1);

           }

          

           //获取上传文件的保存目录

           String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");

           String uuid = CommonUtils.uuid();//生成uuid

           String filename = uuid +"_" + name;//新的文件名称为uuid +下划线 + 原始名称

          

           //创建file对象，下面会把上传文件保存到这个file指定的路径

           //savepath，即上传文件的保存目录

           //filename，文件名称

           File file = new File(savepath, filename);

          

           //保存文件

           fileItem.write(file);

       } catch (Exception e) {

           thrownew ServletException(e);

       }

    }

一个目录不能存放过多的文件（存放目录打散）

一个目录下不应该存放过多的文件，一般一个目录存放1000个文件就是上限了，如果在多，那么打开目录时就会很“卡”。你可以尝试打印C:\WINDOWS\system32目录，你会感觉到的。

也就是说，我们需要把上传的文件放到不同的目录中。但是也不能为每个上传的文件一个目录，这种方式会导致目录过多。所以我们应该采用某种算法来“打散”！

打散的方法有很多，例如使用日期来打散，每天生成一个目录。也可以使用文件名的首字母来生成目录，相同首字母的文件放到同一目录下。

日期打散算法：如果某一天上传的文件过多，那么也会出现一个目录文件过多的情况；

首字母打散算法：如果文件名是中文的，因为中文过多，所以会导致目录过多的现象。

 

我们这里使用hash算法来打散：

1.      获取文件名称的hashCode：int hCode = name.hashCode();；

2.      获取hCode的低4位，然后转换成16进制字符；

3.      获取hCode的5~8位，然后转换成16进制字符；

4.      使用这两个16进制的字符生成目录链。例如低4位字符为“5”

 

这种算法的好处是，在uploads目录下最多生成16个目录，而每个目录下最多再生成16个目录，即256个目录，所有上传的文件都放到这256个目录下。如果每个目录上限为1000个文件，那么一共可以保存256000个文件。

 

例如上传文件名称为：新建文本文档.txt，那么把“新建 文本文档.txt”的哈希码获取到，再获取哈希码的低4位，和5~8位。假如低4位为：9，5~8位为1，那么文件的保存路径为uploads/9/1/。

 

    int hCode = name.hashCode();//获取文件名的hashCode

    //获取hCode的低4位，并转换成16进制字符串

    String dir1 = Integer.toHexString(hCode & 0xF);

    //获取hCode的低5~8位，并转换成16进制字符串

    String dir2 = Integer.toHexString(hCode >>> 4 & 0xF);

    //与文件保存目录连接成完整路径

    savepath = savepath + "/" + dir1 + "/" + dir2;

    //因为这个路径可能不存在，所以创建成File对象，再创建目录链，确保目录在保存文件之前已经存在

    new File(savepath).mkdirs();

上传的单个文件的大小限制

限制上传文件的大小很简单，ServletFileUpload类的setFileSizeMax(long)就可以了。参数就是上传文件的上限字节数，例如servletFileUpload.setFileSizeMax(1024*10)表示上限为10KB。

一旦上传的文件超出了上限，那么就会抛出FileUploadBase.FileSizeLimitExceededException异常。我们可以在Servlet中获取这个异常，然后向页面输出“上传的文件超出限制”。

    publicvoid doPost(HttpServletRequest request, HttpServletResponse response)

           throws ServletException, IOException {

       request.setCharacterEncoding("utf-8");

       DiskFileItemFactory dfif =new DiskFileItemFactory();

       ServletFileUpload fileUpload =new ServletFileUpload(dfif);

        // 设置上传的单个文件的上限为10KB

       fileUpload.setFileSizeMax(1024 * 10);

       try {

           List<FileItem> list =fileUpload.parseRequest(request);

           //获取第二个表单项，因为第一个表单项是username，第二个才是file表单项

           FileItem fileItem = list.get(1);

           String name = fileItem.getName();//获取文件名称

          

           //如果客户端使用的是IE6，那么需要从完整路径中获取文件名称

           int lastIndex = name.lastIndexOf("\\");

           if(lastIndex != -1) {

              name = name.substring(lastIndex + 1);

           }

          

           //获取上传文件的保存目录

           String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");

           String uuid = CommonUtils.uuid();//生成uuid

           String filename = uuid +"_" + name;//新的文件名称为uuid +下划线 + 原始名称

          

           int hCode = name.hashCode();//获取文件名的hashCode

           //获取hCode的低4位，并转换成16进制字符串

           String dir1 = Integer.toHexString(hCode & 0xF);

           //获取hCode的低5~8位，并转换成16进制字符串

           String dir2 = Integer.toHexString(hCode >>> 4 & 0xF);

           //与文件保存目录连接成完整路径

           savepath = savepath +"/" + dir1 + "/" + dir2;

           //因为这个路径可能不存在，所以创建成File对象，再创建目录链，确保目录在保存文件之前已经存在

           new File(savepath).mkdirs();

          

           //创建file对象，下面会把上传文件保存到这个file指定的路径

           //savepath，即上传文件的保存目录

           //filename，文件名称

           File file = new File(savepath, filename);

          

           //保存文件

           fileItem.write(file);

       } catch (Exception e) {

           //判断抛出的异常的类型是否为FileUploadBase.FileSizeLimitExceededException

           //如果是，说明上传文件时超出了限制。

           if(einstanceof FileUploadBase.FileSizeLimitExceededException) {

              //在request中保存错误信息

              request.setAttribute("msg","上传失败！上传的文件超出了10KB！");

              //转发到index.jsp页面中！在index.jsp页面中需要使用${msg}来显示错误信息

              request.getRequestDispatcher("/index.jsp").forward(request, response);

              return;

           }

  thrownew ServletException(e);

       }

    }

---

上传文件的表单中可能允许上传多个文件，例如：

 

有时我们需要限制一个请求的大小。也就是说这个请求的最大字节数（所有表单项之和）！实现这一功能也很简单，只需要调用ServletFileUpload类的setSizeMax(long)方法即可。

例如fileUpload.setSizeMax(1024 * 10);，显示整个请求的上限为10KB。当请求大小超出10KB时，ServletFileUpload类的parseRequest()方法会抛出FileUploadBase.SizeLimitExceededException异常。

 

缓存大小与临时目录

大家想一想，如果我上传一个蓝光电影，先把电影保存到内存中，然后再通过内存copy到服务器硬盘上，那么你的内存能吃的消么？

所以fileupload组件不可能把文件都保存在内存中，fileupload会判断文件大小是否超出10KB，如果是那么就把文件保存到硬盘上，如果没有超出，那么就保存在内存中。

　　10KB是fileupload默认的值，我们可以来设置它。

　　当文件保存到硬盘时，fileupload是把文件保存到系统临时目录，当然你也可以去设置临时目录。

　　

　　

    publicvoid doPost(HttpServletRequest request, HttpServletResponse response)

           throws ServletException, IOException {

       request.setCharacterEncoding("utf-8");

       DiskFileItemFactory dfif =new DiskFileItemFactory(1024*20,new File("F:\\temp"));

       ServletFileUpload fileUpload =new ServletFileUpload(dfif);

      

       try {

           List<FileItem> list = fileUpload.parseRequest(request);

           FileItem fileItem = list.get(1);

           String name = fileItem.getName();

           String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");

          

           //保存文件

           fileItem.write(path(savepath, name));

       } catch (Exception e) {

           thrownew ServletException(e);

       }

    }

   

    private Filepath (String savepath, String filename) {

       //从完整路径中获取文件名称

       int lastIndex = filename.lastIndexOf("\\");

       if(lastIndex != -1) {

           filename = filename.substring(lastIndex + 1);

       }

      

       //通过文件名称生成一级、二级目录

       int hCode = filename.hashCode();

       String dir1 = Integer.toHexString(hCode & 0xF);

       String dir2 = Integer.toHexString(hCode >>> 4 & 0xF);

       savepath = savepath + "/" + dir1 + "/" + dir2;

       //创建目录

       new File(savepath).mkdirs();

      

       //给文件名称添加uuid前缀

       String uuid = CommonUtils.uuid();

       filename = uuid + "_" + filename;

      

       //创建文件完成路径

       returnnew File(savepath, filename);

    }

---