当前位置：首页>笔记分享>Java笔记>JavaWeb>JavaWeb之文件上传与下载

JavaWeb之文件上传与下载

1、文件上传

1.1、准备工作

  1. 对于文件上传，浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
  2. 一般选择采用apache的开源工具common-fileupload这个文件上传组件；
  3. common-fileupload是依赖于common-io这个包的，所以还需要下载这个包

1.2、使用类介绍

  • ServletFileUpload

    负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象（表单输入项）， 在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以，我们需要在进行解析工作前构造好DiskFileItemFactory对象，通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。

  • FileItem

    表单输入项

  • DiskFileItemFactory

    将请求消息实体中的每一个项目封装成单独的DiskFileItem (FileItem接口的实现) 对象的任务
    由 org.apache.commons.fileupload.FileItemFactory 接口的默认实现
    org.apache.commons.fileupload.disk.DiskFileItemFactory 来完成。当上传的文件项目比较小时，直接保存在内存中（速度比较快），比较大时，以临时文件的形式，保存在磁盘临时文件夹（虽然速度慢些，但是内存资源是有限的）。

1.3、文件上传注意事项(上传文件调优方法)

  1. 为保证服务器安全，上传文件应该放在外界无法直接访问的目录下，比如放在WEB-INF目录下。
  2. 为防止文件覆盖的现象发生，要为上传文件产生一个 唯一的文件名。（时间戳+uuid(生成随机且不会重复的数字)、md5、位运算算法）
  3. 要限制上传文件的最大值。（服务器要钱）
  4. 可以限制上传文件的类型 ，在收到上传文件名时，判断后缀名是否合法。
  5. 表单 method 属性应该设置为 POST 方法，不能使用 GET 方法（get限制大小）

1.4、实现流程

思路最重要

  1. 判断用户上传的文件是普通表单还是带文件的表单，如果是普通文件直接返回（return）
  2. 创建文件上传保存的路路径，在WEB-INF路径下是安全的，用户无法直接访问上传文件
  3. 创建临时路径,如果文件好过了预期大小，就把他放到一个临时文件中
  4. 创建DiskFileItemFactory对象，设置文件临时路径（setRepository）或大小的限制（设置一个缓冲区，setSizeThreshold）
  5. 获取ServletFileUpload对象，处理乱码问题（setHeaderEncoding），设置单个文件的最大值（setFileSizeMax），设置总共能够上传文件的大小（setSizeMax），还可选择监听文件上传进度（setProgressListener）
  6. 通过ServletFileUpload对象的parseRequest方法把前端请求解析，封装成一个FileItem对象，判断上传的文件是普通的表单还是带文件的表单（isFormField），getFieldName获取前端表单控件的name
  7. 通过FileItem的getName方法获取文件名字并判断是否为空，可以使用UUID保证文件名唯一
  8. 拼接文件真实存在路径，并给每个文件创建一个对应的文件夹
  9. 通过FileItem的getInputStream方法获取文件上传的流，并创建一个文件输出流将文件写入真实保存路径，最后关闭流
  10. 上传成功可将页面转发到新的提示页面

1.5、完整代码

package com.gong;

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.util.List;
import java.util.UUID;

