使用 Apache的文件上传组件（common-fileupload）来实现文件的上传

最新推荐文章于 2024-06-08 10:06:08 发布

StudiousTiger

最新推荐文章于 2024-06-08 10:06:08 发布

阅读量5k

点赞数 2

分类专栏： Tiger の JavaWeb 文章标签： jsp servlet java maven apache

本文链接：https://blog.csdn.net/m0_45067620/article/details/117869251

版权

Tiger の JavaWeb 专栏收录该内容

42 篇文章 0 订阅

订阅专栏

文章目录

一、前言/先导

maven的依赖：

注意：common-fileupload，它需要依赖于 commons-io组件；

<dependencies>
        <!--servlet的依赖-->
        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
        </dependency>

        <!--JSP的依赖-->
        <dependency>
            <groupId>javax.servlet.jsp</groupId>
            <artifactId>javax.servlet.jsp-api</artifactId>
            <version>2.3.3</version>
        </dependency>

        <!--JSTL的依赖-->
        <dependency>
            <groupId>javax.servlet.jsp.jstl</groupId>
            <artifactId>jstl-api</artifactId>
            <version>1.2</version>
        </dependency>

        <!--standard标签库-->
        <dependency>
            <groupId>taglibs</groupId>
            <artifactId>standard</artifactId>
            <version>1.1.2</version>
        </dependency>

        <!-- 上传文件的依赖 -->
        <dependency>
        <!--common-fileupload的依赖组件-->
            <groupId>commons-io</groupId>
            <artifactId>commons-io</artifactId>
            <version>2.6</version>
        </dependency>
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.4</version>
        </dependency>
    </dependencies>

文件上传是的注意事项：

为了保证服务器的安全，上传的文件应该放在一个外界无法访问的地方，比如WEB-INF目录下。
为了防止文件的覆盖问题，我们要给用户上传的文件一个唯一的文件名。
通常由一下几种方式：时间戳+随机数、UUID、MD5、自己写一些位运算的算法要显示文件上传的大小。
可以限制文件上传的类型，通过后缀判断合法性。

需要用到的类：

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

将会使用的方法：

boolean isFormField(); //判断是是否是文件表单
String getFieldName(); //返回表单的name属性
String getString(); //将FileItem中的保存的数据流以一个字符串返回
String getName(); // 用于获取文集爱你上传字段中的文件名
InputStream getInpuStream(); //以流的形式返回上传文件的数据内容
//清除FileItem中的主体内容。
//如果主体内容中保存的是临时文件，则删除该临时文件
void delete();

二、步骤

第一步：判断是普通表单还是文件表单

第二步：保存路径，建议保存造WEB-INF目录下

第三步：缓存、临时文件（对于大文件，我们应该将其设置为临时文件）

第四步：创建DiskFileItemFactory对象，处理文件上传路径或大小的限制

第五步：获取ServletFileUpload

第六步：处理上传的文件

6.1获得上传的文件名、获取UUID

6.2给每个文件创建一个对应的文件夹

6.3存放文件

6.4上传成功，清除临时文件

三、源码

servlet（ServletUpload）：

package com.stdpei;

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

/**
 * @author huxuehao
 */
