透過瀏覽器上傳檔案,特別是用 <input type="file"> 這種方式,一直有嚴重的體驗問題:使用者按下上傳後,瀏覽器把檔案送到伺服器的這段期間,畫面看起來就像當機。小檔案還好,一旦要送幾 MB、幾十 MB甚至上百 MB,那種煎熬相信很多人都體驗過。
這篇給出一個解法:做一個具備監控能力的 Web 上傳程式,不但把檔案送到伺服器,還能即時反映上傳進度。

這個類別記錄上傳狀態,並作為伺服器與瀏覽器之間溝通的媒介。伺服器把狀態序列化成 JSON 回傳,客戶端用 JavaScript 取得。
package liuzuochen.sample.upload;
import java.util.*;
public class FileUploadStatus {
private String uploadAddr; // 上傳者位址
private long uploadTotalSize = 0; // 上傳總量
private long readTotalSize = 0; // 已讀取總量
private int currentUploadFileNum = 0; // 目前正在處理第幾個檔案
private int successUploadFileCount = 0; // 已成功上傳的檔案數
private String status = ""; // 狀態文字
private long processStartTime = 0; // 起始時間
private long processEndTime = 0; // 結束時間
private long processRunningTime = 0; // 已耗用時間
private List uploadFileUrlList = new ArrayList(); // 已上傳檔案清單
private boolean cancel = false; // 是否取消
private String baseDir = ""; // 上傳根目錄
// 各欄位的 getter / setter 略
public String toJson() {
StringBuffer s = new StringBuffer();
s.append("{UploadTotalSize:").append(getUploadTotalSize()).append(",")
.append("ReadTotalSize:").append(getReadTotalSize()).append(",")
.append("CurrentUploadFileNum:").append(getCurrentUploadFileNum()).append(",")
.append("SuccessUploadFileCount:").append(getSuccessUploadFileCount()).append(",")
.append("Status:'").append(getStatus()).append("',")
.append("ProcessStartTime:").append(getProcessStartTime()).append(",")
.append("ProcessEndTime:").append(getProcessEndTime()).append(",")
.append("ProcessRunningTime:").append(getProcessRunningTime()).append(",")
.append("Cancel:").append(getCancel()).append("}");
return s.toString();
}
}
使用 commons-fileupload 1.2 版(20070103)。這個版本提供了 ProgressListener 介面,讓開發者能透過 FileUploadBase 的 setProgressListener 植入自己的監聽器。本類別實作該介面,在整個上傳過程中持續更新狀態物件。
package liuzuochen.sample.upload;
import org.apache.commons.fileupload.ProgressListener;
import javax.servlet.http.HttpServletRequest;
public class FileUploadListener implements ProgressListener {
private HttpServletRequest request = null;
public FileUploadListener(HttpServletRequest request) {
this.request = request;
}
public void update(long pBytesRead, long pContentLength, int pItems) {
FileUploadStatus statusBean = BackGroundService.getStatusBean(request);
statusBean.setUploadTotalSize(pContentLength);
if (pContentLength == -1) {
// 讀取完成
statusBean.setStatus("完成對 " + pItems + " 個檔案的讀取:共 " + pBytesRead + " bytes.");
statusBean.setReadTotalSize(pBytesRead);
statusBean.setSuccessUploadFileCount(pItems);
statusBean.setProcessEndTime(System.currentTimeMillis());
statusBean.setProcessRunningTime(
statusBean.getProcessEndTime() - statusBean.getProcessStartTime());
} else {
// 讀取中
statusBean.setStatus("正在處理第 " + pItems + " 個檔案:已讀取 "
+ pBytesRead + " / " + pContentLength + " bytes.");
statusBean.setReadTotalSize(pBytesRead);
statusBean.setCurrentUploadFileNum(pItems);
statusBean.setProcessRunningTime(
System.currentTimeMillis() - statusBean.getProcessStartTime());
}
BackGroundService.saveStatusBean(request, statusBean);
}
}
這個 Servlet 負責三件事:接收表單 POST 的檔案、回應狀態輪詢、處理取消上傳的請求。職責其實可以拆開,但為了清楚起見集中在同一個 Servlet,只是用不同方法切分。
package liuzuochen.sample.upload;
import java.io.File;
import java.io.IOException;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.http.*;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
public class BackGroundService extends javax.servlet.http.HttpServlet {
public static final String UPLOAD_DIR = "/upload";
public static final String DEFAULT_UPLOAD_FAILURE_URL = "./result.jsp";
protected void doGet(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
doPost(request, response);
}
/** 從完整路徑取出檔名 */
private String takeOutFileName(String filePath) {
int pos = filePath.lastIndexOf(File.separator);
return (pos > 0) ? filePath.substring(pos + 1) : filePath;
}
/** 取出目前使用者的狀態物件 */
public static FileUploadStatus getStatusBean(HttpServletRequest request) {
return BeanControler.getInstance().getUploadStatus(request.getRemoteAddr());
}
/** 存入狀態物件 */
public static void saveStatusBean(HttpServletRequest request, FileUploadStatus statusBean) {
statusBean.setUploadAddr(request.getRemoteAddr());
BeanControler.getInstance().setUploadStatus(statusBean);
}
/** 刪除已上傳的檔案 */
private void deleteUploadedFile(HttpServletRequest request) {
FileUploadStatus s = getStatusBean(request);
for (int i = 0; i < s.getUploadFileUrlList().size(); i++) {
File f = new File(request.getRealPath(UPLOAD_DIR) + File.separator
+ s.getUploadFileUrlList().get(i));
f.delete();
}
s.getUploadFileUrlList().clear();
s.setStatus("已刪除上傳的檔案");
saveStatusBean(request, s);
}
private void uploadExceptionHandle(HttpServletRequest request, String errMsg)
throws ServletException, IOException {
deleteUploadedFile(request);
FileUploadStatus s = getStatusBean(request);
s.setStatus(errMsg);
saveStatusBean(request, s);
}
private FileUploadStatus initStatusBean(HttpServletRequest request) {
FileUploadStatus s = new FileUploadStatus();
s.setStatus("正在準備處理");
s.setUploadTotalSize(request.getContentLength());
s.setProcessStartTime(System.currentTimeMillis());
s.setBaseDir(request.getContextPath() + UPLOAD_DIR);
return s;
}
/** 處理檔案上傳 */
private void processFileUpload(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
DiskFileItemFactory factory = new DiskFileItemFactory();
factory.setSizeThreshold(10240000); // 超過此值就寫入暫存檔
factory.setRepository(new File(request.getRealPath("/upload/temp")));
ServletFileUpload upload = new ServletFileUpload(factory);
upload.setFileSizeMax(102400000); // 單檔上限
upload.setSizeMax(102400000); // 整個請求上限
upload.setProgressListener(new FileUploadListener(request));
saveStatusBean(request, initStatusBean(request));
String forwardURL = "";
try {
List items = upload.parseRequest(request);
// 先找出表單中的轉向網址欄位
for (int i = 0; i < items.size(); i++) {
FileItem item = (FileItem) items.get(i);
if (item.isFormField()) { forwardURL = item.getString(); break; }
}
for (int i = 0; i < items.size(); i++) {
FileItem item = (FileItem) items.get(i);
if (getStatusBean(request).getCancel()) {
deleteUploadedFile(request);
break;
} else if (!item.isFormField() && item.getName().length() > 0) {
String fileName = takeOutFileName(item.getName());
File uploadedFile = new File(request.getRealPath(UPLOAD_DIR)
+ File.separator + fileName);
item.write(uploadedFile);
FileUploadStatus s = getStatusBean(request);
s.getUploadFileUrlList().add(fileName);
saveStatusBean(request, s);
Thread.sleep(500); // 刻意放慢,方便觀察進度條
}
}
} catch (FileUploadException e) {
uploadExceptionHandle(request, "上傳檔案時發生錯誤:" + e.getMessage());
} catch (Exception e) {
uploadExceptionHandle(request, "儲存檔案時發生錯誤:" + e.getMessage());
}
if (forwardURL.length() == 0) forwardURL = DEFAULT_UPLOAD_FAILURE_URL;
request.getRequestDispatcher(forwardURL).forward(request, response);
}
/** 回應狀態查詢 */
private void responseStatusQuery(HttpServletRequest request, HttpServletResponse response)
throws IOException {
response.setContentType("application/json");
response.setCharacterEncoding("UTF-8");
response.setHeader("Cache-Control", "no-cache");
response.getWriter().write(getStatusBean(request).toJson());
}
/** 處理取消上傳 */
private void processCancelFileUpload(HttpServletRequest request, HttpServletResponse response)
throws IOException {
FileUploadStatus s = getStatusBean(request);
s.setCancel(true);
saveStatusBean(request, s);
responseStatusQuery(request, response);
}
protected void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
if (ServletFileUpload.isMultipartContent(request)) {
processFileUpload(request, response);
} else {
request.setCharacterEncoding("UTF-8");
if (request.getParameter("uploadStatus") != null) responseStatusQuery(request, response);
if (request.getParameter("cancelUpload") != null) processCancelFileUpload(request, response);
}
}
}
單例類,負責為各個客戶端保存上傳狀態。這裡刻意不用 Session 儲存,因為 Ajax 的非同步請求會開啟不同的 Session,導致讀不到同一份狀態。
package liuzuochen.sample.upload;
import java.util.Vector;
public class BeanControler {
private static BeanControler beanControler = new BeanControler();
private Vector vector = new Vector();
private BeanControler() {}
public static BeanControler getInstance() { return beanControler; }
private int indexOf(String strID) {
for (int i = 0; i < vector.size(); i++) {
FileUploadStatus s = (FileUploadStatus) vector.elementAt(i);
if (s.getUploadAddr().equals(strID)) return i;
}
return -1;
}
public FileUploadStatus getUploadStatus(String strID) {
return (FileUploadStatus) vector.elementAt(indexOf(strID));
}
public void setUploadStatus(FileUploadStatus status) {
int n = indexOf(status.getUploadAddr());
if (n == -1) vector.add(status);
else vector.setElementAt(status, n);
}
public void removeUploadStatus(String strID) {
int n = indexOf(strID);
if (n != -1) vector.removeElementAt(n);
}
}
作者本人也指出這個做法並非最佳解,歡迎討論。以現今角度補充:用 Vector 存全域狀態在多使用者環境下會有記憶體累積與線程安全問題,比較好的方案是改用 ConcurrentHashMap 並加上 TTL 逾時清理,或直接把狀態放進 Redis 這類外部儲存,讓多台伺服器也能共享。
客戶端採用 Prototype 框架。
對 Prototype 的 Ajax 請求做一層封裝。註解中特別提到一個坑:呼叫 Ajax.Request 時 this 的參照會]}