文件上传

文件的上传

文件上传

实现web开发中的文件上传的功能，需完成以下两步操作：
* 在web页面中添加上传输入项
* 在servlet中读取上传文件的数据，并保存到本地硬盘中。

上传输入项

<input type="file"> 标签用于在web页面中添加文件上传输入项，设置文件上传输入项时须注意：
1、必须要设置input输入项的name属性，否则浏览器将不会发送上传文件的数据。
２、必须把form的enctype属值设为multipart/form-data.设置该值后，浏览器在上传文件时，将把文件数据附带在http请求消息体中，并使用ＭＩＭＥ协议对上传的文件进行描述，以方便接收方对上传数据进行解析和处理。
即：

    <form action="#" method="post" enctype="multipart/form-data">
        <input type="file" name="file">
    </from>

在Servlet中处理上传文件

NT：
当表单的提交类型为multipart/form-data时，此时在Servlet中就不能以传统的方式获取了。此时可以使用：
InputStream in = request.getInputStream();

但此时的数据已经是有MIME封装，解析起来比较麻烦，这么麻烦的事情别人已经完成了，我们只需使用即可

fileupload组件

为方便用户处理文件上传数据，Apache 开源组织提供了一个用来处理表单文件上传的一个开源组件（ Commons-fileupload ），该组件性能优异，并且其API使用极其简单，可以让开发人员轻松实现web文件上传功能，因此在web开发中实现文件上传功能，通常使用Commons-fileupload组件实现。

使用步骤：
1. 当然是导jar包了： Commons-fileupload（主要实现）、commons-io（起支持作用）。 这两个包一个都不能少!
2. 使用
在使用，之前应先了解一下，fileupload的工作流程：
图片

从上图知我们需要使用这些API:

• DiskFileItemFactory
  它是创建 FileItem 对象的工厂，这个工厂类常用方法：

public void setSizeThreshold(int sizeThreshold)
设置内存缓冲区的大小，默认值为10K。当上传文件大于缓冲区大小时， fileupload组件将使用临时文件缓存上传文件。

public void setRepository(java.io.File repository)
指定临时文件目录，默认值为System.getProperty(“java.io.tmpdir”).

public DiskFileItemFactory(int sizeThreshold, java.io.File repository)
构造函数

• ServletFileUpload
  它负责处理上传的文件数据，并将表单中每个输入项封装成一个 FileItem 对象中。常用方法有：

boolean isMultipartContent(HttpServletRequest request)
判断上传表单是否为multipart/form-data类型

List parseRequest(HttpServletRequest request)
解析request对象，并把表单中的每一个输入项包装成一个fileItem 对象，并返回一个保存了所有FileItem的list集合。

setFileSizeMax(long fileSizeMax)
设置上传文件的最大值

setSizeMax(long sizeMax)
设置上传文件总量的最大值

setHeaderEncoding(java.lang.String encoding)
设置编码格式

setProgressListener(ProgressListener pListener)
设置进程监听器

实现步骤
１、创建DiskFileItemFactory对象，设置缓冲区大小和临时文件目录
２、使用DiskFileItemFactory 对象创建ServletFileUpload对象，并设置上传文件的大小限制。
３、调用ServletFileUpload.parseRequest方法解析request对象，得到一个保存了所有上传内容的List对象。
４、对list进行迭代，每迭代一个FileItem对象，调用其isFormField方法判断是否是上传文件
为普通表单字段，则调用getFieldName、getString方法得到字段名和字段值
为上传文件，则调用getInputStream方法得到数据输入流，从而读取上传数据。

编码实现：

public class WebUtils {