public class ServletUpload 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");
            //System.out.println(uploadPath);
            File uploadFile = new File(uploadPath);
            //判断目录是否存在
            if (!uploadFile.exists()){
                uploadFile.mkdir();
            }

            //临时路径,如果文件好过了预期大小，就把他放到一个临时文件中，过几天自动删除，或者提醒用户转存为永久
            String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
            File tempFile = new File(tmpPath);
            //判断目录是否存在
            if (!tempFile.exists()){
                tempFile.mkdir();
            }
            try {
                //使用 Apache的文件上传组件来实现，common-fileupload，它需要依赖于 commons-io组件；
                //1、创建DiskFileItemFactory对象，处理文件上传路径或大小的限制
                DiskFileItemFactory factory = getDiskFileItemFactory(tempFile);
                //2、获取ServletFileUpload
                ServletFileUpload upload = getServletFileUpload(factory);
                //3、处理上传的文件
                String msg = uploadParseRequest(upload,request,uploadPath);
                //转发一下信息
                request.setAttribute("msg",msg);
                request.getRequestDispatcher("msg.jsp").forward(request,response);
            } catch (FileUploadException e) {
                e.printStackTrace();
            }
        }
        public static DiskFileItemFactory getDiskFileItemFactory(File tempFile){
            DiskFileItemFactory factory = new DiskFileItemFactory();
            //通过这个工厂设置一个缓冲区，当上传的文件大于这个缓冲区的时候，将他放到临时文件中
            factory.setSizeThreshold(1024*1024); //缓冲区大小为1M
            factory.setRepository(tempFile);//临时文件保存的目录，需要一个File
            return factory;
        }
        public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory){
            ServletFileUpload upload = new ServletFileUpload(factory);
            /*
            //监听文件上传进度(别导错包了：org.apache.commons.fileupload.ProgressListener)
            upload.setProgressListener(new ProgressListener(){
                //pBytesRead:已经读取到的文件大小
                //pContentLength ： 文件大小
                public void update(long pBytesRead, long pContentLength, int pItems) {
                    //这个地方是可以实现进度条的：已上传/总大小
                    System.out.println("总大小："+pContentLength+"已上传"+pBytesRead);
                }
            });
            */

            //处理乱码问题
            upload.setHeaderEncoding("utf-8");
            //设置单个文件的最大值10M
            upload.setFileSizeMax(1024*1024*10);
            //设置总共能够上传文件的大小
            upload.setSizeMax(1024 * 1024 * 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()){ //是一个普通的input（type!=file）
                    String name = fileItem.getFieldName();
                    String value = fileItem.getString("UTF-8");
                    System.out.println(name+":"+value);
                }else { //带文件（type!=file）
                    //****************************处理文件****************************
                    //拿到文件名字
                    String uploadFileName = fileItem.getName();
                    System.out.println("上传的文件名："+uploadFileName);
                    //如果文件名不合法(name的值为空)，那么直接continue
                    if (uploadFileName.trim().equals("") || uploadFileName==null){
                        continue;
                    }
                    //获得上传的文件名
                    String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);

                    /*
                    //#########可以通过后缀名来实现文件类型审查##############
                    //获得文件的后缀名
                    String fileExName = uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
                    System.out.println("文件信息 [文件名："+fileName+"---文件类型"+fileExName+"]");
                    */

                    //可以使用UUID（唯一识别通用码）保证uuidPath唯一
                    String uuidPath = UUID.randomUUID().toString();

                    //****************************处理文件完毕****************************
                    //真实存在的路径
                    String realPath = uploadPath+"/"+uuidPath;
                    //给每个文件创建一个对应的文件夹，这样的话再不改变名的基础上，重名的文件也可以被存储
                    File realPathFile = new File(realPath);
                    if (!realPathFile.exists()){
                        realPathFile.mkdir();
                    }
                    //****************************存放地址完毕*****************************
                    //获得文件上传的流
                    InputStream inputStream = fileItem.getInputStream();
                    //创建一个文件输出流
                    //realPath是真实的文件夹
                    FileOutputStream fos = new FileOutputStream(realPath + "/"+fileName);

                    //创建一个缓冲区
                    byte[] buffer = new byte[1024 * 1024];
                    //判断是否读取完毕
                    int len = 0;
                    while ((len=inputStream.read(buffer))>0){
                        fos.write(buffer,0,len);
                    }

                    //关闭流
                    fos.close();
                    inputStream.close();
                    msg = "文件上传成功";

                    fileItem.delete();//上传成功，清除临时文件
                    //*************************文件传输完毕**************************
                }
            }
            return msg;
        }
}

web.xml:

  <servlet>
    <servlet-name>upload</servlet-name>
    <servlet-class>com.stdpei.ServletUpload</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>upload</servlet-name>
    <url-pattern>/upload</url-pattern>
  </servlet-mapping>

upload.jsp:

<%@ page contentType="text/html;charset=UTF-8"%>
<%@ page language="java"%>

<html>
<head>
    <title>文件上传</title>
</head>
<body>
<br>
<form action="${pageContext.request.contextPath}/upload" method="post" enctype="multipart/form-data">
    上传用户: <input type="text" name="username"><br/>
    上传文件：<input type="file" name="file"><br/>
    <input type="submit" value="提交">
</form>
</body>
</html>

msg.jsp:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>消息提示</title>
</head>
<body>
    ${msg}
</body>
</html>

四、测试结果

选择文件：
在这里插入图片描述

提交时的进度：

提交成功：

已经存在与Tomcat中：

五、文件的下载

【点击查看】

StudiousTiger

关注

2
点赞
踩
24

收藏

觉得还不错? 一键收藏
0
评论
使用 Apache的文件上传组件（common-fileupload）来实现文件的上传

文章目录一、前言/先导二、步骤三、源码四、测试结果一、前言/先导maven的依赖：注意：common-fileupload，它需要依赖于 commons-io组件；<dependencies>  <dependency> <groupId>javax.servlet</groupId> <artifactId>s
复制链接

扫一扫

专栏目录