Ajax в действии

Вэтой главе...

•Опережающий ввод

•Кэширование результатов поиска на стороне клиента

•Библиотека Rico

•Библиотека Prototype

•Функция JavaScript apply ()

•Параметризация компонентов

Опережающий ввод является одной из основных сфер применения Ajax благодаря которым эта инфраструктура заняла свое место в мире программирования. Возможности Google Suggest впечатляют пользователей, обнаруживающих список предположительных вариантов того, что они набирают (и даже сейчас, спустя много месяцев, эта возможность все еще активно обсуждается). Действие этого приложения подобно работе помощника, сидящего рядом с вами и подсказывающего, что вам нужно. Одни люди думают что предлагаемые значения хранятся на странице, другие полагают, что для получения данных применяется скрытый элемент IPrame. В действительности Google для извлечения новых значений после нажатия каждой клавиши использует объект XMLHttpRequest.

В этой главе вы узнаете, как отправлять запросы Ajax в то время, как пользователь что-то набирает. Кроме того, мы исследуем недостатки доступных реализаций опережающего ввода и определим, как избежать их в нашем приложении. Для начала мы примем понятный низкоуровневый подход. После того как наше приложение заработает, мы перейдем на высокий уровень и используем объектно-ориентированный подход, предлагающий большую гибкость и практичность. Однако, прежде чем мы приступим к созданию приложения, давайте рассмотрим некоторые типичные составляющие опережающего ввода и определим, как мы будем разрабатывать приложение, чтобы максимально использовать их.

10.1.Изучаем опережающий ввод

Сростом популярности инфраструктуры Ajax одной из самых модных сфер ее применения стал опережающий ввод. Сценарии, заранее предлагающие варианты набираемого текста, писали многие люди, реализовывавшие различные варианты взаимодействия с сервером. Одни решения имели свои недостатки, другие подходы были чересчур агрессивными. Чтобы получить общее представление о данном вопросе, вначале оценим ряд функциональных возможностей, реализованных во многих приложениях упреждающих предположений, а затем кратко рассмотрим Google Suggest. После этого мы разработаем свое приложение.

10.1.1. Типичные элементы приложений опережающего ввода

В настоящее время существует множество приложений опережающего ввода — от простейших до достаточно сложных. Все они преследуют одну цель, просто в некоторых реализованы более модные интерфейсы с затухающими переходами. Введите в какой-либо поисковой программе "type-ahead suggest Ajax" — и вы получите приличное число результатов.

Изучив несколько представителей данного множества, можно заметить, что все они построены примерно по одной схеме.

Таблица 10.1. Проблемы приложений опережающего ввода

П^блема Результат

Пообработка на сервере Чрезмерное потребление полосы пропускания. Представьте,

1.Вы набираете символ.

2.Приложение отправляет запрос на сервер.

3.Данные возвращаются клиенту.

4.Клиент принимает данные и отображает результаты в таблице, элементе div, текстовом окне и т.п.

Тем не менее существуют моменты, в которых некоторые сценарии проявляют себя не лучшим образом. Разработчикам следует учитывать ширину полосы пропускания, пропускную способность сервера, а также конфигурацию клиента. Если вы забудете об этих факторах, использование Ajax может вызвать отрицательную реакцию пользователя (а нужна положительная).. Возможные проблемы, довольно распространенные в приложениях Ajax, перечислены в табл. 10.1.

Разработчики, как правило, забывают о полосе пропускания. Даже один

и число запросов в секунду станет даже больше, чем в приложениях, не использующих Ajax.

Наличие оперативного интерфейса также очень важно. Чем больше времени уходит на визуализацию средств управления, тем позже пользователь их увидит и тем менее эффективным будет приложение. Кроме того, возможны задержки в работе, из-за завышенной нагрузки на сервер. Если запросы формируются слишком часто или возвращают чересчур много данных, пострадает оперативность пользовательского интерфейса.

