初學Java Web(7)——文件的上傳和下載


文件上傳

文件上傳前的准備

  1. 在表單中必須有一個上傳的控件
    <input type="file" name="testImg"/>
  2. 因為 GET 方式有請求大小的限制,所以表單的提交方式必須是 POST
    <form action="/upload" method="post">
  3. 表單默認的編碼方式為 application/x-www-form-urlencoded ,應該修改為 multipart/form-data以二進制的形式進行數據的傳輸
    <form action="/upload" method="post" enctype="multipart/form-data">
  • 注意:此時 Servlet 中就不能再使用 request對象.getParameter(String name) 來獲取請求參數

上傳組件

實現文件的上傳,需要基於以下兩種組件的一種:

  • Apache FileUpload 組件【操作比較復雜】
  • SmartUpload 組件【操作比較簡單,但存在一些問題】

基於 FileUpload 組件

使用基於Apache FileUpload上傳組件實現文件的上傳,步驟:

  1. 必要的 jar 包導入到項目中
    commons-fileupload-1.2.2.jar
    commons-io-1.4.jar
  2. 簡單寫好 upload.jsp 上傳頁面:
<!DOCTYPE html>
<%@ page language="java" contentType="text/html; charset=UTF-8"
         pageEncoding="UTF-8" import="java.util.*" %>
<html>
<head>
    <title>文件的上傳和下載</title>
</head>
<body>

文件上傳:
<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="testImg"/> <br>
    <input type="submit"/>
</form>

</body>
</html>

  1. 編寫 UploadServlet 處理相關請求:
package servlet;

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemFactory;
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.File;
import java.io.IOException;
import java.util.List;

