Введение в Ajax для веб-приложений Java. Учебный курс по среде IDE NetBeans
Введение в Ajax для веб-приложений Java
В настоящем документе представлены общие сведения об Ajax и приведено описание некоторых возможностей среды IDE NetBeans, способствующих ускорению процесса программирования и увеличению эффективности работы с технологиями на основе Ajax. На примере низкоуровневых функциональных возможностей Ajax продемонстрирована разработка простого приложения с функцией автозаполнения текстового поля. В документе использованы материалы статьи Грега Мюррея (Greg Murray) и демонстрационное приложение из руководства Использование Ajax при помощи технологии Java.
Ajax – это аббревиатура, означающая "Асинхронный JavaScript и XML" (Asynchronous JavaScript and XML). Основное назначение Ajax состоит в предоставлении веб-приложению возможности эффективной обработки взаимодействия между пользователем и веб-страницей, при этом значительно снижаются требования к обновлению или полной перезагрузке страницы при каждом взаимодействии с пользователем. Такой подход предоставляет широкие возможности при использовании обозревателя (аналогичные возможностям настольного приложения или веб-приложения на основе подключаемого модуля). Обработка взаимодействия Ajax осуществляется асинхронно в фоновом режиме. Благодаря этому пользователь может продолжать работу со страницей. Взаимодействие Ajax инициируется посредством кода JavaScript. После выполнения взаимодействия Ajax код JavaScript обновляет исходный текст HTML для страницы. Изменения вносятся немедленно без необходимости обновления страницы. Взаимодействия Ajax могут использоваться для выполнения таких задач, как проверка правильности формата вводимых записей на основе серверной логики (непосредственно во время их ввода пользователем), извлечение подробных данных из сервера, динамическое обновление данных на странице и передача элементов форм страницы.
Open Source Edition, версии 3.1.x
версии 6.х или 7.х
Примечания
Вариант установки "Web и Java EE" позволяет дополнительно установить сервер GlassFish 3.0.1 и контейнер сервлетов Apache Tomcat 6.0.x.
При этом предполагается, что читатель обладает практическими знаниями в области различных используемых технологий (т.е. HTML, CSS, JavaScript, Java и JSP). В этом документе приведен обзор функциональных возможностей, предоставляемых кодом, однако он не содержит каких-либо пояснений относительно кода на более детальном уровне.
Предположим, что существует веб-страница, на которой пользователь может выполнять поиск информации о композиторах. Эта страница содержит поле, в которое вводится имя композитора. В примере приложения для поля ввода может использоваться функция автозавершения. Другими словами, пользователь может ввести часть имени композитора, после чего веб-приложение предложит варианты полного имени, перечислив всех композиторов, чьи имена или фамилии начинаются с введенных символов. Таким образом, пользователь может не помнить полное имя композитора, однако функция автозавершения обеспечит быстрый интуитивный доступ к требуемой информации.
Реализация функции автозавершения в поле поиска может служить примером возможностей, предоставляемых Ajax. Ajax использует объект XMLHttpRequest для асинхронной передачи запросов и ответов между клиентом и сервером. На следующем рисунке представлена блок-схема операций связи, происходящих между клиентом и сервером.
Для описания потока операций на блок-схеме можно использовать следующие действия.
Пользователь инициирует событие, например, отпускает клавишу при наборе имени. Это приводит к вызову функции JavaScript, которая инициализирует объект XMLHttpRequest.
Объект XMLHttpRequest настроен с учетом параметра запроса, который включает идентификатор элемента управления, инициировавшего событие, а также произвольное значение, введенное пользователем. Затем объект XMLHttpRequest выполняет асинхронный запрос к веб-серверу.
На веб-сервере осуществляется обработка этого запроса с использованием соответствующего объекта, например сервлета или прослушивающего процесса. Из хранилища данных извлекаются необходимые данные и подготавливается ответ, содержащий данные в форме документа XML.
Наконец, объект XMLHttpRequest получает данные XML с использованием функции ответного вызова, выполняет их обработку и обновляет модель DOM (Document Object Model, объектная модель документов) HTML для отображения страницы, содержащей новые данные.
В данном учебном курсе описан способ создания варианта автозаполнения путем выполнения потока операций процесса, показанного на рисунке выше. Сначала на стороне клиента создаются файлы для страницы представления данных и функции, необходимые для генерации объекта XMLHttpRequest. Затем выполняется настройка на стороне сервера, заключающаяся в создании хранилища данных и бизнес-логики с использованием технологий на основе Java. Наконец, на стороне клиента реализуется функция обратного вызова callback() и другие функциональные возможности JavaScript, необходимые для обновления DOM HTML.
Программирование на стороне клиента: часть 1
Сначала необходимо создать новый проект веб-приложения в среде IDE. Среда IDE уже содержит встроенные шаблоны для различных типов проекта.
Выберите "Файл" > "Создать проект". В области "Категории" выберите "Web". В области "Проекты" выберите "Веб-приложение" и нажмите кнопку "Далее".
На экране "Имя и расположение" введите MyAjaxApp в поле "Имя проекта". Поле "Project Location" позволяет указать местоположение проекта. Для всех остальных параметров примите значения по умолчанию и нажмите кнопку "Далее".
На панели "Сервер и параметры настройки" выберите сервер, на котором требуется выполнить развертывание приложения. В списке представлены только те серверы, которые зарегистрированы в среде IDE.
Подтвердите остальные значения по умолчанию и нажмите кнопку "Готово". Проект создается в файловой системе и открывается в среде IDE.
При создании веб-проектов на основе Java автоматически создается сценарий сборки Ant, отвечающий за компиляцию проекта, что позволяет немедленно развернуть и запустить его на сервере, зарегистрированном в среде IDE.
По умолчанию в редакторе исходного кода среды IDE создается и открывается страница index.jsp. Кроме того, проект появляется в окне "Проекты".
Перед написанием программы попробуйте запустить приложение в целях проверки правильности настройки взаимосвязи между средой IDE, сервером и обозревателем.
В окне "Проекты" щелкните правой кнопкой мыши узел проекта и выберите команду "Выполнить".
Приложение компилируется, сервер приложений запускается, после чего приложение развертывается на этом сервере и выполняется. В среде IDE открывается обозреватель по умолчанию, и на экране появляется сообщение "Hello World", включенное в файл index.jsp.
Работа с редактором HTML
Теперь, после выполнения проверки правильности настройки среды, можно приступить к преобразованию страницы-указателя в интерфейс автозавершения, который будет отображаться для пользователей.
Одним из преимуществ использования среды IDE является то, что используемый редактор обеспечивает возможность применения функции автозавершения кода, что позволяет опытным пользователям значительно увеличить свою производительность при написании кода. Редактор исходного кода среды IDE обеспечивает адаптацию к применяемой технологии благодаря чему при нажатии сочетания клавиш автозавершения кода CTRL+ПРОБЕЛ (при работе со страницей HTML) пользователю предлагаются варианты тегов HTML и атрибутов. Далее мы увидим, что то же самое справедливо и для других технологий, например, CSS и JavaScript.
Вторым важным преимуществом является возможность использования палитры в среде IDE. Эта палитра предоставляет удобные в работе шаблоны для элементов, часто используемых в технологиях программирования. Необходимо просто выбрать отдельный элемент и перетащить его в определенное место файла, открытого в редакторе исходного кода.
Для отображения крупных значков (как в примере) необходимо щелкнуть палитру правой кнопкой мыши и выбрать пункт "Отображать крупные значки".
Измените содержимое тегов <title> и <h1>на"Автоматическое завершение с использованием AJAX" Для страницы-указателя создание какого-либо кода на стороне сервера не требуется, так что можно удалить строки, созданные по умолчанию. Теперь должна появиться страница-указатель, аналогичная представленной ниже.
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Автоматическое завершение с использованием AJAX</title>
</head>
<body>
<h1>Автоматическое завершение с использованием AJAX</h1>
</body>
</html>
Для описания назначения текстового поля следует добавить соответствующий пояснительный текст. Непосредственно под тегами <h1> можно скопировать и вставить следующий текст:
<p>В этом примере показан способ автозавершения в реальном времени с помощью взаимодействия Asynchronous
JavaScript с XML (Ajax). </p>
<p>Введите имя в форме ниже. Варианты имен, которые будут введены, отображаются
под формой. Например, введите "Bach", "Mozart" или "Stravinsky"
после чего щелкните одно из имен для просмотра дополнительных сведений о композиторе. </p>
Добавьте к странице форму HTML. Для этого можно использовать элементы, содержащиеся в палитре среды IDE. Если палитра не открыта, выберите в главном меню "Окно" > "Палитра". Затем перейдите к узлу "Формы HTML", выберите элемент "Форма" и перетащите его на страницу под только что добавленные теги <p>. Появится диалоговое окно "Вставить форму". Введите следующее:
Action: autocomplete
Method: GET
Name: autofillform
Нажмите кнопку "ОК". Теги HTML <form> вставляются в страницу, содержащую указанные атрибуты. (Метод GET применяется по умолчанию, и, следовательно, не объявляется явно).
Добавьте к странице таблицу HTML. В категории палитры "HTML" выберите элемент "Таблица" и перетащите его непосредственно под теги <form>. Откроется диалоговое окно "Вставить таблицу". Введите следующее:
Rows: 2
Columns: 2
Border Size: 0
Cell Padding: 5
Щелкните правой кнопкой мыши редактор исходного кода и выберите команду "Форматировать". Последует выравнивание кода. Теперь форма должна выглядеть следующим образом:
В первый столбец первой строки таблицы введите следующий текст (изменения выделены полужирным шрифтом):
<td><strong>Composer Name:</strong></td>
Во второй столбец первой строки вместо перетаскивания поля "Ввод текста" из палитры введите указанный ниже код (изменения выделены полужирным шрифтом):
При вводе кода можно использовать встроенную в среду IDE функцию автозавершения кода. Например, введите <i, а затем нажмите CTRL+ПРОБЕЛ. Список предлагаемых вариантов выбора отображается под курсором, а в расположенном выше поле появляется описание выбранного элемента. Для получения возможных вариантов выбора при написании кода достаточно в любой момент нажать в редакторе исходного кода сочетание клавиш CTRL+ПРОБЕЛ. Кроме того, при наличии единственного возможного варианта выбора нажатие CTRL+ПРОБЕЛ приведет к автоматическому завершению кода с использованием элемента с этим именем.
Атрибут onkeyup, введенный выше, указывает на функцию JavaScript с именем doCompletion(). Эта функция вызывается при каждом нажатии клавиши в текстовом поле формы и соответствует вызову JavaScript на приведенной выше блок-схеме Ajax.
Работа с редактором JavaScript
Редактор JavaScript в среде IDE предоставляет целый ряд расширенных возможностей редактирования, таких как интеллектуальное автозавершение кода, семантическое выделение, быстрое переименование, возможности переработки и многие другие функции. Обратитесь к разделу Редактирование JavaScript в качестве введения и к странице http://wiki.netbeans.org/JavaScript за подробной спецификацией.
Возможность автозавершения кода JavaScript автоматически предоставляется при кодировании в файлах .js, а также внутри тегов <script> и при работе с другими технологиями (например, HTML, RHTML, JSP, PHP). При использовании редактора JavaScript среда IDE предоставляет информацию о совместимости с обозревателями в зависимости от типов и версий обозревателей, указанных на экране "JavaScript Options". Откройте экран "ПараметрыJavaScript", выбрав "Сервис" > "Параметры" ("NetBeans" > "Параметры для Mac"), а затем – "Разное" > "JavaScript".
Среда IDE предоставляет встроенные возможности поддержки для Firefox, Internet Explorer, Safari и Opera. На экране "Параметры JavaScript" можно также указать версию механизма JavaScript, по отношению к которой применяется автозавершение кода.
Добавьте файл JavaScript к приложению и выполните doCompletion().
В окне "Проекты" щелкните правой кнопкой мыши узел проекта и выберите "Создать" > "Файл JavaScript". (Если файл JavaScript отсутствует в списке, выберите "Прочее". Затем выберите файл JavaScript из категории "Web" в мастере создания файла).
Укажите имя файла javascript и тип web в текстовом поле "Папка" для его перемещения в веб-подпапку.
Нажмите кнопку "Готово". Обратите внимание на то, что новый файл JavaScript теперь отображается в окне "Проекты" в папке "Веб-страницы".
Примечание. Если папка web не отображается, перейдите к окну "Файлы" ("Окно" > "Файлы"). В окне "Проекты" представлена логическая структура ключевого содержимого проекта, в то время как в окне "Файлы" все содержимое проекта представлено в виде каталога.
Введите приведенный ниже код в файл javascript.js.
var req;
var isIE;
function init() {
completeField = document.getElementById("complete-field");
}
function doCompletion() {
var url = "autocomplete?action=complete&id=" + escape(completeField.value);
req = initRequest();
req.open("GET", url, true);
req.onreadystatechange = callback;
req.send(null);
}
function initRequest() {
if (window.XMLHttpRequest) {
if (navigator.userAgent.indexOf('MSIE') != -1) {
isIE = true;
}
return new XMLHttpRequest();
} else if (window.ActiveXObject) {
isIE = true;
return new ActiveXObject("Microsoft.XMLHTTP");
}
}
С помощью этого кода выполняется простая проверка совместимости веб-обозревателей Firefox 3 и Internet Explorer версий 6 и 7). Если требуется добавить более надежный код, устраняющий ошибки совместимости, используйте сценарий для определения обозревателя с веб-сайта http://www.quirksmode.org.
Вернитесь к index.jsp и добавьте справочную информацию в файл JavaScript между тегами <head>.
Для быстрого перехода между страницами, открытыми в редакторе исходного кода, можно воспользоваться сочетанием клавиш CTRL+TAB.
Вставьте вызов init() после открывающего тега <body>.
<body onload="init()">
Это обеспечит выполнение вызова init() при каждой загрузке страницы.
Роль doCompletion() состоит в следующем:
создание URL-адреса к местоположению, содержащему данные, которые могут использоваться на стороне сервера;
инициализация объекта XMLHttpRequest;
запрос объекта XMLHttpRequest для передачи асинхронного запроса в сервер.
Объект XMLHttpRequest является основным объектом Ajax и своего рода фактическим стандартным решением для обеспечения асинхронной передачи данных XML по HTTP. Асинхронное взаимодействие подразумевает возможность продолжения обработки обозревателем событий на странице даже после передачи запроса. Данные передаются в фоновом режиме и могут автоматически загружаться на страницу без необходимости ее обновления.
Следует отметить, что объект XMLHttpRequest фактически создается с помощью функции initRequest(), которая вызывается функцией doCompletion(). Эта функция позволяет выполнять проверку возможности распознавания обозревателем запроса XMLHttpRequest, и – в случае положительного ответа – создавать объект XMLHttpRequest. В противном случае, с ее помощью выполняется проверка на ActiveXObject (XMLHttpRequest для Internet Explorer 6), и если результат идентификации является положительным, создается ActiveXObject.
При создании объекта необходимо определить три параметра XMLHttpRequest: URL-адрес, метод HTTP (GET или POST) и допустимость использования асинхронного взаимодействия. В вышеупомянутом примере эти параметры определяются следующим образом:
URL-адрес autocomplete и текст, введенный пользователем в поле complete-field:
var url = "autocomplete?action=complete&id=" + escape(completeField.value);
GET означает, что взаимодействия HTTP используют метод GET;
true означает, что взаимодействие является асинхронным:
req.open("GET", url, true);
Если взаимодействие определено как асинхронное, необходимо указать функцию обратного вызова. Функция обратного вызова для этого взаимодействия определяется при помощи следующего оператора:
req.onreadystatechange = callback;
Затем следует определить функцию callback(). Взаимодействие HTTP инициируется при вызове XMLHttpRequest.send(). Это действие соответствует запросу HTTP, который передается на веб-сервер (см. представленную выше блок-схему).
Программирование на стороне сервера
В среде IDE предусмотрена полная поддержка серверного веб-программирования. Наряду с базовой поддержкой редактором многих популярных языков программирования и написания сценариев, поддерживаются также веб-службы, такие как SOAP, REST, SaaS, а также платформы, ориентированные на шаблон "модель-представление-контроллер" (MVC), например, JSF, Spring, Struts, Ruby on Rails и Grails. Поддержка Ajax включена в компоненты Woodstock для визуальных веб-проектов JSF, а также в компонент Dynamic Faces, который является расширением JSF, обеспечивающим функциональные возможности AJAX. Также существуют многочисленные подключаемые модули для платформ на основе Ajax, например GWT, Struts2 и jMaki.
Бизнес-логика разрабатываемого приложения предполагает обработку запросов путем извлечения данных из хранилища данных, их последующую подготовку и передачу ответа. В данном случае этот принцип реализован с использованием сервлета. Перед началом написания кода сервлета необходимо настроить хранилище данных и функциональные возможности, требуемые для доступа к данным со стороны этого сервлета.
Для данного простого приложения создается класс с именем ComposerData, в котором данные о композиторах содержатся в хранилище HashMap. В HashMap можно сохранять пары связанных элементов в парах ключевых значений. Кроме того, следует создать класс Composer, который инициирует извлечение сервлетом данных из записей, содержащихся в хранилище HashMap.
Щелкните правой кнопкой мыши узел проекта в окне "Проекты" и выберите команду "Создать" > "Класс Java".
Дайте классу имя ComposerData и введите com.ajax в поле "Пакет". При этом создается новый пакет, в который будет включен этот класс, а также другие классы, которые будут созданы позже.
Нажмите кнопку "Готово". Последует создание и открытие класса в редакторе исходного кода.
В редакторе исходного кода вставьте следующий код:
package com.ajax;
import java.util.HashMap;
/**
*
* @author nbuser
*/
public class ComposerData {
private HashMap composers = new HashMap();
public HashMap getComposers() {
return composers;
}
public ComposerData() {
composers.put("1", new Composer("1", "Johann Sebastian", "Bach", "Baroque"));
composers.put("2", new Composer("2", "Arcangelo", "Corelli", "Baroque"));
composers.put("3", new Composer("3", "George Frideric", "Handel", "Baroque"));
composers.put("4", new Composer("4", "Henry", "Purcell", "Baroque"));
composers.put("5", new Composer("5", "Jean-Philippe", "Rameau", "Baroque"));
composers.put("6", new Composer("6", "Domenico", "Scarlatti", "Baroque"));
composers.put("7", new Composer("7", "Antonio", "Vivaldi", "Baroque"));
composers.put("8", new Composer("8", "Ludwig van", "Beethoven", "Classical"));
composers.put("9", new Composer("9", "Johannes", "Brahms", "Classical"));
composers.put("10", new Composer("10", "Francesco", "Cavalli", "Classical"));
composers.put("11", new Composer("11", "Fryderyk Franciszek", "Chopin", "Classical"));
composers.put("12", new Composer("12", "Antonin", "Dvorak", "Classical"));
composers.put("13", new Composer("13", "Franz Joseph", "Haydn", "Classical"));
composers.put("14", new Composer("14", "Gustav", "Mahler", "Classical"));
composers.put("15", new Composer("15", "Wolfgang Amadeus", "Mozart", "Classical"));
composers.put("16", new Composer("16", "Johann", "Pachelbel", "Classical"));
composers.put("17", new Composer("17", "Gioachino", "Rossini", "Classical"));
composers.put("18", new Composer("18", "Dmitry", "Shostakovich", "Classical"));
composers.put("19", new Composer("19", "Richard", "Wagner", "Classical"));
composers.put("20", new Composer("20", "Louis-Hector", "Berlioz", "Romantic"));
composers.put("21", new Composer("21", "Georges", "Bizet", "Romantic"));
composers.put("22", new Composer("22", "Cesar", "Cui", "Romantic"));
composers.put("23", new Composer("23", "Claude", "Debussy", "Romantic"));
composers.put("24", new Composer("24", "Edward", "Elgar", "Romantic"));
composers.put("25", new Composer("25", "Gabriel", "Faure", "Romantic"));
composers.put("26", new Composer("26", "Cesar", "Franck", "Romantic"));
composers.put("27", new Composer("27", "Edvard", "Grieg", "Romantic"));
composers.put("28", new Composer("28", "Nikolay", "Rimsky-Korsakov", "Romantic"));
composers.put("29", new Composer("29", "Franz Joseph", "Liszt", "Romantic"));
composers.put("30", new Composer("30", "Felix", "Mendelssohn", "Romantic"));
composers.put("31", new Composer("31", "Giacomo", "Puccini", "Romantic"));
composers.put("32", new Composer("32", "Sergei", "Rachmaninoff", "Romantic"));
composers.put("33", new Composer("33", "Camille", "Saint-Saens", "Romantic"));
composers.put("34", new Composer("34", "Franz", "Schubert", "Romantic"));
composers.put("35", new Composer("35", "Robert", "Schumann", "Romantic"));
composers.put("36", new Composer("36", "Jean", "Sibelius", "Romantic"));
composers.put("37", new Composer("37", "Bedrich", "Smetana", "Romantic"));
composers.put("38", new Composer("38", "Richard", "Strauss", "Romantic"));
composers.put("39", new Composer("39", "Pyotr Il'yich", "Tchaikovsky", "Romantic"));
composers.put("40", new Composer("40", "Guiseppe", "Verdi", "Romantic"));
composers.put("41", new Composer("41", "Bela", "Bartok", "Post-Romantic"));
composers.put("42", new Composer("42", "Leonard", "Bernstein", "Post-Romantic"));
composers.put("43", new Composer("43", "Benjamin", "Britten", "Post-Romantic"));
composers.put("44", new Composer("44", "John", "Cage", "Post-Romantic"));
composers.put("45", new Composer("45", "Aaron", "Copland", "Post-Romantic"));
composers.put("46", new Composer("46", "George", "Gershwin", "Post-Romantic"));
composers.put("47", new Composer("47", "Sergey", "Prokofiev", "Post-Romantic"));
composers.put("48", new Composer("48", "Maurice", "Ravel", "Post-Romantic"));
composers.put("49", new Composer("49", "Igor", "Stravinsky", "Post-Romantic"));
composers.put("50", new Composer("50", "Carl", "Orff", "Post-Romantic"));
}
}
Создайте класс Composer:
Щелкните правой кнопкой мыши узел проекта в окне "Проекты" и выберите команду "Создать" > "Класс Java".
Дайте классу имя Composer и выберите com.ajax в раскрывающемся списке поля "Package". Нажмите кнопку "Далее".
Нажмите кнопку "Готово". Последует создание и открытие класса в редакторе исходного кода.
В редакторе исходного кода вставьте следующий код:
Создайте сервлет для обработки URL-адреса autocomplete, получаемого при входящем запросе.
Щелкните правой кнопкой мыши узел проекта в окне "Проекты" и выберите команду "Создать" > "Servlet". (если команда "Servlet" не отображается, в категории "Web" выберите "Other", затем выберите "Servlet"). На панели "Имя и местоположение" откроется мастер создания сервлета.
Дайте сервлету имя AutoCompleteServlet и выберите com.ajax в раскрывающемся списке поля "Package".
На панели "Настройка развертывания сервлета" измените значение шаблона URL-адреса на /autocomplete, так чтобы ему соответствовал URL-адрес, установленный ранее в объекте XMLHttpRequest. Использование этой панели позволяет пропустить этап добавления дополнительных сведений вручную к дескриптору развертывания.
При желании выберите "Добавить информацию о сервлете в дескприптор развертывания". После выполнения этих действий созданный проект получится таким же, как загруженный пример. В последней версии среды IDE сервлет по умолчанию регистрируется аннотацией @WebServlet вместо регистрации в дескрипторе развертывания. Тем не менее, проект будет работать, если использовать аннотацию @WebServlet вместо дескриптора развертывания.
Нажмите кнопку "Готово". Сервлет будет создан и открыт в редакторе исходного кода.
Единственными методами, которые следует переопределить, являются метод doGet() для определения обработки сервлетом запроса autocompleteGET и метод init(), который должен инициировать ServletContext для того, чтобы сервлет имел доступ к другим классам приложения после его запуска.
Существует возможность переопределения методов из родительских классов с помощью контекстного меню "Вставить код" в среде IDE. Реализуйте метод init() путем выполнения следующих действий.
Поместите курсор в нижней части объявления класса AutoCompleteServlet в редакторе исходного кода. Нажмите ALT+INS (CTRL+I в Mac ОS) для открытия контекстного меню "Создать код".
Выберите команду "Переопределить метод". В появившемся диалоговом окне отображаются все родительские классы сервлета AutoCompleteServlet. Разверните узел GenericServlet и выберите init(Servlet Config config).
Нажмите кнопку "ОК". Метод init() добавится в редактор исходного кода.
Добавьте переменную для объекта ServletContext и измените метод init() (изменения выделены полужирным шрифтом):
Добавьте оператор импорта для объекта ServletContext. Это можно сделать, выбрав значок лампочки, который отображается на экране в левом поле редактора исходного кода.
Метод doGet() должен преобразовать URL-адрес запроса, извлечь данные из хранилища данных и подготовить ответ в формате XML. Следует отметить, что объявление метода было сгенерировано при создании класса. Для его просмотра может потребоваться расширение методов "HttpServlet" путем выбора значка "Expand" () в левом поле.
Добавьте к классу следующие объявления переменных в нижней части объявления класса AutocompleteServlet:
При этом создается хранилище HashMap, включающее все данные о композиторах, которое затем используется методом doGet().
Выполните прокрутку вниз до метода doGet() и реализуйте его следующим образом:
@Override
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
String action = request.getParameter("action");
String targetId = request.getParameter("id");
StringBuffer sb = new StringBuffer();
if (targetId != null) {
targetId = targetId.trim().toLowerCase();
} else {
context.getRequestDispatcher("/error.jsp").forward(request, response);
}
boolean namesAdded = false;
if (action.equals("complete")) {
// check if user sent empty string
if (!targetId.equals("")) {
Iterator it = composers.keySet().iterator();
while (it.hasNext()) {
String id = (String) it.next();
Composer composer = (Composer) composers.get(id);
if ( // targetId matches first name
composer.getFirstName().toLowerCase().startsWith(targetId) ||
// targetId matches last name
composer.getLastName().toLowerCase().startsWith(targetId) ||
// targetId matches full name
composer.getFirstName().toLowerCase().concat(" ")
.concat(composer.getLastName().toLowerCase()).startsWith(targetId)) {
sb.append("<composer>");
sb.append("<id>" + composer.getId() + "</id>");
sb.append("<firstName>" + composer.getFirstName() + "</firstName>");
sb.append("<lastName>" + composer.getLastName() + "</lastName>");
sb.append("</composer>");
namesAdded = true;
}
}
}
if (namesAdded) {
response.setContentType("text/xml");
response.setHeader("Cache-Control", "no-cache");
response.getWriter().write("<composers>" + sb.toString() + "</composers>");
} else {
//nothing to show
response.setStatus(HttpServletResponse.SC_NO_CONTENT);
}
}
if (action.equals("lookup")) {
// put the target composer in the request scope to display
if ((targetId != null) && composers.containsKey(targetId.trim())) {
request.setAttribute("composer", composers.get(targetId));
context.getRequestDispatcher("/composer.jsp").forward(request, response);
}
}
}
Итак, на этом примере создания сервлета можно убедиться, что написание кода на стороне сервера для обработки с использованием Ajax не требует каких-либо новых знаний. Для случаев, когда требуется обмен документами XML, тип содержимого ответа должен иметь значение text/xml. Кроме того, Ajax позволяет осуществлять обмен простыми текстами или даже фрагментами JavaScript, которые могут анализироваться или выполняться с использованием функции обратного вызова на стороне клиента. Обратите внимание на то, что некоторые обозреватели могут кэшировать результаты, следовательно, может потребоваться установка заголовка HTTP "Cache-Control" на no-cache.
В этом примере сервлет генерирует документ XML, в котором содержатся все композиторы, имя или фамилия которых начинается с введенных пользователем символов. Этот документ соответствует данным XML, описанным в приведенной выше блок-схеме. Ниже приведен пример документа XML, который возвращается в объект XMLHttpRequest:
После завершения кода приложения можно воспользоваться функцией HTTP Monitor среды IDE для просмотра возвращенных данных XML.
Программирование на стороне клиента: часть 2
Следует определить функцию обратного вызова для обработки ответа сервера и добавить функциональные возможности, необходимые для отражения изменений на просматриваемой пользователем странице. В этом случае потребуется внести изменения в модель DOM HTML. Необходимо создать страницы JSP для отображения результатов успешного запроса или, в случае сбоя при выполнения запроса, для сообщений об ошибках. Наконец, можно использовать редактор CSS, поставляемый со средой IDE, для добавления в презентацию простой таблицы стилей.
Асинхронный вызов функции обратного вызова выполняется на определенных этапах взаимодействия HTTP – при изменении свойства readyState объекта XMLHttpRequest. В разрабатываемом приложении в качестве функции обратного вызова используется callback(). Следует помнить о том, что callback в doCompletion() была определена как свойство XMLHttpRequest.onreadystatechange для функции. Теперь можно реализовать функцию обратного вызова следующим образом.
Откройте javascript.js в редакторе исходного кода и введите следующий код.
function callback() {
if (req.readyState == 4) {
if (req.status == 200) {
parseMessages(req.responseXML);
}
}
}
Значение "4" состояния readyState означает успешное выполнение взаимодействия HTTP. Интерфейс API для XMLHttpRequest.readState указывает на наличие 5 возможных значений, которые могут быть использованы при настройке. Это следующие значения:
Значение readyState
Определение состояния объекта
0
не инициализировано
1
загрузка
2
загружено
3
интерактивный режим
4
выполнено
Обратите внимание, что функция parseMessages() вызывается, только если XMLHttpRequest.readyState находится в состоянии "4", а status – определение кода состояния HTTP запроса – имеет значение "200", что указывает на успешное выполнение. В разделе Обновление модели DOM HTML будет определен parseMessages().
Обновление модели DOM HTML
Функция parseMessages() позволяет выполнять обработку входящих данных XML. При этом, в указанной функции используются несколько вспомогательных функций, например appendComposer(), getElementY() и clearTable(). Кроме того, необходимо ввести новые элементы для страницы-указателя, например, вторую таблицу HTML, которая служит в качестве поля автозавершения, и идентификаторы для элементов, обеспечивающие возможность вызова в javascript.js. Наконец, следует создать новые переменные, соответствующие идентификаторам элементов в index.jsp, инициализировать их в предварительно реализованной функции init() и добавить определенные функциональные возможности, используемые при каждой загрузке index.jsp.
Примечание. Функции и элементы, которые создаются при выполнении следующих действий, являются взаимозависимыми. После выполнения рекомендаций, приведенных в этом разделе, необходимо выполнить тщательную проверку реализованного кода.
Откройте index.jsp в редакторе исходного кода и введите указанный ниже код во вторую строку предварительно созданной таблицы HTML.
Вторая строка таблицы содержит еще одну таблицу HTML. Эта таблица представляет поле автозавершения, используемое для автоматического ввода полных имен композиторов.
Откройте javascript.js в редакторе исходного кода и добавьте к первому фрагменту файла три следующих переменных:
var completeField;
var completeTable;
var autoRow;
Добавьте следующие строки (выделенные полужирным шрифтом) к функции init().
Одна из целей init() состоит в обеспечении доступности элементов в index.jsp для других функций, используемых в целях изменения DOM страницы-указателя.
Эта функция позволяет создавать новую строку таблицы и вставлять в нее ссылку на композитора с использованием данных, передаваемых в функцию посредством соответствующих трех параметров, а затем вставлять эту строку в элемент complete-table страницы-указателя.
Добавьте getElementY() в javascript.js.
function getElementY(element){
var targetTop = 0;
if (element.offsetParent) {
while (element.offsetParent) {
targetTop += element.offsetTop;
element = element.offsetParent;
}
} else if (element.y) {
targetTop += element.y;
}
return targetTop;
}
Указанная функция применяется для определения вертикальной позиции исходного элемента. Это является необходимым, поскольку фактическое расположение элемента при его отображении часто зависит от типа и версии обозревателя. Следует отметить, что при отображении на экране элемент complete-table, содержащий имена композиторов, перемещается в нижнюю правую часть таблицы, в которой он расположен. Правильное расположение по высоте определяется getElementY().
function clearTable() {
if (completeTable.getElementsByTagName("tr").length > 0) {
completeTable.style.display = 'none';
for (loop = completeTable.childNodes.length -1; loop >= 0 ; loop--) {
completeTable.removeChild(completeTable.childNodes[loop]);
}
}
}
Эта функция позволяет скрывать элемент complete-table (т.е. делать его невидимым), но не удаляет какие-либо существующие записи имен композиторов, созданные ранее.
Для вызова clearTable() при каждом получении данных с сервера можно соответствующим образом изменить функцию callback(). Поэтому любые скомбинированные записи, существующие в окне автозавершения, удаляются до того, как выполняется заполнение новыми записями.
function callback() {
clearTable();
if (req.readyState == 4) {
if (req.status == 200) {
parseMessages(req.responseXML);
}
}
}
Добавьте parseMessages() в javascript.js.
function parseMessages(responseXML) {
// совпадения не возвращены
if (responseXML == null) {
return false;
} else {
var composers = responseXML.getElementsByTagName("composers")[0];
if (composers.childNodes.length > 0) {
completeTable.setAttribute("bordercolor", "black");
completeTable.setAttribute("border", "1");
for (loop = 0; loop < composers.childNodes.length; loop++) {
var composer = composers.childNodes[loop];
var firstName = composer.getElementsByTagName("firstName")[0];
var lastName = composer.getElementsByTagName("lastName")[0];
var composerId = composer.getElementsByTagName("id")[0];
appendComposer(firstName.childNodes[0].nodeValue,
lastName.childNodes[0].nodeValue,
composerId.childNodes[0].nodeValue);
}
}
}
}
Функция parseMessages() получает в качестве параметра объектное представление документа XML, возвращаемое сервлетом AutoComplete. С программной точки зрения, функция исследует документ XML и извлекает firstName, lastName и id каждой записи, а затем передает эти данные в appendComposer(). Это приводит к динамическому обновлению содержимого элемента complete-table. Например, запись, которая генерируется и вставляется в complete-table, может выглядеть следующим образом:
Динамическое обновление элемента complete-table соответствует последнему этапу потока процесса передачи данных, который выполняется во время обмена данными на основе Ajax. Это обновление соответствует передаче данных HTML и CSS на страницу представления, как показано на приведенной выше блок-схеме.
Отображение результатов
Для отображения результатов необходим файл JSP под названием composers.jsp Во время поиска эта страница вызывается из AutoCompleteServlet. Также понадобится файл error.jsp, который вызывается изAutoCompleteServlet, если композитор не был обнаружен.
Для отображения результатов и ошибок:
в окне "Проекты" щелкните правой кнопкой мыши папку веб-страниц и выберите "Создать" > "JSP". Откроется мастер создания JSP.
В поле "Имя файла" введитеcomposer В поле "Созданный файл" должен появиться путь, который заканчивается файлом /web/composer.jsp.
Нажмите кнопку "Готово". Файл composer.jsp открывается в редакторе. В папке веб-страниц в окне "Проекты" появляется путь к этому файлу.
Измените код заглушки в файле composer.jsp следующим кодом:
Создайте еще один файл JSP в папке с веб-страницами проекта. Назовите файл error.jsp.
Измените код заглушки в файле error.jsp следующим кодом:
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="stylesheet.css">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Ошибка поиска</title>
</head>
<body>
<h2>Ошибка поиска</h2>
<p>Во время поиска произошла ошибка. Повторите попытку позже.</p>
<p>Вернуться на <a href="index.jsp" class="link">главную страницу приложения.</a></p>
</body>
</html>
Присоединение таблицы стилей
На данном этапе создан весь код, необходимый для реализации функциональных возможностей приложения. Теперь для проверки результатов следует попытаться запустить приложение.
В окне "Проекты" щелкните правой кнопкой мыши узел проекта и выберите команду "Выполнить". Будет выполнена перекомпиляция проекта и его развертывание на целевом сервере. Откроется обозреватель, в котором отображается страница-указатель.
Для присоединения к приложению таблицы стилей достаточно просто создать файл .css и ссылку на этот файл со страниц представления. При работе с файлами .css среда IDE предоставляет поддержку автозавершения кода, а также некоторые другие возможности для упрощения процесса создания правил таблицы стилей. В частности, это следующие возможности:
Редактор правил стиля: диалоговое окно, позволяющее создавать правила на основе классов, идентификаторов и элементов HTML и определять их положение в иерархии документа.
Окно "Предварительный просмотр CSS": окно предварительного просмотра, в котором при помещении курсора внутри правила отображается стандартный текст, соответствующий блоку объявления этого правила.
Конструктор стилей CSS: интерфейс, разработанный для создания правил с использованием определенного набора элементов управления и оформления.
Для присоединения таблицы стилей к приложению выполните следующие действия.
В окне "Проекты" щелкните правой кнопкой мыши узел проекта и выберите команду "Создать" > "Каскадная таблица стилей". Если пункт "Каскадная таблица стилей" в списке отсутствует, выберите "Прочие". Затем выберите "Каскадная таблица стилей" из категории "Web" в мастере создания файла.
В текстовом поле "Имя файла CSS" введите stylesheet.
Нажмите кнопку "Готово". Новый файл появится в окне "Проекты" и откроется в редакторе среды IDE.
В stylesheet.css введите следующие правила. При необходимости просмотра предложений можно использовать поддержку автозавершения кода среды IDE путем нажатия CTRL+ПРОБЕЛ.
Выполните проверку кода CSS, щелкнув редактор CSS правой кнопкой мыши и выбрав команду "Проверить CSS". В окне "Вывод" можно просмотреть все ошибки ("Окно" > "Вывод").
Откройте окно "Предварительный просмотр CSS", выбрав "Window" > "Other" > "Предварительный просмотр ".
Поместите курсор внутри правила, с помощью которого можно изменить текст и цвет (например, h1). В окне "Предварительный просмотр CSS" появляется стандартное отображение текста в обозревателе.
Перейдите к странице index.jsp в редакторе исходного кода и добавьте ссылку на таблицу стилей между тегами <head>.
Как указано в stylesheet.css, согласно этому правилу элемент complete-table располагается таким образом, что отображается справа от родительского элемента.
Выполнение проекта
При повторном запуске приложения текст в обозревателе отображается с использованием только что созданной таблицы стилей. При каждом вводе символа на сервер передается асинхронный запрос, который возвращается с данными XML, подготовленными при помощи AutoCompleteServlet. При вводе последующих символов количество вариантов имен композиторов уменьшается, и на экране появляется новый список соответствий.
Использование средства наблюдения HTTP Server Monitor
Можно использовать средство наблюдения HTTP Server Monitor среды IDE для проверки взаимодействия с HTTP, которое заключается в передаче запросов и ответов между клиентским приложением и сервером. В HTTP Server Monitor отображается информация, например, заголовки клиентского приложения и сервера, свойства сеанса, подробные сведения о файлах cookie, а также параметры запроса.
Перед началом использования средства HTTP Monitor его следует сначала активировать на используемом сервере.
Откройте окно "Серверы", выбрав в главном меню "Сервис" > "Серверы".
На левой панели выберите сервер, который используется для проекта. Затем на правой панели выберите режим "Enable HTTP Monitor".
Примечание. Данный параметр отображается на вкладке "Общее" при использовании сервера GlassFish. На сервере Tomcat он расположен на вкладке "Соединение".
Выберите "Close".
Если сервер уже запущен, необходимо перезапустить его для применения изменений. Для перезапуска сервера необходимо открыть окно "Службы" ("Окно" > "Службы"), затем щелкнуть правой кнопкой мыши сервер под узлом "Серверы" и выбрать "Перезапустить".
Теперь при повторном выполнении приложения в нижней области среды IDE откроется HTTP Monitor. Для просмотра информации относительно каждого запроса можно выбрать запись на левой панели, затем перейти на соответствующие вкладки в главном окне.
Можно проверить данные XML, полученные от сервера в результате асинхронного запроса, переданного при вводе пользователем символа в поле автозавершения.
В древовидной структуре слева от области HTTP Monitor щелкните правой кнопкой мыши запись запроса и выберите "Replay".
Ответ генерируется в обозревателе. В этом случае, поскольку ответ состоит из данных XML, данные в обозревателе отображаются с использованием собственной программы просмотра XML.
Заключение
Это заключительный раздел руководства "Введение в Ajax". Авторы полагают, что к настоящему времени у пользователей сформировалось четкое представление о том, каким образом Ajax поддерживает обмен информацией по HTTP в фоновом режиме и выполняет динамическое обновление страницы на основе полученных результатов.
Следует отметить, что разработанное приложение имеет ряд недостатков, например, при выборе имени композитора из поля автозавершения пользователь не получает какого-либо результата. Для получения дополнительных сведений о реализации с использованием технологии JSP загрузите проект решения. Кроме того, существует возможность выполнения проверки допустимости на стороне сервера в целях предотвращения запроса пользователем имени, не существующего в хранилище данных. Для более подробного изучения этих функций обратитесь к другим учебным курсам учебной карты по Java EE & Java Web.
Подключение дерева Dojo к списку ArrayList с помощью JSON. Данный документ основан на практическом примере JavaOne. В нем демонстрируются способы внедрения элемента оформления "Дерево Dojo" в веб-страницу и способы управления реакцией стороны сервера на запросы дерева в формате JSON.
Введение в веб-платформу Wicket. Введение в процесс создания повторно используемых компонентов и применения их в веб-приложении на основе платформы Wicket.
Создание приложения Ajax с помощью Script.aculo.us. Описывает использование интерфейсов API сохранения состояния объектов Java для нумерации страниц на стороне сервера путем извлечения и отображения результатов в текстовом поле при помощи функциональных возможностей Ajax.
) в левом поле.
