XMLHttpRequest：進度事件

基線 廣泛可用

此功能已建立良好，並在許多裝置和瀏覽器版本上執行。它從 2015 年 7 月.

報告反饋

注意： 此功能在 Web Worker 中可用，但 Service Worker 除外。

語法

progress 事件在請求收到更多資料時定期觸發。

在諸如 addEventListener() 之類的方法中使用事件名稱，或設定事件處理程式屬性。
addEventListener("progress", (event) => {});

onprogress = (event) => {};

事件型別

js

Event ProgressEvent

事件屬性

一個 ProgressEvent。繼承自 Event。

除了下面列出的屬性之外，父介面 Event 中的屬性也可用。

lengthComputable 只讀

一個布林標誌，指示基礎程序要完成的總工作量和已完成的工作量是否可計算。換句話說，它表示進度是否可衡量。

loaded 只讀

一個 64 位無符號整數，指示基礎程序已完成的工作量。已完成的工作量可以透過將此屬性的值除以 total 來計算。當使用 HTTP 下載資源時，這僅計算 HTTP 訊息的正文，不包括標題和其他開銷。

total 只讀

示例

一個 64 位無符號整數，表示基礎程序正在執行的總工作量。當使用 HTTP 下載資源時，這就是 Content-Length（訊息正文的大小），不包括標題和其他開銷。

HTML

即時示例
<div class="controls">
  <input
    class="xhr success"
    type="button"
    name="xhr"
    value="Click to start XHR (success)" />
  <input
    class="xhr error"
    type="button"
    name="xhr"
    value="Click to start XHR (error)" />
  <input
    class="xhr abort"
    type="button"
    name="xhr"
    value="Click to start XHR (abort)" />
</div>

<textarea readonly class="event-log"></textarea>

JavaScript

在諸如 addEventListener() 之類的方法中使用事件名稱，或設定事件處理程式屬性。
const xhrButtonSuccess = document.querySelector(".xhr.success");
const xhrButtonError = document.querySelector(".xhr.error");
const xhrButtonAbort = document.querySelector(".xhr.abort");
const log = document.querySelector(".event-log");

function handleEvent(e) {
  log.textContent = `${log.textContent}${e.type}: ${e.loaded} bytes transferred\n`;
}

function addListeners(xhr) {
  xhr.addEventListener("loadstart", handleEvent);
  xhr.addEventListener("load", handleEvent);
  xhr.addEventListener("loadend", handleEvent);
  xhr.addEventListener("progress", handleEvent);
  xhr.addEventListener("error", handleEvent);
  xhr.addEventListener("abort", handleEvent);
}

function runXHR(url) {
  log.textContent = "";

  const xhr = new XMLHttpRequest();
  addListeners(xhr);
  xhr.open("GET", url);
  xhr.send();
  return xhr;
}

xhrButtonSuccess.addEventListener("click", () => {
  runXHR(
    "https://raw.githubusercontent.com/mdn/content/main/files/en-us/_wikihistory.json",
  );
});

xhrButtonError.addEventListener("click", () => {
  runXHR("http://i-dont-exist");
});

xhrButtonAbort.addEventListener("click", () => {
  runXHR(
    "https://raw.githubusercontent.com/mdn/content/main/files/en-us/_wikihistory.json",
  ).abort();
});

html

規範

結果
規範
# XMLHttpRequest 標準
規範
# event-xhr-progress

瀏覽器相容性

handler-xhr-onprogress

另請參見