Как получить прогресс от XMLHttpRequest

Возможно ли получить прогресс XMLHttpRequest (байты загружены, байты загружены)?

Это было бы полезно для отображения индикатора выполнения, когда пользователь загружает большой файл. Стандартный API, похоже, не поддерживает его, но, может быть, в любом из браузеров есть какое-то нестандартное расширение? В конце концов, это кажется довольно очевидной функцией, поскольку клиент знает, сколько байтов было загружено / загружено.

примечание: я знаю об альтернативе «опросить сервер на предмет прогресса» (это то, чем я сейчас занимаюсь). Основная проблема с этим (кроме сложного кода на стороне сервера) заключается в том, что обычно при загрузке большого файла соединение пользователя полностью закрывается, потому что большинство интернет-провайдеров предлагают плохой исходящий поток. Таким образом, дополнительные запросы не так оперативны, как я надеялся. Я надеялся, что будет способ (возможно, нестандартный) получить эту информацию, которая всегда есть в браузере.


person Community    schedule 16.09.2008    source источник


Ответы (7)


Для загруженных байтов это довольно просто. Просто следите за событием xhr.upload.onprogress. Браузер знает размер файлов, которые он должен загрузить, и размер загружаемых данных, поэтому он может предоставить информацию о ходе выполнения.

Для загруженных байтов (при получении информации с помощью xhr.responseText) это немного сложнее, потому что браузер не знает, сколько байтов будет отправлено в запросе сервера. Единственное, что в этом случае знает браузер, - это размер получаемых байтов.

Для этого есть решение, достаточно установить заголовок Content-Length в сценарии сервера, чтобы получить общий размер байтов, которые браузер собирается получить.

Дополнительные сведения см. На странице https://developer.mozilla.org/en/Using_XMLHttpRequest.

Пример: мой серверный скрипт читает zip-файл (это занимает 5 секунд):

$filesize=filesize('test.zip');

header("Content-Length: " . $filesize); // set header length
// if the headers is not set then the evt.loaded will be 0
readfile('test.zip');
exit 0;

Теперь я могу отслеживать процесс загрузки серверного скрипта, потому что знаю его общую длину:

function updateProgress(evt) 
{
   if (evt.lengthComputable) 
   {  // evt.loaded the bytes the browser received
      // evt.total the total bytes set by the header
      // jQuery UI progress bar to show the progress on screen
     var percentComplete = (evt.loaded / evt.total) * 100;  
     $('#progressbar').progressbar( "option", "value", percentComplete );
   } 
}   
function sendreq(evt) 
{  
    var req = new XMLHttpRequest(); 
    $('#progressbar').progressbar();    
    req.onprogress = updateProgress;
    req.open('GET', 'test.php', true);  
    req.onreadystatechange = function (aEvt) {  
        if (req.readyState == 4) 
        {  
             //run any callback here
        }  
    };  
    req.send(); 
}
person Community    schedule 12.09.2010
comment
Стоит отметить, что Content-Length не является приблизительной длиной, она должна быть точной длиной, слишком короткой, и браузер будет отключать загрузку, слишком долго, и браузер будет считать, что загрузка не была завершена. - person Chris Chilvers; 05.09.2012
comment
@ChrisChilvers Это означает, что файл PHP может быть неправильно рассчитан, верно? - person Klaider; 20.08.2016
comment
@nicematt в этом примере было бы хорошо, поскольку он исходит из файла, но если бы вы передавали zip прямо из памяти, вы не могли бы просто составить длину контента или оценить ее. - person Chris Chilvers; 22.08.2016
comment
@TheProHands Когда вы посещаете страницу .php, сервер запускает файл PHP и отправляет вам свой вывод. Сервер должен отправлять длину вывода, а не файл .php. - person leewz; 11.10.2016
comment
Может кто-нибудь объяснить, что такое строка $ ('# progressbar'). Progressbar (option, value, percentComplete); средства? Это вызывает определенный плагин? Как это работает? Пожалуйста, сделайте ответ понятным для новых пользователей. - person Zac; 21.06.2017
comment
@Zac Это просто панель прогресса jQueryUi, показывающая прогресс в пользовательском интерфейсе от 0% до 100%. - person albanx; 21.06.2017
comment
@albanx Спасибо. Не могли бы вы указать, какие файлы CSS нужно импортировать для использования этой панели управления? Спасибо - person Zac; 21.06.2017

Firefox поддерживает события выполнения загрузки XHR.

ИЗМЕНИТЬ 2021-07-08 10:30 PDT

Ссылка выше мертва. При поиске на сайте Mozilla WebDev была обнаружена следующая ссылка:

https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent

В нем описывается, как использовать событие прогресса с XMLHttpRequest, и приводится пример. Я привел пример ниже:

var progressBar = document.getElementById("p"),
    client = new XMLHttpRequest()
