2021-04-23

JavaWeb实现文件的上传【向西部开源秦疆老师学习的笔记】

1、准备工作

对于文件上传，浏览器在上传的过程中是将文件以流的形式提交到服务器端的。

一般采用Apache的开源工具common-fileupload这个文件上传组件。

common-fileupload是依赖于common-io这个包的，所以还需要下载这个包。

我们下载最新的jar包:

maven库

在JavaWeb项目中导入Jar包

2、使用类介绍

【文件上传注意事项】

1、为保证服务器的安全，上传的文件应放在外界无法访问的目录下，如WEN-INF。

2、为防止同名文件产生覆盖现象，要为文件指定一个唯一的文件名。

3、要对上传文件的大小进行限制。

4、限制上传文件的类型，收到文件时，判断文件名十分合法。

 

【需要用到的类详解】

ServletFileUpload类

ServletFileUpload类：负责处理上传的文件数据，并将表单中的每个输入项封装成一个FileItem对象

方法：isMultipartContent(req) 判断上传的表单是（false）普通表单还是（true）带文件的表单

方法：parseRequest(req) 将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象，然后以List列表的形式返回。使用该方法处理上传文件简单易用。

方法：setProgressListener() 监听文件上传进度

upload.setProgressListener(new ProgressListener() {
    @Override
    //pBytesRead:已读取到的文件大小，pContentLenght：文件大小
    public void update(long pBytesRead, long lpContentLenght, int i) {
        System.out.println("总大小："+lpContentLenght+"已上传："+pBytesRead);
    }
});

其他可选用方法：

//处理乱码问题
upload.setHeaderEncoding("UTF-8");
//设置单个文件的最大值
upload.setFileSizeMax(1024 * 1024 * 10);
//设置总共能够上传文件的大小
//1024 = 1kb * 1024 = 1M * 10 = 10M
upload.setSizeMax(1024 * 1024 * 10);

DiskFileItemFactory类

DiskFileItemFactory类：用于ServletFileUpload对象解析请求

具体用法：

1，处理文件上传路径或限制文件大小，通过这个工厂设置一个缓冲区，当上传的文件大小超过这个缓冲区，放入临时文件

factory.setSizeThreshold(1024*1024);//缓存区大小1M
factory.setRepository(tmpFile);//临时文件的保存目录

ServletFileItem类

ServletFileItem类：用该类的构造方法或者setFileItemFactory()方法为 ServletFileUpload实例化对象设置fileItemFactory属性（工厂模式）

FileItem类

常用方法介绍

//isFormFile方法用于判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单，如果时普通表单字段则返回true，否则返回false
boolean isFormField()
​
//getFieldName方法用于返回表单标签name属性的值
String getFieldName();
​
//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
//可用来设置返回的编码格式以处理乱码问题，getString("UTF-8");
String getString();
​
//getName方法用于获得文件上传字段中的文件的名。
String getName();
​
//以流的形式返回上传文件的数据内容。
InputStream getInputStream();
​
//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容被保存在临时文件中，delete方法将删除该临时文件
void delete();

【注意事项】

在HTML页面中，input必须要有name，这样传输时才能准确提取对应数据，即：<input type="file" name = "filename">

entype属性：表单中如果包含一个文件上传项的话，必须添加并设置为multipart/form-data

浏览器的表单类型为multipart/form-data的话，服务器想获取数据就要通过流

2、编写Servlet类，没用maven只能手动导包了【注：此代码为未封装版！！】

package com.wu.servlet;

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

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.text.NumberFormat;
import java.util.List;
import java.util.UUID;

public class FileServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //判断上传的表单是普通表单还是带文件的表单
        if(!ServletFileUpload.isMultipartContent(req)){
            return;//运行到此，说明只是一个普通的表单，直接返回
        }
        //通过了if，说明我们的表单是带文件上传的
        // 创建上传文件的保存目录，为了安全建议在WEB-INF目录下，用户无法访问
        String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");//得到保存路径
        File uploadFile = new File(uploadPath);//文件类
        //文件不存在则创建一个
        if (!uploadFile.exists()){
            uploadFile.mkdir();//创建这个目录
        }

        //临时文件
        // 临时路径，如果上传的文件超过预期的大小，我们将它存放到一个临时目录中，过几天自动删除，或者提醒用户转存为永久
        String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
        File tmpFile = new File(tmpPath);
        //文件不存在则创建一个
        if (!tmpFile.exists()){
            tmpFile.mkdir();//如果目录不存在就创建这样临时目录
        }

        //处理上传的文件一般需要通过流来获取,我们可以通过request.getInputstream()原生态文件上传流获取，十分麻烦
        //但是我们都建议使用Apache的文件上传组件来实现，common-fileupload,它需要依赖于common-io组件



// 1、创建DiskFileItemFactory对象，处理文件上传路径或限制文件大小
        DiskFileItemFactory factory = new DiskFileItemFactory();

        //通过这个工厂设置一个缓冲区，当上传的文件大小超过这个缓冲区，放入临时文件
        factory.setSizeThreshold(1024*1024);//缓存区大小1M
        factory.setRepository(tmpFile);//临时文件的保存目录



