文件上传 - Commons FileUpload介绍

一、概述

FileUpload能够以多种不同的方式使用，具体取决于应用程序的要求。在最简单的情况下，调用单个方法来解析servlet请求，然后处理解析出来的Item集合。此外也可以自定义FileUpload已完全控制各个Item的存储方式，比如设置缓存目录、直接将接收到的Item以流的形式写入数据库等。

FileUpload依赖于Commons IO，因此类路径下要有Commons IO的jar包。当然采用Maven依赖的方式不用担心，maven会自动下载Commons IO包。

二、FIleUpload使用

上传文件，注意几个问题：

① form表单内，要添加空间<input type="file" name="myfile">
 ② form表单的内容格式要定义成multipart/form-data格式：<form action="admin/good_add" method="post" enctype="multipart/form-data">
 ③ 需要类库：1 commons-io.jar ，2 commons-fileupload-1.3.1.jar

接下来我们看下他的用法。

1）创建工厂类

DiskFileItemFactory factory = new DiskFileItemFactory();

FileItemFactory可以设置内容：

 ● setRepository(File dir)；//设置临时文件存储位置。

 ● setSizeThreshold(long bytes)；//设置请求大小阈值，当请求大于该值时，接收到的数据是缓存在磁盘中的，否则直接缓存到内存中。

 ● setFileCleaningTracker(FileCleaningTracker pTracker)；//设置临时文件清理跟踪器

2）创建核心类-文件解析对象

ServletFileUpload upload = new ServletFileUpload(DiskFileItemFactory factory);

ServletFileUpload可以设置内容：

 ● setSizeMax(long bytes)；//设置整个请求的最大值，大于该值时，不允许传送。

 ● setFileMaxSize(long bytes)；//设置单个文件的最大值，大于该值时，不允许传送。

 ● setHeaderEncoding(String charset)；//设置读取每个FileItem的头数据的字符编码，不设置时采用request编码，也没有时采用系统默认编码。

 ● serProgressListener(ProgressListener pListener)；//设置上传进度监听器

3）解析request请求-进行文件解析后放在List中，因为这个类库支持多个文件上传，因此把结果会存在List中。

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

FileItem能够获取的内容：

 ● getContentType()；//获取单个Item的ContentType

 ● getName()；//获取Item本来的文件名，如果不是文件则为null

 ● getFieldName()；//获取Item的field名

 ● getSize()；//获取Item的大小

 ● get()；//将Item转换成字节数组返回

 ● isInMemory()；//Item目前是否存在内存中

 ● isFormField()；//是否是表单域

 ● getInputStream()；//获取输入流，用于读取Item

二、上传原理和代码分析

上传：将需要上传的资源，发送给服务器，在服务器中保存下来。

下载：下载资源时，将服务器上的某个资源发送给浏览器。

 

1）浏览器端

注意：enctype=multipart/form-data：该属性表明发送的请求体的内容是多表单元素的，通俗点讲，就是有各种各样的数据，可能有二进制数据，也可能有表单数据，等等。

