Java文件上传详解

心已赠人 2021-12-01 11:40 285阅读 0赞

### 文章目录 ###

*  文件上传和下载
 *   *  准备工作
     *  使用类介绍
     *  代码编写

# 文件上传和下载 #

在Web应用中，文件上传和下载功能是非常常用的功能，这篇博客就来讲一下JavaWeb中的文件上传和下载功能的实现。

## 准备工作 ##

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

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

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

**首先下载最新的jar包**

*  [https://mvnrepository.com/artifact/commons-io/commons-io][https_mvnrepository.com_artifact_commons-io_commons-io]
 *  [https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload][https_mvnrepository.com_artifact_commons-fileupload_commons-fileupload]
    
    下载完成后如图所示：  
    ![在这里插入图片描述][20190720113317298.png]  
    **在JavaWeb项目中导入jar包**  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxMTUxNjU5_size_16_color_FFFFFF_t_70]  
    **注意**：使用IDEA导包需要注意修复路径，将lib添加到项目输出目录

## 使用类介绍 ##

【文件上传的注意事项】

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

【需要用到的类详解】

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

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

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

演示代码如下：

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

//isFormField方法用于判断FileItem类对象封装的数据是一个普通文本表单
        //还是一个文件表单，如果是普通表单字段则返回true，否则返回false
        boolean isFormField();
        
        //getFieldName方法用于返回表单标签name属性的值。
        String getFieldName();
        //getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
        String getString();
            
        //getName方法用于获得文件上传字段中的文件名。
        String getName();
        
        //以流的形式返回上传文件的数据内容。
        InputStream getInputStream()
        
        //delete方法用来清空FileItem类对象中存放的主体内容
        //如果主体内容被保存在临时文件中，delete方法将删除该临时文件。
        void delete();

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

## 代码编写 ##

新建一个Web项目，编写一个页面（upload.jsp），用于接受文件上传，再编写一个Servlet类（UploadFileServlet.java），然后再从类中传来的msg对象置入到新的页面中（info.jsp），项目代码如下：

1.  UploadFileServlet.java

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;
    
    public class UploadServlet extends HttpServlet { 
        protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
            doGet(request, response);
        }
    
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 
    
            try { 
                //判断上传的文件是普通的表单还是带文件的表单
                if (!ServletFileUpload.isMultipartContent(request)) { 
                    return;//如果是普通文件，我们可以直接返回
                } //如果通过了这个if，说明我们的表单是带文件上传的；
    
                //创建上传文件的保存路径，建议在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 file = new File(tmpPath);
                if (!file.exists()) { //如果目录不存在，创建这样一个目录；
                    file.mkdir();
                }
    
                //处理上传的文件，一般都需要通过流来获取，我们可以使用request.getInputStream(),原生态的文件上传流获取，十分麻烦
                //但是我们都建议使用 Apache的文件上传组件来实现，common-fileupload，它需要依赖于 commons-io组件；
    
                //1.创建DiskFileItemFactory对象，处理文件上传路径或者大小限制的；
                DiskFileItemFactory factory = getDiskFileItemFactory(file);
                //2.获取ServletFileUpload
                ServletFileUpload upload = getServletFileUpload(factory);
                //3.处理上传的文件
                String msg = uploadParseRequest(upload, request, uploadPath);
    
                //servlet请求转发消息
                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() { 
                @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);
            //设置总共能够上传文件的大小
            //1024 = 1kb * 1024 = 1M * 10 = 10M
            upload.setSizeMax(1024 * 1024 * 10);
    
            return upload;
        }
    
    
        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;
                    }
    
                    //获得上传的文件名 /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+"]");
    
                    //可以使用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
                    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;
    
        }
    
    
    }

1.  upload.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>文件上传</title>
    </head>
    <body>
        <form action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data" method="post">
            上传用户：<input type="text" name="username"><br/>
            上传文件1：<input type="file" name="file1"><br/>
            上传文件2：<input type="file" name="file2"><br/>
            <input type="submit" value="提交">
        </form>
    </body>
    </html>

1.  info.jsp

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

1.  web.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>upload</servlet-name>
            <servlet-class>com.kuang.servlet.UploadFileServlet</servlet-class>
        </servlet>
        
        <servlet-mapping>
            <servlet-name>upload</servlet-name>
            <url-pattern>/upload.do</url-pattern>
        </servlet-mapping>
    </web-app>

[https_mvnrepository.com_artifact_commons-io_commons-io]: https://mvnrepository.com/artifact/commons-io/commons-io
[https_mvnrepository.com_artifact_commons-fileupload_commons-fileupload]: https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload
[20190720113317298.png]: /images/20211201/04d74dbd77cd45599a4b6579d19b4eb7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQxMTUxNjU5_size_16_color_FFFFFF_t_70]: /images/20211201/da96f9fc416d41aebf3e45d48e3561ad.png