DIV CSS 佈局教程網

用 AJAX 實作檔案上傳並即時顯示進度條
編輯:關於JavaScript     

檔案上傳時若沒有進度回饋,使用者只能盯著畫面猜測到底發生什麼事。這個範例用 JSP + Servlet + Commons-FileUpload 做出一條會即時前進的進度條,核心技巧是「表單提交到隱藏 iframe」加上「另一條 AJAX 通道輪詢進度」。

整體架構

JSP 頁面:表單加上 enctype="multipart/form-data",並把 target 指向一個隱藏的 iframe,這樣提交後頁面不會跳走。

UploadServlet:負責接收檔案,同時把上傳進度寫進 session。

getProgressServlet:只回傳 session 中的進度值,供前端輪詢。

進度條:用 AJAX 取回百分比,改變圖片的 width 呈現變化。

此外需要 commons-fileupload 與 commons-io 兩個 jar,少了後者會出現找不到類別的例外。

index.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="css/progress.css">
<script type="text/javascript" src="js/ul.js" charset="utf-8"></script>
</head>
<body>
<form action="UploadServlet" name="f1" id="f1" method="post"
      enctype="multipart/form-data" target="if">
  <input type="file" name="file1" /><br><br>
  <input type="reset"  name="res1" value="重置" />
  <input type="button" name="but1" value="提交" onclick="go();" />
</form><br>

<div id="pro" class="pro" align="left">
  <img alt="上傳進度" src="photo/progress.png" width="0" height="15" id="imgpro">
</div>
<span id="prop" style="width:15px; height:15px; display:none;">0%</span>

<iframe id="if" name="if" src="" style="display:none"></iframe>
</body>
</html>

progress.css

.pro {
  height: 15px;
  width: 500px;
  background: #FFFFF0;
  border: 1px solid #8FBC8F;
  margin: 0;
  padding: 0;
  display: none;
  position: relative;
  left: 25px;
  float: left;
}

ul.js(前端輪詢)

function go() {
  f1.submit();
  document.getElementById("pro").style.display = "block";
  document.getElementById("prop").style.display = "";
  timer = setInterval(getP, 50);   // 每 50ms 查一次進度
}

var xmlHttpRequest;
function getP() {
  if (window.XMLHttpRequest) {
    xmlHttpRequest = new XMLHttpRequest();
  } else {
    xmlHttpRequest = new ActiveXObject("Microsoft.XMLHTTP");
  }
  xmlHttpRequest.onreadystatechange = callBack;
  xmlHttpRequest.open("post", "getProgressServlet", true);
  xmlHttpRequest.setRequestHeader("Content-type", "application/x-www-form-urlencoded");
  xmlHttpRequest.send("&timeStamp=" + (new Date()).getTime());
}

function callBack() {
  if (xmlHttpRequest.readyState == 4 && xmlHttpRequest.status == 200) {
    var result = xmlHttpRequest.responseText.replace(/(^\s*)|(\s*$)/g, "");
    var res = result.split(",");
    var flag = res[1];     // 上傳成功標記
    var per  = parseInt(res[0], 10);
    var err  = res[2];     // 錯誤訊息

    document.getElementById("imgpro").style.width = per * 5 + "px";
    document.getElementById("prop").innerHTML = per + "%";

    if (flag == "OK") {
      clearInterval(timer);
      alert("上傳成功!");
      document.getElementById("pro").style.display = "none";
      document.getElementById("prop").innerHTML = "";
      f1.reset();
    }
    if (err != "" && err.length > 0) {
      clearInterval(timer);
      alert(err);
    }
    if (flag == null) { clearInterval(timer); }
  }
}

UploadServlet:接收檔案並寫入進度

package com.ul.servlet;

import java.io.*;
import java.util.*;
import javax.servlet.ServletException;
import javax.servlet.http.*;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;

