javaWeb-文件上传

_koen

已于 2022-10-19 11:32:42 修改

阅读量125

点赞数 1

分类专栏： JavaEE 文章标签：服务器 java servlet

于 2022-10-18 20:13:36 首次发布

本文链接：https://blog.csdn.net/weixin_46525129/article/details/127394881

版权

JavaEE 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

javaWeb-文件上传

文件上传

文件上传

1、准备工作

对于文件上传，浏览器在上传的过程中就是将文件以流的形式提交到服务器端的。
一般采用apache的开源工具commons-fileupload这个文件上传组件。
需要下载两个依赖包jar

commons-fileupload-1.4.jar
commons-io-2.6.jar

1、文件上传注意事项：

为保证服务器安全，上传文件应该放在外界无法直接访问的目录下，比如放于WEB-INF下（外界无法访问）
为防止文件覆盖的现象发生，要为上传文件产生一个唯一的文件名（1.txt、1.txt-时间戳、-uuid、-md5、-位运算算法…）
要限制上传文件的最大值。（服务器都要钱，上传文件不会让于过大，有一个限制）
可以限制上传文件的类型，在收到上传文件名时，判断后缀名是否合法。（.mp4 .txt、.doc … 、.jpg、.png、.bmp …）

2、需要用到的类详解

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

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

【FileItem类】
在html中必须要有 <input type="file" name="file1">

【常用方法介绍】

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

   // getFieldName方法用于返回表单标签name属相的值
   String getFieldName();
   // getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
   String getString();

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

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

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

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

<%--
    通过表单上传文件
    get：上传文件大小有限制
    post：上传文件大小没有限制
    ${pageContext.request.contextPath}：取出部署的应用程序名   （项目名）
--%>
<form method="post" action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data">
    提交者：<input type="text" name="username"><br>
    <input type="file" name="file1"><br>
    <input type="file" name="file2"><br>
    <input type="submit">
    <input type="reset">
</form>

3、代码编写

UploadFileServlet

package com.k2.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.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.*;
import java.util.List;
import java.util.UUID;

@WebServlet("/upload.do")
public class UploadFile extends HttpServlet {

    @Override
    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");
        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();// 创建这个目录
        }

        // 处理上传的文件，一般都需要通过流来获取，我们可以使用req.getInputStream()，原生态的文件上传流获取，十分麻烦
        // 我们建议使用Apache的文件上传组件来实现，commons-fileupload，它需要依赖commons-io组件；
        try {
            // 1、创建DiskFileItemFactory对象，处理文件上传路径或者大小限制的；
            DiskFileItemFactory factory = getDiskFileItemFactory(tmpFile);
            // 2、获取ServletFileUpload
            ServletFileUpload upload = getServletFileUpload(factory);
            // 3、处理上传的文件
            String msg = uploadParseRequest(upload, request, uploadPath);
            request.setAttribute("msg", msg);
            request.getRequestDispatcher("/info.jsp").forward(request, response);

        } catch (FileUploadException e) {
            e.printStackTrace();
        }
    }

1、创建DiskFileItemFactory对象，处理文件上传路径或者大小限制的；

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

2、获取ServletFileUpload

    public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
        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);
        // 设置总共能够上传的大小10M
        upload.setSizeMax(1024 * 1024 * 10);
        return upload;
    }

3、处理上传的文件

    public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath)
            throws FileUploadException, IOException {
        String msg = "";
        // 3、把前端请求解析，封装成一个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;
                }

                // 获得上传的文件名
                String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                // 获得文件的后缀名
                String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);

                /**
                 * 如果文件后缀名fileExtName不是我们所需要的
                 * 就直接return，不处理，告诉用户文件类型不对
                 */
                System.out.println("文件信息[文件名：" + fileName + "---文件类型" + fileExtName + "]");

                // 可以使用UUID（唯一识别的通用码），保证文件名唯一
                // UUID.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
//                realPath + "/" +
//                uploadPath + "/" +
                fileName = uuidPath + "_" + fileName;
                FileOutputStream fos = new FileOutputStream(uploadPath + "/" + 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;
    }
}