Рис. 10.1. Google Suggest предлагает различные варианты после ввода буквы "е"

Для повышения оперативности интерфейса можно каптировать данные на стороне клиента. (Данные можно кэшировать и на сервере, но это другая тема, более знакомая разработчикам классических Web-приложений.) Система опережающего ввода обычно возвращает тем меньше результатов, чем больше набрано символов, причем, как правило, эти результаты входили в самый первый предложенный набор. Реализация системы "в лоб" отбрасывает предыдущие запросы в ответ на набор новых букв и извлекает с сервера новые данные. Более интеллектуальная система может оставить результаты первоначального запроса, отсеивая неподходящие элементы по мере ввода пользователем символов и обновляя пользовательский интерфейс без обращения к серверу за обработкой каждого нового символа. Такое решение улучшает приложение путем повышения оперативности и сокращения требуемой полосы пропускания. Мы просто обрабатываем имеющийся набор результатов, что ускоряет извлечение нужной информации и снимает необходимость в дополнительных этапах обработки на сервере.

Пожалуй, хватит теории. В следующем разделе мы рассмотрим готовую реализацию опережающего ввода.

10.1.2. Google Suggest

Некоторые люди считают Google Suggest вершиной приложений опережающего ввода. Google Suggest — это быстрое, доброжелательное к пользователю приложение, эффективно выполняющее свою работу. На рис. 10.1 показано, как Google Suggest предлагает варианты после ввода буквы "е".

На рис. 10.1 число предложений ограничено десятью. Зная, какой базой данных располагает Google, можно было бы ожидать и миллиарды предложений. При отборе информации, отображаемой пользователю, Google использует специальный алгоритм. Чтобы понять, как работает написанный Google код JavaScript, разработчики внимательно его разобрали (помните, что код JavaScript невозможно скрыть полностью, хотя можно запутать его анализ).

Рис. 10.2. Архитектура системы опережающего ввода

Одной из наиболее впечатляющих особенностей Google Suggest является поддержка быстрого набора — для ограничения числа обращений к серверу за короткий промежуток используются различные таймеры. Данный вопрос чрезвычайно важен для Google из-за огромного числа пользователей. Большое число обращений к серверу может порождать проблемы, кроме того, ограничение этого числа позволяет экономить ресурсы.

Пример Google вдохновляет нас (и многих других). В следующем разделе мы соберем лучшие из рассмотренных элементов и разработаем собственную схему опережающего ввода —- приложение Ajax.

10.1.3. Ajax как средство опережающего ввода

Средства опережающего ввода нашего приложения будут пытаться максимально уменьшить нагрузку на сервер. Небольшие сайты не могут обработать трафик, допустимый для Google, Amazon и Yahoo!, поскольку не имеют мощных регуляторов распределения нагрузки и множества серверов, обрабатывающих запросы. Следовательно, чем больше мы сэкономим полосу, тем дешевле будет эксплуатация небольших сайтов.

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

Видно, что та часть сценария, которая собственно и представляет собой инфраструктуру Ajax, позволяет захватывать данные с сервера. Сервер возвращает клиенту текстовый документ, содержащий выражение JavaScript.

Клиент обрабатывает данные, содержащиеся в этом выражении, и проверяет имеются ли в них искомые результаты. Если да. то пользователю предлагав ются на выбор несколько вариантов. Все кажется просто, пока вы не заду, маетесь о том, сколько кода JavaScript задействовано в описанном процессе Впрочем, если разбить процесс на ряд небольших этапов, задача написание сценария опережающего ввода с минимальной нагрузкой на сервер оказывается сравнительно простой. В данном проекте самым простым будет код серверной части приложения, поэтому начнем мы именно с него.

10.2. Структура серверной части сценария: С#

Схема опережающего ввода, которую мы будем разрабатывать, состоит из трех частей: сервера, базы данных и клиента. На практике база данных может представлять собой, например, XML-файл, но общая суть от этого не меняется.

10.2.1. Сервер и база данных

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

Для отправки запроса от клиента серверу и получения в ответ отформатированной структуры данных нужен объект XMLHttpRequest. В нашем случае динамически создается текстовый документ, заполняемый информацией, полученной из запроса к базе данных. Этот текстовый документ будет содержать код JavaScript, создающий массив с данными. Основные этапы создания массива JavaScript приведены в листинге 10.1,

Листинг 10.1. Сценарий typeAheadData.aspx.cs

//@ Установить тип содержимого Response.ContentType - "text/html";

//© Запросить элемент формы

string strQuery = Request.Form.Get("q").ToString();

string strAny = ""; // О Объявить строку

if (Request.Form.Get("where").ToLower() == "true")

{

strAny = "%";

}

// © Построить выражение SQL

string strSql = "Select top 15 " +

Глава 10. Опережающий ввод 387

"ProductName, " +

"Productld FROM Products " + "WHERE ProductName like '" + strAny + strQuery + "%"

'" ORDER BY ProductName";

// 0 Инициализировать запрос к базе данных DataTable dtQuestions = FillDataTable(

strSql);

//© Построить массив JavaScript System.Text.StringBuilder strJSArr =

new System.Text.StringBuilder( "arrOptions = new Array("); int iCount = 0;

//© Последовательно пройти по результатам foreach (DataRow row in

dtQuestions.Rows)

{

if (iCount > 0)

{ strJSArr.AppendC1,") ; } strJSArr.Append("["); strJSArr.Append("\"" +

row["ProductName"].ToString() + " \ " , " ) ; strJSArr.Append("\"" +

row["Productid"].ToString() + " \ " " ) ; strJSArr.Append("]");

iCount++;

}

strJSArr.Append(");") ;

//0 Записать строку на страницу Response.Write(strJSArr.ToString());

}

// © Выполнить запрос public static DataTable

PillDataTable(string sqlQuery)