public class UpLoadServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;//可序列化

    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // 判断上传的文件普通表单还是带文件的表单，判断若是普通软件则直接返回
        if (!ServletFileUpload.isMultipartContent(request)) {
            return;//终止方法运行,说明这是一个普通的表单,直接返回
        }
        //创建上传文件的保存路径,建议在WEB-INF路径下,安全,用户无法直接访间上传的文件;
        String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
        System.out.println("上传路径："+uploadPath);
        File uploadFile = new File(uploadPath);
        if (!uploadFile.exists()) {
            uploadFile.mkdir(); //创建这个月录
        }

        // 创建上传文件的保存路径，建议在WEB-INF路径下，安全，用户无法直接访问上传的文件
        String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
        File file = new File(tmpPath);
        if (!file.exists()) {
            file.mkdir();//创建临时目录
        }
        // 处理上传的文件,一般都需要通过流来获取,我们可以使用 request, getInputstream(),原生态的文件上传流获取,十分麻烦
        // 但是我们都建议使用 Apache的文件上传组件来实现, common-fileupload,它需要依赖commons-io组件;
        try {
            // 创建DiskFileItemFactory对象，处理文件路径或者大小限制
            DiskFileItemFactory factory = getDiskFileItemFactory(file);
            /*
             * //通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件 factory.setSizeThreshold(1024 *
             * 1024); //缓存区大小为1M factory.setRepository (file);//临时目录的保存目录,需要一个File
             */
            // 2、获取ServletFileUpload
            ServletFileUpload upload = getServletFileUpload(factory);
            // 3、处理上传文件
            // 把前端请求解析，封装成FileItem对象，需要从ServletFileUpload对象中获取
            boolean fileFlag = uploadParseRequest(upload, request, uploadPath);
            // Servlet请求转发消息
            String msg = "";
            System.out.println("msg状态："+fileFlag);
            if (fileFlag) {
                // Servlet请求转发消息
                msg = "上传成功";
                request.setAttribute("msg", msg);
                request.getRequestDispatcher("info.jsp").forward(request, response);
            } else {
                msg = "请上传文件";
                request.setAttribute("msg", msg);
                request.getRequestDispatcher("info.jsp").forward(request, response);
            }
        } catch (FileUploadException e) {
            e.printStackTrace();
        }
    }

    public static DiskFileItemFactory getDiskFileItemFactory(File file) {
        DiskFileItemFactory factory = new DiskFileItemFactory();
        // 通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中;
        factory.setSizeThreshold(1024 * 1024);// 缓冲区大小为1M
        factory.setRepository(file);// 临时目录的保存目录,需要一个file
        return factory;
    }

    public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
        ServletFileUpload upload = new ServletFileUpload(factory);
        // 监听长传进度
        upload.setProgressListener(new ProgressListener() {
            // pBYtesRead:已读取到的文件大小
            // pContextLength:文件大小
            public void update(long pBytesRead, long pContentLength, int pItems) {
                System.out.println("总大小：" + pContentLength + "已上传：" + pBytesRead);
            }
        });
        // 处理乱码问题
        upload.setHeaderEncoding("UTF-8");
        // 设置单个文件的最大值
        upload.setFileSizeMax(1024 * 1024 * 10);
        // 设置总共能够上传文件的大小
        // 1024 = 1kb * 1024 = 1M * 10 = 10м
        return upload;
    }

    public static boolean uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath)
            throws FileUploadException, IOException {
        boolean flag = false;
        // 把前端请求解析，封装成FileItem对象（每）
        List<FileItem> fileItems = upload.parseRequest(request);
        for (FileItem fileItem : fileItems) {
            if (fileItem.isFormField()) {// 判断上传的文件是普通的表单还是带文件的表单
                //非带文件表单
                // getFieldName指的是前端表单控件的name;
                String name = fileItem.getFieldName();
                String value = fileItem.getString("UTF-8"); // 处理乱码
                System.out.println("非文件："+name + ": " + value);
            } else {//判断它是上传的文件
                // ============处理文件==============
                // 拿到文件名
                String uploadFileName = fileItem.getName();
                System.out.println("上传的文件名: " + uploadFileName);
                if (uploadFileName.trim().equals("") || uploadFileName == null) {
                    continue;
                }
                // 获得上传的文件名/images/girl/paojie.png
                String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                // 获得文件的后缀名
                String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
                /*
                 * 如果文件后缀名fileExtName不是我们所需要的 就直按return.不处理,告诉用户文件类型不对。
                 */
                System.out.println("文件信息->[文件名: " + fileName + " ---文件类型：" + fileExtName + "]");
                // 可以使用UID（唯一识别的通用码),保证文件名唯
                // 0UID. randomUUID(),随机生一个唯一识别的通用码;
                String uuidPath = UUID.randomUUID().toString();
                // ================处理文件完毕==============
                // 存到哪? uploadPath
                // 文件真实存在的路径realPath
                String realPath = uploadPath + "/" + uuidPath;
                // 给每个文件创建一个对应的文件夹
                File realPathFile = new File(realPath);
                if (!realPathFile.exists()) {
                    realPathFile.mkdir();
                }
                // ==============存放地址完毕==============
                // 获得文件上传的流
                InputStream inputStream = fileItem.getInputStream();
                // 创建一个文件输出流
                // realPath =真实的文件夹;
                // 差了一个文件;存放路径+"/"+uuidFileName
                FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
                // 创建一个缓冲区
                byte[] buffer = new byte[1024 * 1024];
                // 判断是否读取完毕
                int len = 0;
                // 如果大于0说明还存在数据;
                while ((len = inputStream.read(buffer)) > 0) {
                    fos.write(buffer, 0, len);
                }
                // 关闭流
                fos.close();
                inputStream.close();
                flag = true;
                fileItem.delete(); // 上传成功,清除临时文件
                //=============文件传输完成=============
            }
        }
        return flag;
    }
}

2、文件下载

2.1、下载文件思路

  1. 要获取下载文件的路径
  2. 下载的文件名是啥？
  3. 想办法设置让浏览器能够支持下载我们的东西
  4. 获取下载文件的输入流
  5. 创建缓冲区
  6. 获取OutoutStream对象
  7. 将FileOutputStream流写入到缓冲区
  8. 使用OutputStream将缓冲区中的数据输出到客户端

2.2、完整代码

@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    // 1. 要获取下载文件的路径
    String realPath = "E:\\JAVA_code\\JavaWeb\\javaweb-02-servlet\\response\\target\\classes\\天赐.png";
    System.out.println("下载文件的路径：" + realPath);
    // 2. 下载的文件名是啥？
    String fileName = realPath.substring(realPath.lastIndexOf("\\") + 1);
    // 3. 想办法设置让浏览器能够支持下载我们的东西，中文文件名URLEncoder.encode编码，否则有可能乱码
    resp.setHeader("Content-Disposition","attachment; filename=" + URLEncoder.encode(fileName, "UTF-8"));
    // 4. 获取下载文件的输入流
    FileInputStream in = new FileInputStream(realPath);
    // 5. 创建缓冲区
    int len = 0;
    byte[] buffer = new byte[1024];
    // 6. 获取OutoutStream对象
    ServletOutputStream out = resp.getOutputStream();
    // 7. 将FileOutputStream流写入到缓冲区, 使用OutputStream将缓 冲区中的数据输出到客户端
    while ((len = in.read(buffer)) > 0) {
        out.write(buffer, 0, len);
    }
    in.close();
    out.close();
}

3、总结

  • 字符串处理路径和文件名
  • UUID可以进行唯一标识
  • 文件上传的流程，网络思想
  • 文件下载：
    • 设置浏览器以下载的方式打开文件
    • 输入流读取文件，输出流输出到浏览器——响应对象完成

给TA打赏
共{{data.count}}人
人已打赏
JavaJavaWebJava笔记文件上传文件下载
JavaWebJava笔记

JavaWeb

2021-12-28 17:55:45

JavaWebJava笔记

JavaWeb之邮件发送

2021-12-29 18:05:08

0 条回复 A文章作者 M管理员
    暂无讨论，说说你的看法吧
❯
购物车
优惠劵
有新私信 私信列表
搜索
客服

  • 扫码打开当前页

返回顶部