Крейн Д., Паскарелло Э., Джеймс Д,. AJAX в действии / Ajax в действии / ajinact / Ajax в действии
.pdf
Глава 2. Знакомство с Ajax |
85 |
Рис. 2.5. Последовательность событий, возникающих при асинхронном взаимодействии документа с сервером. В результате действий пользователя формируется асинхронный запрос серверу от скрытого объекта (IFrame или XMLHttpRequest) . Метод очень быстро возвращает управление, блокируя интерфейс лишь на короткий период времени (этот интервал выделен серым цветом). Функция обратного вызова осуществляет разбор ответа сервера и затем обновляет пользовательский интерфейс
и делать его невидимым, открывает большие возможности в создании пользовательских интерфейсов. Так, например, данные можно загружать в фоновом режиме, не затрагивая остальных элементов Web-страницы. По сути, это способ асинхронного взаимодействия с сервером, правда, пользоваться им несколько неудобно. На рис. 2.5 показана последовательность событий, типичная для данного подхода.
Подобно другим элементам DOM, IFrame можно объявить в составе HTML-кода страницы либо сгенерировать программно, вызвав document . createElement (). В простых ситуациях, когда нам нужен один невидимый элемент IFrame для загрузки данных, мы можем объявить его как часть документа и получить доступ к нему из программы, вызвав document. getElementByld(), как показано в листинге 2.6.
Листинг 2.6. Использование элемента IFrame
<html>
<head>
<script type='text/javascript'> window.onload=function(){
var iframe=document.getElementById('dataFeed') ; var src='datafeeds/mydata.xml'; loadDataAsynchronously(iframe,src) ;
f u n c t i o n l o a d D a t a A s y n c h r o n o u s l y ( i f r a m e , s r c ) {
86 Часть I. Новый взгляд на Web-приложение
// Выполнение требуемых действий
}
</ s c r i p t > </head> <body>
<! — Отображаемые данные — > <iframe
i d = ' d a t a F e e d '
s t y l e = ' h e i g h t : O p x ; w i d t h : O p x ; '
>
</iframe>
</body>
</html>
Сделать элемент IFrame невидимым можно, установив для него нулевую ширину и высоту. Можно также использовать стиль display:none, но некоторые браузеры в этом случае оптимизируют свою работу и не загружают документ. Заметьте, что перед обращением к IFrame надо дождаться окончания загрузки документа, т.е. вызов getElementByldO следует поместить в обработчик window, onload. Можно также генерировать элементы IFrame из программы, как показано в листинге 2.7. В этом случае весь код, связанный с передачей запроса, находится в одном месте, и нет необходимости указывать уникальный идентификатор узла DOM и согласовывать его в сценарии и HTML-файле.
Листинг 2.7. Создание элемента IFrame
function fetchData(){
var iframe=document.createElement('iframe') ; iframe.className='hiddenDataFeed' ; document.body.appendChild(iframe);
var src='datafeeds/mydata.xml'; loadDataAsynchronously(iframe,src);
Методы createElement и appendChild, используемые для модификации структуры DOM, уже знакомы вам по предыдущим примерам. Если мы будем не задумываясь применять данный подход в процессе работы приложения, то получим большое число элементов IFrame. Необходимо удалять их по завершении работы или формировать пул элементов.
Образы разработки, которые мы рассмотрим в главе 3, помогут вам в реализации пулов, очередей и других структур, которые могут быть использованы для масштабных приложений. Эти вопросы мы рассмотрим несколько позже, а сейчас перейдем к следующему набору технологий, используемых для формирования асинхронных запросов к серверу.
2.5.2. Объекты XmlDocument и XMLHttpRequest
Элементы IFrame можно использовать для получения данных в асинхронном режиме, но сделать это достаточно сложно, так как изначально они были
Глава 2. Знакомство c Ajax |
87 |
созданы для другой цели. В последних версиях популярных Web-браузеров реализованы специальные объекты, предназначенные для асинхронной передачи данных. Они обеспечивают ряд преимуществ по сравнению с элементами IFrame.
Объекты XmlDocument и XMLHttpRequest, хотя и представляют собой нестандартные расширения DOM, поддерживаются большинством браузеров. Поскольку они специально разработаны для фоновой загрузки данных, с их помощью удобно осуществлять асинхронные вызовы. Оба объекта сначала были реализованы как компоненты ActiveX, доступные в браузере Internet Explorer посредством JavaScript. Для других браузеров были реализованы объекты, обеспечивающие те же возможности. Объекты XmlDocument и XMLHttpRequest предоставляют приблизительно одинаковые возможности, но XMLHttpRequest обеспечивает более полный контроль над запросом. Именно его мы будем в основном использовать в данной книге, но уделим внимание и объекту XmlDocument, чтобы вы смогли оценить его и сравнить с объектом XMLHttpRequest. В листинге 2.8 показан код простой функции, которая создает объект XmlDocument.
Листинг 2.8. Функция getXMLDocument ()
function getXMLDocument(){
var xDoc=null;
if (document.implementation
S & document.implementation.createDocument){ xDoc=document.implementation
// Mozilla/Safari
.createDocument("","",null);
}else if (typeof ActiveXObject != "undefined"){ var msXmlAx==null;
try{
msXmlAx=new ActiveXObject
// Последние версии Internet Explorer ("Msxml2.DOMDocument");
}catch (e){
msXmlAx=new ActiveXObject
// Старые версии Internet Explorer ("Msxml.DOMDocument");
xDoc=msXmlAx; |
|
} |
|
if (xDoc==null M typeof xDoc.load=="undefined"){ |
|
xDoc=null; |
|
} |
|
return xDoc; |
|
__} |
__• |
Данная функция возвращает объект XmlDocument с API, идентичным для большинства современных браузеров. Однако способы создания документа могут существенно различаться.
88 Часть I. Новый взгляд на Web-приложение
Функция проверяет, предоставляет ли объект документа возможности, необходимые для создания объекта XmlDocument (подобные средства имеются в последних версиях браузеров Mozilla и Safari). Если необходимые средства не предоставляются, функция пытается обратиться к объектам ActiveX и проверяет, поддерживаются ли они (такая поддержка реализована только в браузерах производства Microsoft). Если проверка дает положительный результат, функция пытается извлечь требуемый объект. Предпочтение отдается библиотекам MSXML версии 2.
На заметку Из программы можно запросить информацию о производителе браузера и номер версии продукта. Очень часто таким образом производится настройка кода на конкретный тип браузера. На наш взгляд, подобный подход чреват ошибками. Кроме того, таким образом невозможно предусмотреть работу с более новыми версиями браузеров. В нашей функции getXmlDocument () мы не пытаемся узнать версию клиентской программы, а непосредственно выясняем, доступен ли конкретный объект. Такой подход, называемый обнаружением объектов (object detection), увеличивает вероятность того, что программа будет нормально работать с последующими версиями браузеров и теми браузерами, наличие которых мы не учли при написании программы.
В листинге 2.9 показана функция, подобная предыдущей, но ориентированная на объект XMLHttpRequest.
ЛИСТИНГ 2.9. Функция getXMLHTTPRequest ()
function getXMLHTTPRequest() |
{ |
|
var |
xRequest=null; |
|
if |
(window.XMLHttpRequest) |
{ |
// |
Mozilla/Safari |
|
xRequest=new XMLHttpRequest();
}else if (typeof ActiveXObject != "undefined"){ xRequest=new ActiveXObject
// Internet Explorer ("Microsoft.XMLHTTP");
return xRequest;
Здесь мы также используем принцип обнаружения объектов, чтобы про: - верить, поддерживается ли XMLHttpRequest. Если проверка дает отрицательный результат, мы пытаемся обратиться к ActiveX. Если браузер не предоставляет ни одну из проверяемых возможностей, функция возвращает значение null. О более детальной обработке отрицательного результата проверки речь пойдет в главе 6.
Итак, мы можем создать объект, который передает запросы серверу. Попробуем использовать его.
Глава 2. Знакомство с Ajax 89
2.5.3.Передачазапросасерверу
Объект XMLHttpRequest позволяет без труда передать запрос серверу. Все, что надо для этого, — это указать URL серверного ресурса, который должен сгенерировать необходимые данные. Ниже представлена функция, которая решает эту задачу.
function sendRequest(url,params,HttpMethod){ if (IHttpMethod){
HttpMethod="POST";}
var req=getXMLHTTPRequest(); if (req){ req.open(HttpMethod,url,true); req.setRequestHeader
("Content-Type", "application/x-www-form-urlencoded"); req.send(params);
}
}
Объект XMLHttpRequest предоставляет широкий спектр возможностей для работы с протоколом HTTP, в том числе позволяет указывать строку параметров для динамически генерируемых документов. (Эти параметры обрабатываются CGI-сценарием, объектом ServletRequest или другой серверной программой.) Рассмотрим основы протокола HTTP, а затем поговорим о том, как объект, передающий запросы серверу, работает с ним.
Общие сведения о протоколе HTTP
Протокол HTTP настолько привычен, что мы часто забываем о его существовании. При написании классических Web-приложений наши действия с данным протоколом ограничиваются определением гипертекстовых ссылок и, возможно, установкой атрибута method формы. Ajax, напротив, предоставляет разработчикам доступ к низкоуровневым средствам работы с протоколом HTTP, использование которых открывает удивительные возможности.
HTTP-транзакция представляет собой запрос браузера, за которым следует ответ сервера. (Конечно, в процессе обработки запроса, помимо стандартных серверных средств, могут участвовать сложные программы, написанные нами, Web-разработчиками.) И запрос, и ответ передаются в текстовом виде; каждый из них состоит из заголовка, за которым следует тело запроса или ответа. Заголовок можно условно представить себе как адрес, написанный на конверте, а тело запроса или ответа — как содержащееся внутри письмо. Заголовки указывают принимающей стороне на то, что надо сделать с остальными данными.
HTTP-запрос чаще всего состоит из одного заголовка, однако в некоторых случаях за ним могут следовать данные. В составе ответа обычно содержится HTML-код страницы, указанной в запросе. С браузерами Mozilla поставляется полезная утилита под названием LiveHTTPHeaders (см. ссылки в конце данной главы и приложение А). Она позволяет просматривать заголовки запросов и ответов в процессе работы браузера. Загрузим исходную страницу Google и посмотрим, что произойдет при этом.
90 Часть I. Новый взгляд на Web-приложение
Переданный нами запрос содержит следующий заголовок:
GET / HTTP/1.1
Host: www.google.com User-Agent: Mozilla/5.0
(Windows; U; Windows NT 5.0; en-US; rv:1.7) Gecko/20040803 Firefox/0.9.3
Accept: text/xml,application/xml, application/xhtml+xml,text/html;q=0.9, text/plain;q=O.8,image/png,*/*;q=0.5 Accept-Language: en-us,en;q=0.5 Accept-Encoding: gzip,deflate
Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7 Keep-Alive: 300
Connection: keep-alive
Cookie: PREF=ID=cabd38877dc0b6al:TM=1116601572 :LM=1116601572:S=GD3SsQk3v0adtSBP
Первая строка заголовка сообщает о том, какой HTTP-метод должен быть использован. Большинство разработчиков Web-приложений знакомы с запросами GET и POST. Запрос GET используется для загрузки документов, a POST чаще всего применяется для передачи на сервер данных, введенных посредством HTML-форм. В спецификации, разработанной W3C (World Wide Web Consortium), предусмотрены и другие методы, в частности, HEAD, который загружает только заголовок; PUT, предназначенный для передачи документов на сервер; и DELETE, посредством которого можно удалять документы. За первой строкой следуют поля заголовка, с помощью которых клиент сообщает серверу тип данных, находящихся в теле запроса, используемые наборы символов и другие сведения. Поскольку мы не впервые посещаем узел Google, в составе запроса передается также запись cookie — короткое сообщение с информацией о клиенте.
Заголовок ответа выглядит подобно приведенному ниже.
HTTP/1.x 302 Found
Location: http://www.google.co.uk/cxfer?c=PREF%3D: TM%3D1116601572:S%3DzFxPsBpXhZzknVMF&prev=/
Set-Cookie: PREF=ID=cabd38877dc0b6al:CR=1:TM=1116601572: LM=1116943140:S=fRfhD-u49xp9UE18;
expires=Sun, 17-Jan-2038 19:14:07 GMT; path=/; domain=.google.com Content-Type: text/html
Server: GWS/2.1 Transfer-Encoding: chunked Content-Encoding: gzip
Date: Tue, 24 May 2005 17:59:00 GMT Cache-Control: private, x-gzip-ok=""
Первая строка сообщает статус ответа. Код 302 означает перенаправление на другую страницу. В составе ответа мы получаем запись cookie для текущего сеанса, а также тип содержимого запроса (MIME-тип). Следующий запрос формируется потому, что в ответе содержится код перенаправления. На него будет получен ответ со следующим заголовком:
HTTP/l.x 200 ОК
C a c h e - C o n t r o l : p r i v a t e
Глава 2. Знакомство cAjax |
91 |
C o n t e n t - T y p e: t e x t / h t m l
C o n t e n t - E n c o d i n g : g z i p
S e r v e r : |
GWS/2.1 |
C o n t e n t - L e n g t h : 1196 |
|
D a t e : |
Tue, 24 May 2005 17:59:00 GMT |
Код состояния 200 означает успешную обработку, а в тело ответа включается код исходной страницы Google, предназначенной для отображения в окне браузера. Поле заголовка content-type сообщает браузеру о том, что данные представлены в формате HTML.
В рассмотренной выше функции sendRequest второй и третий параметры в большинстве случаев можно не указывать. По умолчанию для получения ресурса используется метод POST, причем параметры в теле запроса отсутствуют.
После передачи запроса функция сразу возвращает управление, не дожидаясь, пока запрос будет доставлен по сети серверу, а тот передаст ответ. Это хорошо с точки зрения интерактивного взаимодействия с пользователем, но как мы узнаем, что запрос уже обработан?
2.5.4. Использование фуниции обратного вызова для контроля запроса
Вторая часть решения задачи асинхронного взаимодействия — формирование в составе кода точки повторного входа, которая нужна для получения результатов обработки запроса. Обычно для этой цели используется функция обратного вызова — фрагмент кода, получающий управление тогда, когда результаты уже готовы. Так, функцией обратного вызова является уже знакомая нам window.onload.
Функции обратного вызова применяются в программах, управляемых событиями (именно по такому принципу и созданы пользовательские интерфейсы большинства приложений). Пользователь может нажать клавишу, щелкнуть мышью и выполнить другие действия в произвольный момент времени. Программист обеспечивает реакцию программы на эти действия путем написания соответствующих функций обратного вызова. Создавая JavaScript-код обработки событий, мы используем onkeypress, onmouseover и другие подобные свойства объекта. При написании кода функции обратного вызова мы применяем свойства onload и onreadystatechange.
Функцию обратного вызова onreadystatechange поддерживают браузеры Internet Explorer и Mozilla, поэтому мы будем использовать именно ее. (Браузер Mozilla также поддерживает функцию onload, которая более проста в использовании.) Несложный код обработчика, действующего по принципу обратного вызова, показан в листинге 2.10.
Листинг 2.10. Обработчик, работающий по принципу обратного вызова
var READY_STATE_UNINITIALIZED=O; var READY_STATE_LOADING=1;
var READY_STATE_LOADED=2;
var READY_STATE_INTERACTIVE=3; var READY_STATE_COMPLETE=4;
92 Часть I. Новый взгляд на Web-приложение
var req;
function sendRequest(url,params,HttpMethod){ if (!HttpMethod){
HttpMethod="GET";
}
req=getXMLHTTPRequest(); if (req){
req.onreadystatechange=onReadyStateChange;
req.open(HttpMethod,url,true);
req.setRequestHeader
("Content-Type", "application/x-www-form-urlencoded"); req.send(params);
}
}
function onReadyStateChange(){ var ready=req.readyState; var data=null;
i f (ready==READY_STATE_COMPLETE){ data=req.responseText;
}else{ data="loading...["+ready+"]";
}
II... выполнение действий с данными ...
.
Здесь мы изменили код функции sendRequest (), а именно сообщили объекту запроса о наличии обработчика. Кроме того, мы определили функцию обработчика. Чтобы не тратить время на придумывание имени, мы назвали ее onReadyStateChange().
Свойство readyState получает числовые значения. Чтобы упростить восприятие программы, мы определили для каждого из этих значений символьное имя. В данный момент нас интересует только значение 4, соответствующее завершению обработки запроса.
Заметьте, что объект запроса объявлен как глобальная переменная. Сейчас это упрощает работу с объектом XMLHttpRequest, но впоследствии, когда нам надо будет передавать несколько запросов одновременно, такое решение может стать источником проблем. Выход из этой ситуации мы покажем в разделе 3.1. А сейчас пришло время собрать воедино все фрагменты программы поддержки запроса к серверу.
2.5.5. Жизненный цикл процедуры поддержки запроса
Теперь мы имеем достаточно информации для того, чтобы полностью описать жизненный цикл процедуры загрузки документа. Полный код HTMLстраницы, содержащей JavaScript-программу, приведен в листинге 2.11. Мы создаем экземпляр объекта XMLHttpRequest, сообщаем ему о том, что необходимо загрузить документ, а затем управляем процессом загрузки, используя функцию обратного вызова. В данном простом примере определяется узел DOM с идентификатором console, в который помещается информация о состоянии запроса.
Глава 2. Знакомство с Ajax 93
Листинг 2.11. Загрузка документа с использованием объекта XMLHTTPRequest
<html>
<head>
<script type='text/javascript'> var req=null;
var console=null;
var READY_STATE_UNINITIALIZED=O; var READY_STATE_LOADING=1 ;
var READY_STATE_L0ADED=2 ;
var READY_STATE_INTERACTIVE=3; var READY_STATE_COMPLETE=4;
function sendRequest(url,params,HttpMethod){ if (!HttpMethod){
HttpMethod="GET";
}
req=initXMLHTTPRequest() ; if (req){
req.onreadystatechange=onReadyState;
req.open(HttpMethod,url,true);
req.setRequestHeader
("Content-Type", "application/x-www-form-urlencoded"); req.send(params);
}
}
function initXMLHTTPRequest(){ var xRequest=null;
// Инициализация объекта запроса if (window.XMLHttpRequest){ xRequest=new XMLHttpRequest();
} else if (window.ActiveXObject){ xRequest=new ActiveXObject ("Microsoft.XMLHTTP");
}
return xRequest;
}
// Определение обработчика обратного вызова function onReadyState(){
var ready=req.readyState; var data=null;
// Проверка readyState
i f (ready==READY_STATE_COMPLETE){ // Чтение данных ответа data=req.responseText;
}else{ data="loading...["+ready+"]";
}
toConsole(data);
}
function toConsole(data){ if (console!=null){
var newline=document.createElement("div"); console.appendChild(newline) ;
var txt=document.createTextNode(data) ; newline.appendChild(txt) ;
}
94 Часть I. Новый взгляд на Web-приложение
window.onload=function(){ console=document.getElementById('console1) sendRequest("data.txt");
}
</script>
</head>
<body>
<div id='console'X/div> </body>
</html>
Рассмотрим выходные данные программы, полученные с помощью Microsoft Internet Explorer и Mozilla Firefox. Заметьте, что последовательности состояний readyState отличаются, но конечные результаты совпадают. Важно помнить, что промежуточные состояния readyState различаются в разных браузерах (и даже в различных версиях одного и того же браузера). Ниже показаны выходные данные, полученные с помощью Microsoft Internet Explorer.
loading...[1] loading...[1] loading...[3]
Here is some text from the server!
Каждая строка соответствует активизации функции обратного вызова. В процессе загрузки документа она вызывается дважды для различных фрагментов данных, затем еще раз в состоянии READY_STATE_INTERACTIVE (В случае синхронного запроса на этом этапе управление можно вернуть пользовательскому интерфейсу). Последний вызов соответствует завершению загрузки; текст ответа сервера можно отображать в окне браузера.
Теперь рассмотрим данные, полученные посредством Mozilla Firefox 1.0.
loading...[1] loading...[1] loading...[2] loading...[3]
Here is some text from the server!
Последовательность вызовов похожа на предыдущую, но имеет место дополнительный вызов, при котором значение readyState равно 2.
В данном примере мы получаем ответ в текстовом виде, используя для этой цели свойство aresponseText объекта XMLHttpRequest. Такой подход хорошо подходит для простых данных, но если сервер должен возвратить большой объем структурированной информации, лучше использовать свойство responseXML. Если ответ соответствует MIME-типу text/xml, будет получена структура DOM, которую можно опрашивать посредством свойств и функций, таких как getElementByld и childNodes, которые упоминались в разделе 2.4.1.
Мы рассмотрели основные "строительные блоки" Ajax, каждый из которых предоставляет полезные возможности, но реально мощность Ajax проявляется лишь при их объединении в единое целое.