<form class="form-horizontal" action="${pageContext.request.contextPath }/admin/good_add" method="post" enctype="multipart/form-data">
    <div class="form-group">
        <label for="input_name" class="col-sm-1 control-label">名称</label>
        <div class="col-sm-6">
            <input type="text" class="form-control" id="input_name" name="name" required="required">
        </div>
    </div>
    <div class="form-group">
        <label for="input_name" class="col-sm-1 control-label">价格</label>
        <div class="col-sm-6">
            <input type="text" class="form-control" id="input_name" name="price">
        </div>
    </div>
    <div class="form-group">
        <label for="input_name" class="col-sm-1 control-label">介绍</label>
        <div class="col-sm-6">
            <input type="text" class="form-control" id="input_name" name="intro">
        </div>
    </div>
    <div class="form-group">
        <label for="input_name" class="col-sm-1 control-label">库存</label>
        <div class="col-sm-6">
            <input type="text" class="form-control" id="input_name" name="stock">
        </div>
    </div>
    <div class="form-group">
        <label for="input_file" class="col-sm-1 control-label">封面图片</label>
        <div class="col-sm-6">
            <input type="file" name="cover" id="input_file" required="required">推荐尺寸: 500 * 500
        </div>
    </div>
    <div class="form-group">
        <label for="input_file" class="col-sm-1 control-label">详情图片1</label>
        <div class="col-sm-6">
            <input type="file" name="image1" id="input_file" required="required">推荐尺寸: 500 * 500
        </div>
    </div>
    <div class="form-group">
        <label for="input_file" class="col-sm-1 control-label">详情图片2</label>
        <div class="col-sm-6">
            <input type="file" name="image2" id="input_file" required="required">推荐尺寸: 500 * 500
        </div>
    </div>
    <div class="form-group">
        <label for="select_topic" class="col-sm-1 control-label">类目</label>
        <div class="col-sm-6">
            <select class="form-control" id="select_topic" name="good.type.id">
                <c:forEach items="${typeList }" var="t">
                    <option value="${t.id }">${t.name }</option>
                </c:forEach>
            </select>
        </div>
    </div>
    <div class="form-group">
        <div class="col-sm-offset-1 col-sm-10">
            <button type="submit" class="btn btn-success">提交保存</button>
        </div>
    </div>
</form>

使用multipart/form-data会有一个boundary属性，来用将提交的表单数据进行分隔，以用来让服务器知道哪个是我们上传的资源，哪个是普通的表单数据。

<form action="adctionServlet" method="post" enctype="enctype=multipart/form-data">
    描述：<input type="text" name=""/><br/>
    图片：<input type="file" name="image"/><br/>
    <input type="submit" value="上传"/>
</form>

2）服务器端

使用commons-fileupload进行处理上传内容。

try {
    DiskFileItemFactory factory = new DiskFileItemFactory();
    ServletFileUpload upload = new ServletFileUpload(factory);

    List<FileItem> list = upload.parseRequest(request);
    Goods goods = new Goods();
    for (FileItem item : list) {

        // 判断itme;true-为普通输入项,false-为文件
        if (item.isFormField()) {

            // 设置商品属性
            switch (item.getFieldName()) {
            case "name":
                goods.setName(item.getString("utf-8"));
                break;
            case "price":
                goods.setPrice(Float.parseFloat(item.getString("utf-8")));
                break;
            case "intro":
                goods.setIntro(item.getString("utf-8"));
                break;
            case "stock":
                goods.setStock(Integer.parseInt(item.getString("utf-8")));
                break;
            case "good.type.id":
                goods.setTypeid(Integer.parseInt(item.getString("utf-8")));
                break;
            }
        } else {

            if (item.getInputStream().available() <= 0) {
                continue;
            }
            // 1-获取文件名；2-获取后缀名；3-根据毫秒值设置新的文件名；4-创建保存路径
            String fileName = item.getName();
            fileName = fileName.substring(fileName.indexOf("."));
            fileName = "/" + System.currentTimeMillis() + fileName;
            String path = this.getServletContext().getRealPath("/picture") + fileName;

            // 读取上传
            InputStream in = item.getInputStream();
            FileOutputStream out = new FileOutputStream(path);
            byte[] buff = new byte[1024];
            int len = 0;
            while ((len = in.read(buff)) > 0) {
                out.write(buff, 0, len);
            }
            in.close();
            out.close();

            // 设置商品属性
            switch (item.getFieldName()) {
            case "cover":
                goods.setCover("/picture" + fileName);
                break;
            case "image1":
                goods.setImage1("/picture" + fileName);
                break;
            case "image2":
                goods.setImage2("/picture" + fileName);
                break;
            }
        }
        item.delete();
    }
} catch (FileUploadException e) {
    e.printStackTrace();
}    

上传的各种问题：

1，上传文件名乱码问题：使用servletFileUpload.setHeaderEncoding("UTF-8")；或者request.setCharacterEncoding("UTF-8")都可以。

2，表单内容乱码问题：使用getString("utf-8")即可，也就是在获取内容时，就可以设置码表。

3，上传文件同名问题：使用UUID.randomUUID().toString().replace("-", "").获得一个独一无二的32位数字。

4，使用FileUtils.copyInputStreamToFile(is, file);来将内容输出到指定路径文件中去，mkdirs() 自动创建目录