    public static Upfile doUpload(HttpServletRequest request, String uppath) throws FileSizeLimitExceededException {
        Upfile bean = new Upfile();
        try{
            DiskFileItemFactory factory = new DiskFileItemFactory();
            factory.setRepository(new File(request.getSession().getServletContext().getRealPath("/WEB-INF/temp")));
            ServletFileUpload upload = new ServletFileUpload(factory);
            upload.setHeaderEncoding("UTF-8");
            upload.setFileSizeMax(1000*1000*500);
            List<FileItem> list = upload.parseRequest(request);

            for(FileItem item : list){
                if(item.isFormField()){
                    String name = item.getFieldName();  //username=aaa  description=bbb
                    String value = item.getString("UTF-8");
                    BeanUtils.setProperty(bean, name, value);
                }else{
                    //得到上传文件名
                    String filename = item.getName().substring(item.getName().lastIndexOf("\\")+1);
                    //得到文件的保存名称
                    String uuidname = generateFilename(filename);
                    //得到文件的保存路径
                    String savepath = generateSavePath(uppath,uuidname);

                    InputStream in = item.getInputStream();
                    int len = 0;
                    byte buffer[] = new byte[1024];
                    FileOutputStream out = new FileOutputStream(savepath + "\\" + uuidname);
                    while((len=in.read(buffer))>0){
                        out.write(buffer, 0, len);
                    }
                    in.close();
                    out.close();
                    item.delete();

                    bean.setFilename(filename);
                    bean.setId(UUID.randomUUID().toString());
                    bean.setSavepath(savepath);
                    bean.setUptime(new Date());
                    bean.setUuidname(uuidname);
                }
            }
            return bean;
        }catch (FileUploadBase.FileSizeLimitExceededException e) {
            throw e;
        }catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

    private static String generateFilename(String filename){
        String ext = filename.substring(filename.lastIndexOf(".")+1);
        return UUID.randomUUID().toString()+ "." + ext;
    }

    private static String generateSavePath(String path,String filename){
        int hashcode = filename.hashCode();  //121221
        int dir1 = hashcode&15;
        int dir2 = (hashcode>>4)&0xf;

        String savepath = path + File.separator + dir1 + File.separator + dir2;
        File file = new File(savepath);
        if(!file.exists()){
            file.mkdirs();
        }
        return savepath;
    }

}

文件上传中的细节问题

• 中文文件乱码问题

  1. 文件名中文乱码问题
     可调用ServletUpLoader的setHeaderEncoding方法，或者设置request的setCharacterEncoding属性
  2. 普通输入项的乱码问题
     NT：当表单的提交类型为multipart/form-data时，此时设置request的编码无效的，可以这样解决
     FileItem.getString(“UTF-8”);

• 临时文件的删除问题
  由于文件大小超出DiskFileItemFactory.setSizeThreshold方法设置的内存缓冲区的大小时，Commons-fileupload组件将使用临时文件保存上传数据，因此在程序结束时，务必调用FileItem.delete方法删除临时文件。
  Delete方法的调用必须位于流关闭之后，否则会出现文件占用，而导致删除失败的情况。

• 文件存放位置
  为保证服务器安全，上传文件应保存在应用程序的WEB-INF目录下，或者不受WEB服务器管理的目录。
  为防止多用户上传相同文件名的文件，而导致文件覆盖的情况发生，文件上传程序应保证上传文件具有唯一文件名。
  为防止单个目录下文件过多，影响文件读写速度，处理上传文件的程序应根据可能的文件上传总量，选择合适的目录结构生成算法，将上传文件分散存储。
  NT： 具体算法见上面的代码

• 限制上传文件的类型
  在处理上传文件时，判断上传文件的后缀名是不是允许的

• 限制上传文件的大小
  调用解析器的ServletFileUpload.setFileSizeMax(1024*1024*5);就可以限制上传文件的大小，如果上传文件超出限制，则解析器会抛FileUploadBase.FileSizeLimitExceededException异常，程序员通过是否抓到这个异常，进而就可以给用户友好提示。

• 如何判断空的上传输入项

    String filename = item.getName().substring(item.getName().lastIndexOf("\\")+1);  
    if(filename==null || filename.trim().equals("")){
        continue;
    }

• 为避免上传文件的覆盖，程序在保存上传文件时，要为每一个文件生成一个唯一的文件名

    public String generateFileName(String filename){
        //83434-83u483-934934
        return UUID.randomUUID().toString() + "_" + filename;
    }

• 为避免在一个文件夹下面保存超过1000个文件，影响文件访问性能，程序应该把上传文件打散后存储。

    public String generateSavePath(String path,String filename){
        int hashcode = filename.hashCode();  //121221
        int dir1 = hashcode&15;
        int dir2 = (hashcode>>4)&0xf;

        String savepath = path + File.separator + dir1 + File.separator + dir2;
        File file = new File(savepath);
        if(!file.exists()){
            file.mkdirs();
        }
        return savepath;
    }

• 监听上传进度

        ServletFileUpload upload = new ServletFileUpload(factory);
            upload.setProgressListener(new ProgressListener(){
                public void update(long pBytesRead, long pContentLength, int pItems) {
                    System.out.println("当前已解析：" + pBytesRead);
                }
            });