@WebServlet("/upload")
public class UploadServlet extends HttpServlet {

    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 驗證請求是否滿足要求(post 請求 / enctype 是否以multipart打頭
        boolean isMultipart = ServletFileUpload.isMultipartContent(req);
        // 如果不滿足要求就立即結束對該請求的處理
        if (!isMultipart) {
            return;
        }

        try {
            // FileItem 是表單中的每一個元素的封裝
            // 創建一個 FileItem 的工廠類
            FileItemFactory factory = new DiskFileItemFactory();
            // 創建一個文件上傳處理器(裝飾設計模式)
            ServletFileUpload upload = new ServletFileUpload(factory);
            // 解析請求
            List<FileItem> items = upload.parseRequest(req);
            for (FileItem fileItem :
                    items) {
                // 判斷空間是否是普通控件
                if (fileItem.isFormField()) {
                    // 普通控件
                } else {
                    // 上傳控件
                    // 將上傳的文件保存到服務器
                    fileItem.write(new File("C:/", "testImg.jpg"));
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

文件上傳的細節

上面已經能實現簡單的文件上傳功能了,但文件上傳有很多需要注意的地方。

  • 緩存大小和臨時目錄
    在上傳文件的時候,如果文件過大,而且是將文件放在緩存中,就可能造成內存溢出
    默認的緩存大小為 10 kb,臨時目錄的默認值為 tomcat/temp
  • 解決方案:將操作緩存大小的文件放在服務器的磁盤(臨時目錄)中,在文件的大小超過設定的緩存大小的時候就會使用到臨時目錄
// 設置緩存大小 500kb
factory.setSizeThreshold(1024*500);
// 設置臨時目錄
factory.setRepository(new File("C:/"));
  • 通常不需要設置

另一個問題是:如果用戶 A 上傳了一個文件名叫xxx,用戶 B 也上傳了一個文件名叫 xxx,那么此時用戶 B 的文件會把用戶 A 的文件給覆蓋掉。

  • 文件名稱的處理
    相同文件名稱的文件,后面的文件會把前面的文件覆蓋掉
  • 解決方案:使用UUID來生成一個隨機的而且不重復字符串作為文件的名稱,獲取真實文件的后綴名需要用到 FilenameUtils 這個工具類
  • 語法:
String fileName = UUID.randomUUID().toString()+"."+FilenameUtils.getExtension(fileItem.getName());

文件類型的約束

上傳文件的類型應該需要做一些約束的,比如在上傳頭像的時候就只允許上傳圖片,其他類型的文件都不應該允許上傳,並且如果類型不正確的時候,應該給用戶一個錯誤的提示。

  • jsp 文件增加顯示錯誤提示信息:
    我們給我們的 jsp 開頭增加一個 <span> 來顯示錯誤信息
<!DOCTYPE html>
<%@ page language="java" contentType="text/html; charset=UTF-8"
         pageEncoding="UTF-8" import="java.util.*" %>
<html>
<head>
    <title>文件的上傳和下載</title>
</head>
<body>

文件上傳:<span>${errorMsg}</span>
<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="testImg"/> <br>
    <input type="submit"/>
</form>

</body>
</html>
  • 判斷上傳文件類型:
    限制文件類型那么就需要對文件類型進行判斷
  • 語法:String contentType = fileItem.getContentType();
  • Servlet 源碼:
package servlet;

import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemFactory;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import org.apache.commons.io.FilenameUtils;

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.File;
import java.io.IOException;
import java.util.List;
import java.util.UUID;

@WebServlet("/upload")
public class UploadServlet extends HttpServlet {

    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 驗證請求是否滿足要求(post 請求 / enctype 是否以multipart打頭
        boolean isMultipart = ServletFileUpload.isMultipartContent(req);
        // 如果不滿足要求就立即結束對該請求的處理
        if (!isMultipart) {
            return;
        }

        try {
            // FileItem 是表單中的每一個元素的封裝
            // 創建一個 FileItem 的工廠類
            FileItemFactory factory = new DiskFileItemFactory();
            // 創建一個文件上傳處理器(裝飾設計模式)
            ServletFileUpload upload = new ServletFileUpload(factory);
            // 解析請求
            List<FileItem> items = upload.parseRequest(req);
            for (FileItem fileItem :
                    items) {
                // 判斷空間是否是普通控件
                if (fileItem.isFormField()) {
                    // 普通控件
                } else {
                    // 上傳控件
                    String contentType = fileItem.getContentType();
                    if (!contentType.startsWith("image/")) {
                        // 實現簡單的錯誤提示
                        req.setAttribute("errorMsg", "親,您上傳的文件格式不正確,請重新上傳!");
                        req.getRequestDispatcher("upload.jsp").forward(req, resp);
                        return;  // 如果不是圖片類型則不再對請求進行處理
                    }
                    // 隨機命名文件名
                    String fileName = UUID.randomUUID().toString() + "." + FilenameUtils.getExtension(fileItem.getName());
                    // 將上傳的文件保存到服務器
                    fileItem.write(new File("C:/", fileName));
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

解決中文亂碼問題

  • 解決中文文件名亂碼(事實上我在本地測試並沒有出現亂碼),得到解析器以后,就直接設置解析器的編碼為UTF-8就行了
 fileUpload.setHeaderEncoding("UTF-8");
  • 解決表單數據亂碼,在獲取表單值的時候,按照UTF-8編碼來獲取
String value = fileItem.getString("UTF-8");

文件大小約束

  • 單個文件數據的大小約束
    即整個表單之中只有一個上傳控件
  • 語法:upload.setFileSizeMax(1024 * 500); // 單個文件不能超過500 kb
  • 一次請求數據的大小約束
    限制整個請求之中的數據大小
  • 語法:upload.setSizeMax(1024 * 750); // 整個請求文件大小不能超過 750 kb

使用 Map 封裝請求信息

上面提到,我們已經無法用 request對象正常獲取到參數,那么我們究竟應該怎么辦呢?

  • 使用 Map 封裝一下就好了,等到要用的時候再從 Map 中取出

SmartUpload

上面已經基於 FileUpload 實現了文件的上傳,事實上也沒有想象中那么復雜,讓我們來看看 SmartUpload

要使用SmartUpload組件,就需要導入smartupload.jar開發包

快速入門

//實例化組件
SmartUpload smartUpload = new SmartUpload();

//初始化上傳操作
smartUpload.initialize(this.getServletConfig(), request, response);

try {

    //上傳准備
    smartUpload.upload();
    
    //對於普通數據,單純到request對象是無法獲取得到提交參數的。也是需要依賴smartUpload
    String password = smartUpload.getRequest().getParameter("password");
    System.out.println(password);
    
    //上傳到uploadFile文件夾中
    smartUpload.save("uploadFile");

} catch (SmartUploadException e) {
    e.printStackTrace();    
}
  • 摘自:這里
  • 上面鏈接提到 SmartUpload 組件在解決中文亂碼中有一些小問題,我沒有測試過,但我覺得自己寫一個 FileUpload 工具類已經足夠使用了

文件下載

  1. 寫一個簡單的 jsp 頁面:

  1. 在 WEB-INF 下創建 download 文件夾,里面放入一個 test.zip
  2. 編寫 Servlet 處理相關請求
package servlet;

import javax.servlet.ServletException;
import javax.servlet.ServletOutputStream;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.net.URLEncoder;
import java.nio.file.Files;
import java.nio.file.Paths;

@WebServlet("/download")
public class DownloadServlet extends HttpServlet {

    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        // 設置響應數據的 MIME 類型
        resp.setContentType("application/x-msdownload");
        // 獲取文件名稱
        String fileName = req.getParameter("fileName");
        // 判斷瀏覽器是否是 IE
        String userAgent = req.getHeader("User-Agent");
        if (userAgent.contains("MSIE")) {
            // IE
            // 設置文件的名稱
            resp.setHeader("Content-Disposition", "attachment; fileName="
                    + URLEncoder.encode(fileName, "UTF-8"));
        } else {
            // 非IE
            resp.setHeader("Content-Disposition", "attachment; fileName="
                    + new String(fileName.getBytes("UTF-8"), "ISO-8859-1"));
        }

        // 獲取文件所在的路徑
        String path = req.getServletContext().getRealPath("/WEB-INF/download");

        // 獲取指定的文件對象
        File f = new File(path, fileName);
        ServletOutputStream out = resp.getOutputStream();
        // 將文件復制到輸出流中,響應給瀏覽器
        Files.copy(Paths.get(f.getAbsolutePath()), out);
    }
}

歡迎轉載,轉載請注明出處!
簡書ID:@我沒有三顆心臟
github:wmyskxz
歡迎關注公眾微信號:wmyskxz_javaweb
分享自己的Java Web學習之路以及各種Java學習資料


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM