DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
從零打造一個真正可用的 Ajax 上傳進度條
編輯:AJAX詳解     

做過檔案上傳功能的人大概都遇過這種尷尬:使用者按下上傳,畫面一片死寂,瀏覽器只留一個轉圈的圖示,然後他就開始懷疑是不是當機了。我曾經做過一個 CSV 匯入功能,檔案大、解析慢,整道上傳加寫入資料庫下來要跑幾十分鐘,而這段期間頁面上什麼提示都沒有——使用者唯一能做的,就是不斷按重新整理。

問題不在伺服器不夠快,而在「沒有回饋」。既然瀏覽器端本來就能定時向伺服器要資料,那把「目前處理到哪裡」也一起要回來,進度條就成立了。以下分兩階段來做:先寫一個最小可運行的原型把機制跑通,再把它移植進真實專案。

第一階段:最簡單的進度條

核心邏輯只有一句話:客戶端每隔兩秒對伺服器發一次請求,拿回一個百分比數字,再用 JavaScript 去改一個 table 的寬度。table 寬了,看起來就像進度條在長大。

1. 前端頁面

progressBar.html 的骨架如下。這裡刻意用最原始的寫法,把每一個環節攤開來看:

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>Ajax Progress Bar</title>
    <script type="text/javascript">
      var XMLHttp;
      var key;

      function createXMLHttpRequest() {
          if (window.ActiveXObject) {
              xmlHttp = new ActiveXObject("Microsoft.XMLHTTP");
          } else if (window.XMLHttpRequest) {
              xmlHttp = new XMLHttpRequest();
          }
      }

      // 按下 run:啟動後台任務
      function go() {
          createXMLHttpRequest();
          clearBar();
          var url = "ProgressBarServlet?task=create";
          var button = document.getElementById("go");
          button.disabled = true;
          XMLHttp.open("GET", url, true);
          XMLHttp.onreadystatechange = goCallback;
          XMLHttp.send(null);
      }

      function goCallback() {
          if (XMLHttp.readyState == 4) {
              if (XMLHttp.status == 200) {
                  setTimeout("pollServer()", 2000);
              }
          }
      }

      // 輪詢:向伺服器要目前的百分比
      function pollServer() {
          createXMLHttpRequest();
          var url = "ProgressBarServlet?task=poll&key=" + key;
          XMLHttp.open("GET", url, true);
          XMLHttp.onreadystatechange = pollCallback;
          XMLHttp.send(null);
      }

      function pollCallback() {
          if (XMLHttp.readyState == 4) {
              if (XMLHttp.status == 200) {
                  var percent_complete =
                      xmlHttp.responseXML.getElementsByTagName("percent")[0]
                             .firstChild.data;

                  var progress        = document.getElementById("progress");
                  var progressPersent = document.getElementById("progressPersent");

                  progress.width = percent_complete + "%";
                  progressPersent.innerHTML = percent_complete + "%";

                  if (percent_complete < 100) {
                      setTimeout("pollServer()", 2000);
                  } else {
                      document.getElementById("complete").innerHTML = "Complete!";
                  }
              }
          }
      }

      function clearBar() {
          var progress_bar    = document.getElementById("progressBar");
          var progressPersent = document.getElementById("progressPersent");
          var complete        = document.getElementById("complete");
          progress_bar.style.visibility = "visible";
          progressPersent.innerHTML = "&nbsp;";
          complete.innerHTML = "Begin to upload this file...";
      }
    </script>
  </head>

  <body>
    <div id="progressBar"
         style="padding:0px;border:solid black 0px;visibility:hidden">
      <table width="300" border="0" cellspacing="0" cellpadding="0" align="center">
        <tr>
          <td align="center" id="progressPersent">0%</td>
        </tr>
        <tr>
          <td>
            <table width="100%" border="1" cellspacing="0" cellpadding="0"
                   bordercolor="#000000">
              <tr>
                <td>
                  <table width="1%" border="0" cellspacing="0" cellpadding="0"
                         bgcolor="#FF0000" id="progress">
                    <tr><td>&nbsp;</td></tr>
                  </table>
                </td>
              </tr>
            </table>
          </td>
        </tr>
        <tr>
          <td align="center" id="complete">completed</td>
        </tr>
      </table>
    </div>

    <input id="go" name="run" type="button" value="run" onClick="go();">
  </body>
</html>

兩個細節值得指出。其一,原範例把 innerHtml 當屬性用,正確的拼法是 innerHTML;其二,進度條的百分比文字與進度條本身用了兩個不同的 id(progressPersent 與 progress),只要保持一致就能運作,但命名上確實容易誤讀。

2. 模擬用的 Servlet

接下來是一個假後端。它只做兩件事:task=create 時送出工作識別碼並把計數器歸零;task=poll 時依計數器吐出一段遞增的 XML。

package com.cyberobject.lcl.Ajax;

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

public class ProgressBarServlet extends HttpServlet {
    private int counter = 1;

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String task = request.getParameter("task");
        String res = "";

        if (task.equals("create")) {
            res = "<key>1</key>";
            counter = 1;
        } else {
            String percent = "";
            switch (counter) {
                case 1: percent = "10";  break;
                case 2: percent = "23";  break;
                case 3: percent = "35";  break;
                case 4: percent = "51";  break;
                case 5: percent = "64";  break;
                case 6: percent = "73";  break;
                case 7: percent = "89";  break;
                case 8: percent = "100"; break;
            }
            counter++;

            res = "<percent>" + percent + "</percent>";
        }

        PrintWriter out = response.getWriter();
        response.setContentType("text/xml");
        response.setHeader("Cache-Control", "no-cache");
        out.println("<response>");
        out.println(res);
        out.println("</response>");
        out.close();
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }

    public String getServletInfo() {
        return "Ajax progress bar demo servlet";
    }
}

這裡的 counter 是 Servlet 的實例變數,也就是說它被所有工作共用。當多個使用者同時上傳時,兩邊的計數會互相干擾;原型階段無妨,正式環境必須把工作識別碼(key)與進度綁在一起,例如放進 Map 或改用工作物件本身來持有狀態。

3. 註冊 Servlet 對應

<!-- Action Servlet Mapping -->
<servlet>
  <servlet-name>ProgressBarServlet</servlet-name>
  <display-name>ProgressBarServlet</display-name>
  <servlet-class>com.cyberobject.lcl.Ajax.ProgressBarServlet</servlet-class>
</servlet>

<servlet-mapping>
  <servlet-name>ProgressBarServlet</servlet-name>
  <url-pattern>/ProgressBarServlet</url-pattern>
</servlet-mapping>

做到這裡,打開頁面按下 run,紅色條子就會一格一格長出來。機器的骨架已經通了,剩下的只是把假的百分比換成真的。

第二階段:移植到真實專案

真實場景裡,進度不是天上掉下來的數字,而是資料寫入流程走到哪裡的側影。因此要做的,是讓負責寫資料庫的那個類別自己記住進度,再讓 Servlet 把它讀出來。四個步驟:

1. 在寫資料庫的類別裡加一個進度屬性。

private int progress;

2. 對外提供讀取方法。

public int getProgress() {
    return progress;
}

3. 在寫入的迴圈裡讓它往前走。每處理完一批(或一筆)就遞增一次,這個「一批」的粒度會直接影響進度條的平滑度,通常取幾十到幾百筆一次比較合適。

progress++;

4. 讓 Servlet 把它讀出來餵給進度條。呼叫寫入類別的 getProgress(),換算成百分比後包進 XML 回傳,前端的 pollServer() 就能拿到即時數字。

最後一個容易被忽略的設計決定是職責分工:doGet() 專門回報進度,doPost() 專門負責上傳與寫入。兩條路徑各走各的,讀取進度不會意外觸發一次上傳,寫入任務也不會被輪詢的請求打斷。這條界線畫清楚之後,後續要加上「取消上傳」或「完成後自動導向結果頁」都容易得多。

幾個實務上的提醒

輪詢間隔兩秒是原型值,正式環境可依任務長度調整;間隔太短會讓伺服器被無效請求淹沒,太長則進度條看起來一頓一頓的。此外,若任務耗時很長,別忘了在後端加上逾時與錯誤狀態的回報,否則一旦例外發生,前端只會永遠停在某一格,而使用者無從判斷是卡住還是失敗了。

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