public class UploadServlet extends HttpServlet {
  protected void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    doPost(request, response);
  }

  protected void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    request.setCharacterEncoding("utf-8");
    response.setCharacterEncoding("utf-8");

    HttpSession session = request.getSession();
    session.setAttribute("prog", "0");
    session.setAttribute("result", "NOK");
    session.setAttribute("error", "");
    String error = "";

    int maxSize = 50 * 1024 * 1024;   // 上限 50MB

    DiskFileItemFactory factory = new DiskFileItemFactory();
    ServletFileUpload upload = new ServletFileUpload(factory);

    try {
      List items = upload.parseRequest(request);
      Iterator itr = items.iterator();
      while (itr.hasNext()) {
        FileItem item = (FileItem) itr.next();
        if (!item.isFormField()) {
          if (item.getName() != null && !item.getName().equals("")) {
            long upFileSize = item.getSize();
            String fileName = item.getName();
            if (upFileSize > maxSize) {
              error = "您上傳的檔案太大,請選擇不超過 50MB 的檔案!";
              break;
            }
            File tempFile = new File(fileName);
            File file = new File("f:\\temp", tempFile.getName());

            InputStream is = item.getInputStream();
            int length = 0;
            byte[] by = new byte[1024];
            double persent = 0;
            FileOutputStream fos = new FileOutputStream(file);
            while ((length = is.read(by)) != -1) {
              persent += length / (double) upFileSize * 100D;
              fos.write(by, 0, length);
              session.setAttribute("prog", Math.round(persent) + "");
              Thread.sleep(10);
            }
            fos.close();
            Thread.sleep(1000);
          } else {
            error = "沒選擇上傳檔案!";
          }
        }
      }
    } catch (Exception e) {
      e.printStackTrace();
      error = "上傳檔案出現錯誤:" + e.getMessage();
    }

    if (!error.equals("")) {
      session.setAttribute("error", error);
    } else {
      session.setAttribute("result", "OK");
    }
  }
}

getProgressServlet:回報進度

package com.ul.servlet;

import java.io.*;
import javax.servlet.ServletException;
import javax.servlet.http.*;

public class getProgressServlet extends HttpServlet {
  protected void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    doPost(request, response);
  }

  protected void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
    request.setCharacterEncoding("utf-8");
    response.setCharacterEncoding("utf-8");

    HttpSession session = request.getSession();
    PrintWriter out = response.getWriter();
    String str = (String) session.getAttribute("prog") + "";
    String res = (String) session.getAttribute("result");
    String err = (String) session.getAttribute("error");
    out.print(str + "," + res + "," + err);
    out.flush();
    out.close();
  }
}

這份程式有哪些必須修正的地方

一、檔名未經處理,存在 Path Traversal 風險。item.getName() 取得的是使用者端傳來的字串,攻擊者可以偽造成 ..\..\webapps\ROOT\shell.jsp 這類路徑,把檔案寫到任何位置。務必只取檔名本身並重新產生儲存名稱:

String original = Paths.get(item.getName()).getFileName().toString();
String saved = UUID.randomUUID() + "_" + original;
File file = new File(uploadDir, saved);

同時要限制副檔名白名單,並把上傳目錄放在 web 目錄之外、禁止執行。

二、把進度存在 session 會阻斷請求。上傳進行中,該使用者的 session 被鎖住,輪詢用的 getProgressServlet 必須等上傳結束才能取得鎖,進度條因此不會即時更新——這是這個寫法最根本的缺陷。正確做法是改用應用層級的 ConcurrentHashMap(以 session id 或上傳識別碼為 key)保存進度,讓讀取不被鎖住。

三、Thread.sleep 只是假模擬。它並不會讓上傳變慢,只是讓進度看起來平滑,實務上應該移除。

四、輪詢太頻繁。每 50 毫秒發一個請求對伺服器是沉重負擔,改為 500 毫秒到 1 秒一次即可。

五、用圖片當進度條不必要。直接用 div 改變寬度加上 CSS transition 就能做出更平滑的效果。

現代做法:XMLHttpRequest 的 upload progress 事件

今天完全不需要後端幫忙算進度。瀏覽器的 XHR 物件本身就提供了 upload.onprogress,能直接取得已上傳與總位元組數;若用 fetch,則可搭配 ReadableStream 自行實作:

var xhr = new XMLHttpRequest();
xhr.open('POST', 'upload');
xhr.upload.onprogress = function (e) {
  if (e.lengthComputable) {
    var percent = Math.round(e.loaded / e.total * 100);
    document.getElementById('bar').style.width = percent + '%';
    document.getElementById('prop').textContent = percent + '%';
  }
};
xhr.onload = function () {
  if (xhr.status === 200) console.log('上傳完成');
};
xhr.send(document.getElementById('file1').files[0]);

這個做法不需要 iframe、不需要第二支 servlet、不需要 session 輪詢,進度也更精確。若要同時上傳多檔並整體計算百分比,把各檔的 loaded 與 total 分別累加即可。

最後補上幾個上傳功能該有的基本配備:檔案大小與型別的伺服器端驗證(前端檢查只能算提示)、上傳失敗與逾時的重試機制、以及對大型檔案考慮分片上傳(chunked upload)以便中斷續傳。這些都屬於「看起來簡單但其實魔鬼在細節」的部分。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved