javaweb 文件下载和上传

2023-08-13 08:44:22

1. 项目搭建

新建maven项目：javaweb-file，把里面src目录删掉
新建两个Module：download,upload,都是maven空项目，添加web support
导入所需jar包（手动lib,add as Library或者denpendency）
配置Tomcat

我的环境：Maven 3.8 + tomcat 9

2. 文件传输原理

3. 文件上传

3.1 上传文件调优

为保证服务器安全，上传文件应该放在外界无法直接访问的路径，建议在WEB-INF路径
为防止文件覆盖现象，可以使用UID（唯一识别的通用码),时间戳，保证文件名唯一
限制文件上传最大值
限制上传文件类型，比如这个文件夹只用来存储图片，那你就不能上传一个.mp4的文件

3.2 工具类

ServletFileUpload

作用:在后端获取文件上传的文件数据，并将上传文件数据的表单中的每个输入项都封装为一个FileItem对象

DiskFileItemFactory

使用ServletFileUpload解析前端表单传过来的文件数据时需要使用到

工作流程

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

常用方法

//isFormField方法用于判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单，如果是普通表单字段则返回true，否则返回false
boolean isFormField();//即：只要是上传的文件，返回的就是false

//getFieldName方法用于返回表单标签name属性的值。
String getFieldName();//获取这个input的name属性值

//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();//用字符串存储文件的数据流
    
//getName方法用于获得文件上传字段中的文件名
String getName();

//以流的形式返回上传文件的数据内容。
InputStream getInputStream()

//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容被保存在临时文件中，delete方法将删除该临时文件。
void delete();

3.3 servlet编写

public class FileUploadServlet extends HttpServlet {
private static final long serialVersionUID = 1L;

protected void doPost(HttpServletRequest request, HttpServletResponse response)
        throws ServletException, IOException {
    // TODO Auto-generated method stub
    // response.getWriter().append("Served at: ").append(request.getContextPath());

    // 1. 判断上传的文件普通表单还是带文件的表单
    if (!ServletFileUpload.isMultipartContent(request)) {
        return;//终止方法运行,说明这是一个普通的表单,直接返回
    }
    // 2. 创建上传文件的保存路径,建议在WEB-INF路径下,安全,用户无法直接访间上传的文件;
    String uploadPath =this.getServletContext().getRealPath("/WEB-INF/upload");
    File uploadFile = new File(uploadPath);
    if (!uploadFile.exists()){
        uploadFile.mkdir(); //创建这个月录
    }

    // 3. 创建上传文件的保存路径，建议在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 {
        // 1. 创建DiskFileItemFactory对象，处理文件路径或者大小限制
        DiskFileItemFactory factory = getDiskFileItemFactory(file);
        /*
         * //通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件 factory.setSizeThreshold(1024 *
         * 1024); //缓存区大小为1M factory.setRepository (file);//临时目录的保存目录,需要一个File
         */

        // 2、获取ServletFileUpload
        ServletFileUpload upload = getServletFileUpload(factory);

        // 3、处理上传文件
        // 把前端请求解析，封装成FileItem对象，需要从ServletFileUpload对象中获取
        String msg = uploadParseRequest(upload, request, uploadPath);

        // Servlet请求转发消息
        System.out.println(msg);
        if(msg == "文件上传成功!") {
            // Servlet请求转发消息
            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) {
        // TODO 自动生成的 catch 块
        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 String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath)
        throws FileUploadException, IOException {

    String msg = "";

    // 把前端请求解析，封装成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();

            msg = "文件上传成功!";
            fileItem.delete(); // 上传成功,清除临时文件
            //=============文件传输完成=============
        }
    }
    return msg;
}

}


### 3.4 上传的文件地址
项目发布之后，IDEA会产生一个target（out）文件夹，WEB-INF下
![](https://www.icode9.com/i/l/?n=20&i=blog/2368145/202107/2368145-20210704142119727-1195367724.png)

## 4. 文件下载
>思路
1. 要获取下载文件的路径

2. 下载的文件名是啥？

3. 设置想办法让浏览器能够支持下载我们需要的东西

4. 获取下载文件的输入流

5. 创建缓冲区

6. 获取OutputStream对象

7. 将FileOutputStream流写入到buffer缓冲区

8. 使用OutputStream将缓冲区中的数据输出到客户端！

>Servlet实现
```java
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
    // 1. 要获取下载文件的路径
    String realPath = "E:\javacode\javaweb-file\download\target\classes\ujs.jpg";
    //System.out.println("下载文件的路径："+realPath);
    // 2. 下载的文件名是啥？
    String fileName = realPath.substring(realPath.lastIndexOf("\\") + 1);
    // 3. 设置想办法让浏览器能够支持(Content-Disposition)下载我们需要的东西,中文文件名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. 获取OutputStream对象
    ServletOutputStream out = resp.getOutputStream();
    // 7. 将FileOutputStream流写入到buffer缓冲区,使用OutputStream将缓冲区中的数据输出到客户端！
    while ((len=in.read(buffer))>0){
        out.write(buffer,0,len);
    }

    in.close();
    out.close();
}

5. 源码地址

Javaweb-file

码农公寓