{

string strConn = "Initial Catalog = "+ "Northwind;Data Source=127.0.0.1; " "Integrated Security=true;";

SqlConnection conn = new SqlConnection(strConn); SqlDataAdapter cmdl = new SqlDataAdapter(); cmdl.SelectCommand • new SqlCommand(sqlQuery,conn); DataSet dataSetl = new DataSetO; cmdl.Fill(dataSetl);

icmdl.Dispose();

conn.Close();

return dataSetl . Tables[0];

Код, приведенный в листинге 10.1, позволяет получать значения от клиента и передавать данные в строку, формируя массив JavaScript. Этот массив возвращается клиенту и обрабатывается. Данное поведение требуется инициализировать при загрузке страницы документа О. Первое, что мы делаем после возврата строки, — проверяем, что тип содержимого страницы установлен равным text/html ©.

Код клиентской стороны помещает значения на нужную страницу посред, ством объекта XMLHttpRequest. Следовательно, мы должны запросить в элементе формы q текст, представляющий предположительные варианты ввода ©. В отличие от многих схем опережающего ввода, мы позволяем пользователям находить результаты в середине слова, поэтому объявляем строку о отвечающую за обработку такой ситуации. Сценарий клиента передает булеву строку с элементом формы where. Если ее значение равно true, мы добавляем % перед началом термина, чтобы разрешить поиск с любого места строки

Теперь мы можем сформировать выражение SQL ©, которое позволит получать из базы данных значения, соответствующие тому, что вводит пользователь. Чтобы минимизировать нагрузку на пользователя, мы ограничим поиск: возвращать можно всего 15 значений. Затем мы инициализируем © процедуру запроса базы данных © и возвращаем таблицу данных с доступными результатами поиска.

Получив результаты из базы данных, можно формировать массив JavaScript О. Затем мы циклически проходим по множеству записей ©, создавая двухмерный массив с именами вариантов и идентификаторами. После завершения цикла мы пишем нашу строку на страницу ©, чтобы ее могло использовать выражение JavaScript.

Если вы используете серверный язык со страницей кода и HTMLстраницей, то с HTML-страницы необходимо удалить все дополнительные дескрипторы. Если используется такая же страница С # , как в нашем примере, на ASPX-странице должен присутствовать единственный указанный

Если мы не уберем дополнительные дескрипторы HTML, которые по умолчанию присутствуют на ASPX-странице, мы не получим допустимый текстовый файл (с кодом JavaScript), т.е. наши методы DOM JavaScript не смогут использовать данные. Чтобы гарантировать правильность данных, которые возвращаются клиенту, необходима быстрая проверка.

10.2,2. Тестирование серверного кода

При работе с Ajax тестирование серверного кода необходимо, поскольку JavaScript известен своими проблемами, причины которых часто бывает трудно обнаружить. Консоль JavaScript от Mozilla улучшает ситуацию, но чтобы минимизировать шансы на ошибку всегда стоит проверять корректность работы сервера.

При тестировании серверного кода можно пойти двумя путями. Поскольку объект XMLHttpRequest использует метод HTTP POST, мы можем либо создать простую форму с двумя текстовыми окнами и отправить ее на серверную страницу, либо закомментировать строки, проверяющие отправку формы, и задать в этом месте некоторые значения. Выберем второй вариант. Как видно из фрагмента кода, приведенного в листинге 10.2. мы заком-

пользователем из предложенных вариантов. Второе текстовое окно проем не дает отправить форму на дообработку на сервер при нажатии клавиши <Enter>. По умолчанию в форме с одним текстовым полем с клавишей <Enter> соотнесена отправка формы. Самый простой способ отказаться от такого поведения — добавить на страницу второе текстовое поле. Если вы до. бавляете опережающий ввод на страницу, содержащую несколько элементов формы, дополнительное окно вам не требуется. Таким образом, мы приходи^ к общей структуре HTML-документа, показанной в листинге 10.3.

Листинг 10.3. Структура HTML-страницы с опережающим вводом

<form name="Forml" AUTOCOMPLETE="off" ID="Forml">

AutoComplete Text Box: <input type="text" name="txtUserInput" /> <input type="hidden" name="txtUserValue" lD="hiddenl" />

<input type="text" name="txtlgnore" style="display:none" /> </form>

В листинге 10.3 мы добавили форму с отключенным автоматическим заполнением. Нам пришлось так сделать, чтобы браузер не помещал значения в поле при первой загрузке страницы. Описанная возможность очень удобна, но в данном случае она нарушит нашу схему опережающего ввода. Обратите внимание на то, что приведенный фрагмент используется только в Internet Explorer и не дает встроенным раскрывающимся спискам автозаполнения взаимодействовать с нашими раскрывающимися списками DHTML. Другие браузеры данный атрибут проигнорируют. Кремле того, мы добавили текстовое окно txtuserinput, скрытый элемент txtUserValue и ложное текстовое окно txtlgnore. С окном txtlgnore, используемым для предотвращения автоматической отправки формы, также соотнесен стиль CSS. согласно которому это окно невидимо. Данный результат можно получить и другими способами, но предложенный нами вариант является самым простым и быстрым решением. Итак, мы добавили в форму текстовые поля и можем писать код JavaScript.

10.3.2. JavaScript

Код JavaScript приложения с опережающим вводом выполняет три основные задачи.

•Наблюдение за действиями пользователя (вводом с помощью клавиатуры и мыши).

•Отправка данных на сервер/получение данных с сервера.

•Формирование HTML-содержимого, с которым может взаимодействовать пользователь.

Прежде чем .мы начнем кодирование, стоит подробнее остановиться на том, что же мы собираемся получить.

Когда пользователь набирает букву, становится видимым скрытый элемент span с информацией, имеющей отношение к набранной букве. На