Ajax 請求的判別與處理都在這個組件的解碼方法中完成。我們必須先確認這是一個真正的 Ajax 請求(以區別於正常的解碼行為),然後依據 ProgressMonitorFileItemFactory 的 SessionUpdatingProgressObserver 寫入工作階段的值,把 XML 回應送回客戶端。
public void decode(FacesContext context, UIComponent component) {
UIFileUpload input = (UIFileUpload) component;
ExternalContext extContext = context.getExternalContext();
Map parameterMap = extContext.getRequestParameterMap();
String clientId = input.getClientId(context);
Map requestMap = extContext.getRequestParameterMap();
if (requestMap.get(clientId) == null) {
return; // 什麼也不做
}
if (parameterMap.containsKey(PROGRESS_REQUEST_PARAM_NAME)) {
// 這是查詢上傳進度的請求,取得進度並組成 XML
HttpServletResponse response =
(HttpServletResponse) context.getExternalContext().getResponse();
response.setContentType("text/xml");
response.setHeader("Cache-Control", "no-cache");
try {
ResponseWriter writer = FacesUtils.setupResponseWriter(context);
writer.startElement("progress", input);
writer.startElement("percentage", input);
// 由過濾器寫入工作階段的進度百分比
Double progressCount = (Double) extContext.getSessionMap()
.get("FileUpload.Progress." + input.getClientId(context));
if (progressCount != null) {
writer.writeText(progressCount, null);
} else {
writer.writeText("1", null); // 尚未收到上傳
}
writer.endElement("percentage");
writer.startElement("clientId", input);
writer.writeText(input.getClientId(context), null);
writer.endElement("clientId");
writer.endElement("progress");
} catch (Exception e) {
// 錯誤記錄
}
} else {
// 正常的解碼請求
...
}
}
在正常解碼期間,檔案上傳產生器會從請求屬性中取出 FileItem(由過濾器事先設定),更新組件的數值綁定,並把工作階段中的進度設為 100%,讓頁面上的 JavaScript 得以把組件推進到第三階段。
if (requestMap.get(clientId).toString().equals("file")) {
try {
HttpServletRequest request = (HttpServletRequest) extContext.getRequest();
FileItem fileData = (FileItem) request.getAttribute(clientId);
if (fileData != null) input.setSubmittedValue(fileData);
// 清除與該項相關的進度狀態
extContext.getSessionMap().put(
"FileUpload.Progress." + input.getClientId(context), new Double(100));
} catch (Exception e) {
throw new RuntimeException("無法處理檔案上傳 - 請設定過濾器", e);
}
}
客戶端 JavaScript 負責向伺服器發出進度請求,並驅動組件在各階段之間移動。為了省去處理各家瀏覽器專屬 XMLHttpRequest 物件的麻煩,這裡選用 Matt Krause 提供的 AJaxRequest.js 函式庫,把需要撰寫的 JavaScript 降到最少。更理想的做法是把它打包成組件的一部分、由 PhaseListener 動態產生,但為了讓範例保持單純,這裡改成在 JSP 頁面中連結該函式庫。
組件的 getProgressBarJavaScript 方法負責產生 JavaScript。讓 JavaScript 正常運作通常是實作 Ajax 組件最棘手的部分,以下程式碼已盡量保持清楚:
function refreshProgress(){
// 假定正在進入階段 2
document.getElementById('fileUpload1_stage1').style.display = 'none';
document.getElementById('fileUpload1_stage2').style.display = '';
document.getElementById('fileUpload1_stage3').style.display = 'none';
AJaxRequest.post({
// 指定正確參數,讓組件在伺服器端能被正確處理
'parameters': {
'uploadForm': 'uploadForm',
'fileUpload1': 'fileUpload1',
'JSf.component.UIFileUpload': '1',
'AJax.abortPhase': '4' // 在 Phase 4 中止
},
'onSuccess': function(req) {
var xml = req.responseXML;
if (xml.getElementsByTagName('clientId').length == 0) {
setTimeout('refreshProgress()', 200); return;
}
var clientId = xml.getElementsByTagName('clientId')[0].firstChild.nodeValue
+ '_progressBar';
// 從 XML 取出百分比
var percentage =
xml.getElementsByTagName('percentage')[0].firstChild.nodeValue;
var innerSpans =
document.getElementById(clientId).getElementsByTagName('span');
document.getElementById(clientId + 'label').innerHTML =
Math.round(percentage) + '%';
// 依目前進度設定各 span 的樣式
for (var i = 0; i < innerSpans.length; i++) {
if (i < percentage) { innerSpans[i].className = 'active'; }
else { innerSpans[i].className = 'passive'; }
}
// 未達 100% 就繼續輪詢
if (percentage != 100) {
setTimeout('refreshProgress()', 400);
} else {
// 上傳完成,推進到階段 3
document.getElementById('fileUpload1_stage1').style.display = 'none';
document.getElementById('fileUpload1_stage2').style.display = 'none';
document.getElementById('fileUpload1_stage3').style.display = '';
}
}
});
}
希望本文能引發你對兩件事的思考:一是如何讓檔案上傳變得更友善,二是把 Ajax 與 JavaServer Faces 結合起來打造進階使用者介面組件的可能性。本文的方案確實偏長,也還有改進空間;建議搭配完整原始碼一起閱讀,會更容易理解其中討論的概念。