public void doGet(HttpServletRequest request, HttpServletResponse response)
        throws ServletException, IOException {
    try {
        
        //0.5 检查是否支持文件上传  ,检查请求头Content-Type : multipart/form-data 
        if(!ServletFileUpload.isMultipartContent(request)){
            throw new RuntimeException("不要得瑟，没用");
        }
        
        //1 工厂
        DiskFileItemFactory fileItemFactory = new DiskFileItemFactory();
        // 1.1 设置是否生产临时文件临界值。大于2M生产临时文件。保证：上传数据完整性。
        fileItemFactory.setSizeThreshold(1024 * 1024 * 2);  //2MB
        // 1.2 设置临时文件存放位置
        // * 临时文件扩展名  *.tmp  ，临时文件可以任意删除。
        String tempDir = this.getServletContext().getRealPath("/temp");
        fileItemFactory.setRepository(new File(tempDir));
        
        //2 核心类
        ServletFileUpload servletFileUpload = new ServletFileUpload(fileItemFactory);
        // 2.1 如果使用无参构造  ServletFileUpload() ，手动设置工厂
        //servletFileUpload.setFileItemFactory(fileItemFactory);
        // 2.2 单个上传文件大小
        //servletFileUpload.setFileSizeMax(1024*1024 * 2);  //2M
        // 2.3 整个上传文件总大小
        //servletFileUpload.setSizeMax(1024*1024*10);        //10M
        // 2.4 设置上传文件名的乱码
        // * 首先使用  setHeaderEncoding 设置编码
        // * 如果没有设置将使用请求编码 request.setCharacterEncoding("UTF-8")
        // * 以上都没有设置，将使用平台默认编码
        servletFileUpload.setHeaderEncoding("UTF-8");
        // 2.5 上传文件进度，提供监听器进行监听。
        servletFileUpload.setProgressListener(new MyProgressListener());
        
        
        //3 解析request  ,List存放 FileItem （表单元素的封装对象，一个<input>对应一个对象）
        List<FileItem> list = servletFileUpload.parseRequest(request);
        
        //4 遍历集合获得数据
        for (FileItem fileItem : list) {
            // 判断
            if(fileItem.isFormField()){
                // 5 是否为表单字段（普通表单元素）
                //5.1.表单字段名称
                String fieldName = fileItem.getFieldName();
                System.out.println(fieldName);
                //5.2.表单字段值 ， 解决普通表单内容的乱码
                String fieldValue = fileItem.getString("UTF-8");
                System.out.println(fieldValue);
            } else {
                //6 上传字段（上传表单元素）
                //6.1.表单字段名称  fileItem.getFieldName();
                //6.2.上传文件名
                String fileName = fileItem.getName();
                // * 兼容浏览器， IE ： C:\Users\liangtong\Desktop\abc.txt  ; 其他浏览器 ： abc.txt
                fileName = fileName.substring(fileName.lastIndexOf("\\") + 1);
                // * 文件重名
                fileName = UUID.randomUUID().toString().replace("-", "") + fileName;
                // * 单个文件夹文件个数过多？
                String subDir = StringUtils.getDir(fileName);
                
                System.out.println(fileName);
                //6.3.上传内容
                InputStream is = fileItem.getInputStream();
                String parentDir = this.getServletContext().getRealPath("/WEB-INF/upload");
                File file = new File(parentDir + subDir,fileName);

                // 将指定流 写入 到 指定文件中  -- mkdirs() 自动创建目录
                FileUtils.copyInputStreamToFile(is, file);
                
                //7删除临时文件
                fileItem.delete();
            }
        }
        
    } catch (Exception e) {
        e.printStackTrace();
        
        throw new RuntimeException(e);
        
    }
}

总结上传：

其实理解了也不是很难，就是上传文件后的处理比较麻烦，各种小问题，存储过程最为麻烦。

1、创建工厂类

2、使用核心类，

3、解析request请求，

4、遍历请求体的内容，将上传内容和普通表单内容都获取出来

5、获取到上传内容时，对其存储位置进行设置

 

@部分转载自：https://www.cnblogs.com/whgk/p/6479405.html