//2，获取ServletFileUpload文件上传对象
        ServletFileUpload upload = new ServletFileUpload(factory);

        //监听文件上传进度
        upload.setProgressListener(new ProgressListener() {
            @Override
            //pBytesRead:已读取到的文件大小，pContentLenght：文件大小
            public void update(long pBytesRead, long lpContentLenght, int i) {
                // 创建一个数值格式化对象
                NumberFormat numberFormat = NumberFormat.getInstance();
                // 设置精确到小数点后2位
                numberFormat.setMaximumFractionDigits(2);
                String result = numberFormat.format((float)pBytesRead/(float)lpContentLenght*100);
                System.out.println("总大小："+lpContentLenght+"已上传："+result+"%");
            }
        });
        //处理乱码问题
        upload.setHeaderEncoding("UTF-8");
        //设置单个文件的最大值
        upload.setFileSizeMax(1024 * 1024 * 10);
        //设置总共能够上传文件的大小（工厂大小）
        //1024 = 1kb * 1024 = 1M * 10 = 10M
        upload.setSizeMax(1024 * 1024 * 10);



//3、处理上传文件
        String msg = "";//一个表示成功与否的字符串

        try {
            // 把前端的请求解析，封装成一个FileItem对象，以List列表的形式返回，需要从ServletFileUpload文件上传对象中获取
            List<FileItem> fileItems = upload.parseRequest(req);

            System.out.println("表单共存有数据：" + fileItems.size());//调试内容，看看是否接收到前端表单值
            int l = 0,k = 0;//看看循环了几次

            //遍历列表挨个处理
            for (FileItem fileItem : fileItems) {
                //遍历判断每一个上传的表单是普通表单还是带文件的表单
                if (fileItem.isFormField()) {
                    //true则是普通表单，不带文件随便传传就行
                    String name = fileItem.getFieldName();//getFieldName指的是前端表单控件的name
                    String value = fileItem.getString("UTF-8");//防止乱码
                    
                    l++;
                    System.out.println("上传了" + l + "个普通表单！！！");
                    System.out.println(name + ":" + value);
                } else {
                    //进入这里说明表单带文件
                    k++;
                    System.out.println("上传了" + k + "个文件表单!!!!");

        //第一步，将文件处理一下
                    String uploadFileName = fileItem.getName();//得到文件名字,真名字，不是name属性值
                    System.out.println("这里拿到的文件名字是："+uploadFileName);

                        //若文件名不合规(文件名空或者空格)
                    if (uploadFileName.trim().equals("") || uploadFileName == null) {
                        System.out.println("此文件名不规范！不规范的文件名为：" + uploadFileName);
                        continue;
                    }
                        //获得文件上传的名字，例如/img/girl/ooa.jpg,只需要ooa，取最后一个/的后面的字符串
                    String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                        //获取文件的后缀名，拿到文件类型
                    String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
                        /* 如果后缀名 fileExtName 不是我们需要的 就直接return，不处理，告诉用户类型不对 */
                    System.out.println("上传的文件信息为：【 文件名：" + fileName + "," + "文件类型：" + fileExtName + "】");
                        //可以使用UUID(唯一通用识别码)来保证文件名的统一
                        /*网络传输的东西，都需要序列化
                         * POJO的实体类，如果想要在多个电脑上运行 需要传输
                         * 此时就需要把所有对象序列化
                         * 养成习惯：写pojo实习类时，多加个implements Serializable，即标记接口*/
                    String uuidFileName = UUID.randomUUID().toString();

        //第二步，存放在对应地址（永久或临时）,存哪？？？？
                        //文件加上唯一标识后最后存在的路径，之前拟定的保存路径+识别码
                    String realPath = uploadPath + "/" + uuidFileName;
                        //将该路径转化为文件夹
                    File realPathFile = new File(realPath);
                        //文件夹不存在？建一个
                    if (!realPathFile.exists()) {
                        realPathFile.mkdir();
                    }

        //第三步，输出文件（IO流操作，将文件上传存到拟定的文件夹里面）
                        //获得文件上传的流
                    InputStream inputStream = fileItem.getInputStream();
                        //创建一个文件输出流 输出到什么地方呢？文件的真实文件夹/文件名
                    FileOutputStream fos = new FileOutputStream(realPath + "/" + uploadFileName);
                        //创建一个缓冲区 判断是否读取完毕
                    byte[] buffer = new byte[1024 * 1024];
                    int len = 0;
                        //将inputStream流写入到buffer缓冲区 如果len大于0，说明还存在数据
                    while ((len = inputStream.read(buffer)) > 0) {
                        //使用OutputStream将缓冲区中的数据输入到客户端
                        fos.write(buffer, 0, len);
                    }
                    //关闭流，先开后关
                    fos.close();
                    inputStream.close();
                    msg= "文件上传成功！";
                    fileItem.delete();//上传成功，清除临时文件
                    System.out.println("一个文件表单处理完毕！！"+"此时的msg="+msg);
                }
            }
        } catch (FileUploadException e) {
            e.printStackTrace();
        }
        //转发显示是否成功
        req.setAttribute("msg",msg);
        req.getRequestDispatcher("/info.jsp").forward(req,resp);
    }
}