client.open("GET", "magical-unicorns")
client.onprogress = function(pe) {
  if(pe.lengthComputable) {
    progressBar.max = pe.total
    progressBar.value = pe.loaded
  }
}
client.onloadend = function(pe) {
  progressBar.value = pe.loaded
}
client.send()

Я также нашел эту ссылку, на которую, я думаю, указывала исходная ссылка.

https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/progress_event

person Community    schedule 29.07.2010
comment
Ссылка не работает, и ответ больше ничего не дает. - person tforgione; 07.03.2021
comment
@tforgione Это был не мой ответ. Однако я просто исправил это. Наслаждаться. - person Daniel Rudy; 09.07.2021

Один из наиболее многообещающих подходов - это открытие второго канала связи с сервером, чтобы спросить его, какая часть передачи была завершена.

person Sean McMains    schedule 16.09.2008

Для всего загруженного, похоже, нет способа справиться с этим, но есть что-то похожее на то, что вы хотите для загрузки. Когда для параметра readyState установлено значение 3, вы можете периодически запрашивать responseText, чтобы получить весь контент, загруженный в виде String (это не работает в IE), до тех пор, пока все это не станет доступным, после чего он перейдет в состояние readyState 4. Итого байты, загруженные в любой момент времени, будут равны общему количеству байтов в строке, хранящейся в responseText.

Для подхода «все или ничего» к вопросу о загрузке, поскольку вы должны передать строку для загрузки (и можно определить ее общее количество байтов), общее количество байтов, отправленных для readyState 0 и 1, будет равно 0, а общее количество для readyState 2 будет общим количеством байтов в строке, которую вы передали. Общее количество байтов, отправленных и полученных в readyState 3 и 4, будет суммой байтов в исходной строке плюс общее количество байтов в responseText.

person Orclev    schedule 16.09.2008

<!DOCTYPE html>
<html>
<body>
<p id="demo">result</p>
<button type="button" onclick="get_post_ajax();">Change Content</button>
<script type="text/javascript">
	function update_progress(e)
	{
	  if (e.lengthComputable)
	  {
	    var percentage = Math.round((e.loaded/e.total)*100);
	    console.log("percent " + percentage + '%' );
	  }
	  else 
	  {
	  	console.log("Unable to compute progress information since the total size is unknown");
	  }
	}
	function transfer_complete(e){console.log("The transfer is complete.");}
	function transfer_failed(e){console.log("An error occurred while transferring the file.");}
	function transfer_canceled(e){console.log("The transfer has been canceled by the user.");}
	function get_post_ajax()
	{
	  	var xhttp;
	  	if (window.XMLHttpRequest){xhttp = new XMLHttpRequest();}//code for modern browsers} 
	 	else{xhttp = new ActiveXObject("Microsoft.XMLHTTP");}// code for IE6, IE5	  	
	  	xhttp.onprogress = update_progress;
		xhttp.addEventListener("load", transfer_complete, false);
		xhttp.addEventListener("error", transfer_failed, false);
		xhttp.addEventListener("abort", transfer_canceled, false);	  	
	  	xhttp.onreadystatechange = function()
	  	{
	    	if (xhttp.readyState == 4 && xhttp.status == 200)
	    	{
	      		document.getElementById("demo").innerHTML = xhttp.responseText;
	    	}
	  	};
	  xhttp.open("GET", "http://it-tu.com/ajax_test.php", true);
	  xhttp.send();
	}
</script>
</body>
</html>

Результат

person Community    schedule 29.01.2016

Если у вас есть доступ к вашей установке apache и вы доверяете стороннему коду, вы можете использовать модуль прогресса загрузки apache (если вы используете apache; есть также модуль прогресса загрузки nginx).

В противном случае вам придется написать сценарий, который вы можете нажать вне диапазона, чтобы запросить статус файла (например, проверяя размер файла tmp).

В Firefox 3 ведется некоторая работа по добавлению поддержки процесса загрузки в браузер, но это не войдет во все браузеры и не получит широкого распространения в течение некоторого времени (жаль больше).

person Aeon    schedule 16.09.2008

Единственный способ сделать это с помощью чистого javascript - реализовать какой-то механизм опроса. Вам нужно будет отправлять запросы ajax через фиксированные интервалы (например, каждые 5 секунд), чтобы получить количество байтов, полученных сервером.

Более эффективным способом было бы использовать вспышку. Компонент Flex FileReference периодически отправляет "прогресс" событие, содержащее количество уже загруженных байтов. Если вам нужно придерживаться javascript, существуют мосты между ActionScript и javascript. Хорошая новость в том, что эта работа уже сделана за вас :)

swfupload

Эта библиотека позволяет зарегистрировать обработчик javascript для события выполнения flash.

Это решение имеет существенное преимущество в том, что не требует дополнительных ресурсов на стороне сервера.

person Alexandre Victoor    schedule 16.09.2008