文件上传功能

2024-01-15 20:02:40

1、依赖jar包

commons-io-2.9.0.jar

commons-fileupload-1.4.jar（依赖commons-io-2.9.0.jar）

2、文件上传的注意事项

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

3、需要用到的类详解

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

前端页面注意点

在HTML页面input必须有name

<input type="file" name="filename">

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

FileItem类常用方法（FileItem对象由ServletFileUpload对象解析请求时获得）

//isFormFiled方法用于判断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列表的形式返回。使用该方法处理上传文件简单易用。

4、代码实现

index.jsp 上传页面

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
  <%--通过表单上传文件
      get：上传文件大小有限制
      post:上传文件大小没有限制，所以上传用post请求
  --%>
  <form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
    <p>上传用户：<input type="text" name="username"></input></p>
    <p><input type="file" name="file1"></p>
    <p><input type="file" name="file2"></p>
    <p><input type="submit"> | <input type="reset"></p>
  </form>
  </body>
</html>

info.jsp 上传成功跳转页面

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

web.xml注册FileServlet

<?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.edgar.servlet.FileServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>FileServlet</servlet-name>
        <url-pattern>/upload.do</url-pattern>
    </servlet-mapping>
</web-app>

FileServlet

package com.edgar.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 {
        // 判断上传的文件是普通表单还是带文件的表单
        if (!ServletFileUpload.isMultipartContent(req)) {
            return;// 终止方法运行
        }

        // 创建上传文件的保存路径，建议在WEB-INF路径下，安全，用户无法直接访问上传的文件
        String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
        System.out.println("uploadPath:" + uploadPath);
        File uploadFile = new File(uploadPath);
        if (!uploadFile.exists()) {
            uploadFile.mkdir();// 创建这个目录
        }

        // 存放临时文件的目录，假如文件大小超过了缓冲区的大小，我们就把它先放到一个临时路径中
        String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
        System.out.println("tmpPath:" + tmpPath);
        File file = new File(tmpPath);
        if (!file.exists()) {
            file.mkdir();// 创建这个临时目录
        }

        // 处理上传的文件，一般都需要通过流来获取，我们可以使用request.getInputStream()，原生态的文件上传流获取，十分麻烦
        // 但是我们都建议使用Apache的文件上传组件来实现，common-fileupload，它需要依赖于common.io组件
        try {
            // 1.创建DiskFileItemFactory对象，处理临时文件上传目录和大小限制的
            DiskFileItemFactory factory = getDiskFileItemFactory(file);
            // 2.获取ServletFileUpload
            ServletFileUpload upload = getServletFileUpload(factory);
            // 3.处理上传的文件
            String msg = uploadParseRequest(upload, uploadPath, req);

            //servlet请求转发消息
            req.setAttribute("msg", msg);
            req.getRequestDispatcher("/info.jsp").forward(req, resp);

        } 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
            // pByteRead：已经读取到的文件大小
            // pContentLength：文件大小
            public void update(long pByteRead, long pContentLength, int pItem) {
                System.out.println("总大小：" + pContentLength + "已上传：" + pByteRead);
            }
        });
        // 处理乱码的问题
        upload.setHeaderEncoding("UTF-8");
        // 设置单个文件的最大值，大于最大值就报异常，阻止上传
//        upload.setFileSizeMax(1024 *1024);
        // 设置总共能够上传文件的大小，大于最大值就报异常，阻止上传
//        upload.setSizeMax(1024 *1024);
        return upload;
    }

    public static String uploadParseRequest(ServletFileUpload upload, String uploadPath, HttpServletRequest request)
            throws FileUploadException, IOException {

        String msg = "";

        // 把前端请求解析，封装成一个FileItem对象
        List<FileItem> fileItems = upload.parseRequest(request);
        for (FileItem fileItem : fileItems) {
            if (fileItem.isFormField()) {// 判断FileItem类对象封装的数据是一个普通表单字段
                String name = fileItem.getFieldName();
                String value = fileItem.getString("UTF-8");// 处理乱码
                System.out.println(name + "：" + value);
            } else {// FileItem类对象封装的数据是一个表单文件数据
                //==================================处理文件开始======================================//
                String uploadFileName = fileItem.getName();
                System.out.println("上传的文件名：" + uploadFileName);

                if ("".equals(uploadFileName.trim()) || uploadFileName == null) {
                    continue;
                }

                // 获得上传的文件名 /images/girl/profile.png
                String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
                // 获取文件的后缀名
                String fileSuffixName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
                /*
                    如果文件后缀名 fileSuffixName 不是我们想要的
                    就直接return，不处理，告诉用户文件类型不对。
                */
                System.out.println("文件信息 [件名：" + fileName + "---文件类型：" + fileSuffixName + "]");

                // 可以使用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 in = fileItem.getInputStream();

                // 创建一个文件输出流
                // realPath = 真实的文件夹
                // 查了一个文件；加上输出文件的名字 + "/" + fileName
                FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);

                // 创建一个缓冲区
                byte[] buffer = new byte[1024 * 1024];

                // 判断是否读取完毕
                int len = 0;
                // 如果大于0说明还存在数据
                while ((len = in.read(buffer)) > 0) {
                    fos.write(buffer, 0, len);
                }

                //关闭流
                fos.close();
                in.close();

                // 上传成功，清除临时文件（只有当上传文件大于缓冲区时才有临时文件，且该文件还是能上传成功~）
                fileItem.delete();
                msg = "文件上传成功";
            }
        }
        return msg;
    }
}

码农公寓

1、依赖jar包

2、文件上传的注意事项

3、需要用到的类详解

4、代码实现

相关文章