文件上传和下载

文件上传和下载

在Web应用中,文件上传和下载功能是非常常用的功能,今天学习了JavaWeb中的文件上传和下载功能的实现。

1、准备工作

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

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

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

下载两个jar包

在JavaWeb项目中导入jar包

注意:使用IDEA导包需要注意修复路径,将lib添加到项目输出目录。

2、使用类介绍

文件上传的注意事项

  1. 为保证服务器安全,上传文件应该放在外界无法直接访问的目录下,比如放于WEB-INF目录下。
  2. 为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名。(时间戳、uuid)
  3. 要限制上传文件的最大值。
  4. 可以限制上传文件的类型,在收到上传文件名时,判断后缀名是否合法。

需要用到的类详解

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

FileItem类

在HTML页面input必须有<input type="file" name="filename">

表单如果包含一个文件上传输入项的话,这个表单的enctype属性就必须设置为multipart/form-data

<%--通过表单上传文件
     get:上传文件大小有限制
     post:上传文件大小没有限制
--%>
<form action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data" method="post">
  <p>上传用户:<input type="text" name="username"></p>
  <p>上传文件1:<input type="file" name="file1"></p>
  <p>上传文件2:<input type="file" name="file2"></p>
  <p><input type="submit" value="提交"> | <input type="reset"></p>
</form>

浏览器表单的类型如果为multipart/form-data,在服务器端想获取数据就要通过流。

常用方法介绍

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

//getFieldName方法用于返回表单标签name属性的值
String getFieldName();

//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();

//getName方法用于获得文件上传字段中的文件名
String getName();

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

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

ServletFileUpload类

ServletFileUpload类负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象,使用其parseRequest(HttpServletRequest)方法可以将表单中每一个通过HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回。使用该方法处理上传文件简单易用。

实现文件传输的Servlet

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

public class FileServlet extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        String msg = null;

        //判断上传的表单是普通表单还是带文件的表单
        if (!ServletFileUpload.isMultipartContent(req)) {
            return;//方法终止运行,说明这是一个普通表单,直接返回
        }
        //如果通过了if,说明我们的表单是带文件上传的

        //创建上传文件的保存路径,建议在WEB-INF路径下,安全,用户无法通过url直接访问
        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的文件上传组件来实现,commons-fileupload,它需要依赖于commons-io组件;

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

        //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:已经读取到的文件大小
            //pContentLength:文件大小
            public void update(long pBytesRead, long pContentLength, int pItems) {
                System.out.println("总大小:" + pContentLength + ",已上传:" + pBytesRead);
            }
        });

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

        //3、处理上传文件

        //把前端请求解析,封装成一个FileItem对象
        List<FileItem> fileItems = null;
        try {
            fileItems = upload.parseRequest(req);
        } catch (FileUploadException e) {
            e.printStackTrace();
        }
        //fileItem代表每一个表单对象
        assert fileItems != null;
        for (FileItem fileItem : fileItems) {
            //判断该表单项是普通的表单项还是上传文件的表单项
            if (fileItem.isFormField()) {//是普通表单
                String name = fileItem.getFieldName();//获得前端表单控件的name
                String value = fileItem.getString("UTF-8");//获得前端表单控件的value
                System.out.println(name + " : " + value);
            } else {//是上传文件的表单
                //=============================处理文件==============================
                String uploadFileName = fileItem.getName();//获取文件名字
                System.out.println("上传的文件名:" + uploadFileName);
                //可能存在文件名不合法的情况
                if (uploadFileName.trim().equals("")) {
                    continue;
                }
                //获得上传的文件名 /images/girl/mylove.png
                String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                //获得文件的后缀名
                String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
                System.out.println("fileName:" + fileName + ";fileExtName:" + fileExtName);
                //如果文件后缀名不是我们所允许的,可以直接return,不处理,并告诉用户文件类型不符
                //可以使用UUID(唯一识别的通用码)保证文件名唯一
                //UUID.randomUUID(),随机生成一个唯一识别的通用码
                String uuidPath = UUID.randomUUID().toString();

                //=============================存放地址==============================
                //存到哪? uploadPath目录下
                //realPath,在uploadPath目录下加上一层经UUID获得的名称唯一的目录
                String realPath = uploadPath + "/" + uuidPath;
                //创建该文件夹
                File realPathFile = new File(realPath);
                if (!realPathFile.exists()) {
                    realPathFile.mkdir();
                }

                //=============================文件传输==============================
                //“获得”文件上传的流
                InputStream inputStream = fileItem.getInputStream();
                //“创建”文件输出的流
                FileOutputStream fos = new FileOutputStream(realPath + fileName);
                //创建一个缓冲区
                byte[] buffer = new byte[1024*1024];
                //判断是否读取完毕,如果大于0说明还存在数据
                int len = 0;
                while ((len = inputStream.read(buffer)) > 0) {
                    fos.write(buffer,0,len);
                }
                //关闭流
                fos.close();
                inputStream.close();

                msg = "文件上传成功";
                //上传成功,清除fileItem
                fileItem.delete();
            }

        }

        req.setAttribute("msg",msg);
        req.getRequestDispatcher("info.jsp").forward(req,resp);
    }
}

xml文件

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
         version="4.0">
    
    <servlet>
        <servlet-name>FileServlet</servlet-name>
        <servlet-class>com.zhc.servlet.FileServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>FileServlet</servlet-name>
        <url-pattern>/upload.do</url-pattern>
    </servlet-mapping>
</web-app>

b站遇见狂神说课堂笔记,侵删。

原文地址:https://www.cnblogs.com/mryx/p/14502630.html