Работа с удаленным контентом

1. Вступление
2. Работа с разными типами контента
3. Работа с текстом
4. Работа с XML
5. пример
6. Работа с разными типами узлов
7. Другие источники
8. Работа с JSON
9. Подробнее о JSON
10. Установка типа авторизации
11. методы
12. ПОЛУЧИТЬ
13. СООБЩЕНИЕ
14. Обновление кеша

В этом документе описывается, как извлекать и обрабатывать удаленные текстовые (обычно HTML), XML и JSON данные с помощью функции makeRequest (). Функция makeRequest () - это всего лишь один из методов получения удаленных данных. Для обзора различных подходов, которые вы можете использовать, см. Руководство для разработчиков удаленных запросов данных ,

Вступление

Для обзора различных подходов, которые вы можете использовать для извлечения удаленных данных, см. Руководство для разработчиков удаленных запросов данных , Эта глава фокусируется только на одном подходе - функции makeRequest () API гаджетов.

API гаджетов обеспечивает makeRequest (url, callback, opt_params) функция для извлечения и работы с удаленным веб-контентом. Требуются следующие аргументы:

• String url - URL-адрес, на котором расположен контент
• Функция обратного вызова - функция для вызова с данными из URL после их получения
• Map. <Gadgets.io.RequestParameters, Object> opt_params - дополнительные параметры для передачи в запрос.

Аргумент opt_params позволяет указать следующее:

• Тип содержимого запроса (TEXT, XML и JSON)
• Тип метода запроса (POST или GET)
• Любые заголовки, которые вы хотите включить в запрос
• Тип авторизации (NONE, SIGNED и OAUTH)

Примечание. Вы не можете использовать makeRequest () с тип = "URL" гаджеты.

Независимо от типа данных, которые они выбирают, вызовы makeRequest () имеют одинаковые характеристики:

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

Например, рассмотрим следующий фрагмент кода, который извлекает удаленный контент как текст. Этот код выбирает HTML-текст веб-страницы google.com и отображает первые 400 символов:

Этот пример иллюстрирует основные принципы работы makeRequest ():

1. Когда вызывается makeRequest (), API гаджетов отправляет асинхронный HTTP-запрос GET на URL-адрес, переданный в функцию (в этом примере URL-адрес http://www.google.com).
2. makeRequest () сразу возвращается, а затем вызывает функцию обратного вызова позже (в этом примере она называется response ()), когда выборка заканчивается. Это означает, что вы должны поместить любой зависимый код в функцию обратного вызова или в функции, вызываемые функцией обратного вызова.
3. makeRequest () возвращает объект JavaScript со следующей структурой:

Этот объект предоставляется в качестве единственного аргумента функции обратного вызова. Функция обратного вызова выполняет некоторые операции с возвращенными данными. Обычно он извлекает части данных, комбинирует их с разметкой HTML и отображает полученный HTML-код в гаджете.

Работа с разными типами контента

По умолчанию содержимое удаленного веб-сайта возвращается в виде текста. Вы можете использовать поле opt_params для установки типа содержимого возвращаемого содержимого одним из следующих:

• ТЕКСТ - gadgets.io.ContentType.TEXT
• DOM - gadgets.io.ContentType.DOM
• КОРМИТЬ - gadgets.io.ContentType.FEED
• JSON - gadgets.io.ContentType.JSON

Работа с текстом

Вот пример, который выбирает данные из файла CSV (значение, разделенное запятыми) и использует его для заполнения списка личных контактов. Он показывает, как вы устанавливаете тип содержимого извлекаемого содержимого в необязательных параметрах. В функции обратного вызова response (obj) текстовое значение извлекается из obj с использованием obj.text:

Работа с XML

Объектная модель документа (DOM) API для навигации по документам HTML и XML Вы можете использовать makeRequest () для извлечения XML-документа как объекта DOM. Получив объект, вы можете работать с ним, используя стандартные функции JavaScript DOM. Как правило, это означает извлечение нужных данных из файла XML, объединение их с разметкой HTML и CSS и отображение полученного HTML в вашем гаджете.

При использовании DOM веб-контент анализируется в виде дерева узлов. Например, рассмотрим следующий фрагмент HTML:

Этот фрагмент иллюстрирует основные типы узлов, обсуждаемые в этом разделе:

• Элемент узлов. Узлами элемента в этом фрагменте являются «a» и «b». Узлы элементов являются строительными блоками, которые определяют структуру документа.
• Текстовые узлы. Текстовые узлы в этом фрагменте - это «Google», «fast» и «home page». Текстовые узлы всегда содержатся внутри узловых элементов. Они являются дочерними узлами узла содержащего элемента.
• Атрибуты узлов. Этот фрагмент имеет один атрибутный узел: href = 'http: //www.google.com'. Узел атрибута предоставляет дополнительную информацию о своем узле содержащего элемента. Однако атрибуты не считаются дочерними узлами элемента, который их содержит, что влияет на то, как вы работаете с ними. Для более подробного обсуждения этой темы см. Работа с разными типами узлов ,

Это структура DOM для фрагмента HTML:

Чтобы получить доступ к данным в DOM-объекте, вы «обходите дерево», используя функции DOM для навигации по отношениям родительского-дочернего узла, чтобы получить нужные данные.

пример

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

Узлы имени, цены и калорий содержат свои собственные «текстовые» дочерние узлы. Каждый узел описания содержит дочерний узел CDATA. CDATA - это отдельный тип узла. Разделы CDATA используются для экранирования блоков текста, содержащих символы, которые в противном случае считались бы разметкой, например угловые скобки. Единственный разделитель, который распознается в разделе CDATA, - это строка «]]>», которая завершает раздел CDATA.

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

В следующем коде показано, как пройтись по дереву DOM для извлечения данных из разных типов узлов и как объединить данные с разметкой HTML и CSS для отображения в гаджете меню завтрака.

Этот пример кода иллюстрирует четыре основные функции, которые вы используете для взаимодействия с данными DOM:

• getElementsByTagName (tagname) - Для документа DOM возвращает массив узлов элементов, имена которых совпадают с tagname. Вы можете получить все узлы элемента в файле, используя подстановочный знак (*), например: response.getElementsByTagName ("*").
• getElementById (id) - для документа DOM извлекает один узел по идентификатору.
• getAttribute (attrib) - для узла элемента возвращает атрибут attrib. Например: response.getElementsByTagName ("menu"). Item (0) .getAttribute ("title").
• Атрибуты - для узла элемента возвращает массив атрибутов узла.

В этом примере показаны только несколько различных функций для навигации по дереву DOM. Некоторые из других, которые вы можете попробовать, включают lastChild, nextSibling, previousSibling и parentNode.

Работа с разными типами узлов

Ключом к эффективной работе с DOM является понимание иногда тонких различий между различными типами узлов.

Другие источники

Работа с каналами

Вы можете добавить канал на свою страницу iGoogle, введя его URL в форму « Добавить по URL» в каталоге содержимого. При этом используется встроенная поддержка фидов API гаджетов, чтобы создать гаджет для фида и добавить его в iGoogle. Его легко использовать, но он не позволяет вам выполнять какую-либо настройку содержимого или отображения. Кроме того, вы не можете использовать его с другими контейнерами.

Для более сложной обработки каналов вы можете использовать метод makeRequest () и указать тип содержимого FEED. Запросы каналов пытаются проанализировать XML-канал ATOM или RSS и вернуть ответ в виде объекта в кодировке JSON.

С типом контента FEED вы можете указать следующие параметры:

Вот поля в объекте фида JSON:

• Заглавие. Название этой записи канала.
• Ссылка на сайт. URL этой записи фида.
• Резюме. Содержание или сводка этой записи фида.
• Дата. Отметка времени для этой записи в секундах с 1 января 1970 года. Чтобы преобразовать ее в миллисекунды, необходимые для инициализации объекта JavaScript Date с правильной датой, умножьте его на 1000. См. Пример кода гаджета ниже для примера.

Например, рассмотрим этот канал RSS:

Если вы выбираете вышеупомянутый канал с типом содержимого FEED, возвращаемое значение кодируется в виде строки JSON следующим образом:

В следующем примере показано, как использовать makeRequest () для получения канала и отображения частей его данных в гаджете. Вот гаджет. Он получает канал, содержащий записи с форума разработчиков гаджетов. Это позволяет пользователям указывать:

• Количество записей для отображения
• Должен ли гаджет отображать дату для каждой записи
• Должен ли гаджет отображать сводку для каждой записи

Это код для примера:

Работа с JSON

JSON (JavaScript Object Notation) - это формат обмена данными, позволяющий кодировать определенные типы объектов (массивы и коллекции пар ключ-значение) в виде строк, которые можно легко передавать. Вы можете использовать тип содержимого JSON для извлечения содержимого в кодировке JSON в виде объекта JavaScript.

Гаджет ниже извлекает контент из текстового файла, который содержит следующую строку в кодировке JSON:

При извлечении содержимого из текстового файла, содержащего эту строку, возвращаемое значение представляет собой объект JavaScript, содержащий пары ключ-значение (то есть ассоциативный массив). Этот пример извлекает объект и затем распечатывает содержащиеся в нем пары ключ-значение. Если значение является массивом (как указано в квадратных скобках []), оно превращает содержимое массива в маркированный список:

Это вывод гаджета:

Имя: Роуэн
Порода: Лабрадор ретривер
Хобби:

• выборка
• плавание
• дергать
• принимать пищу

Подробнее о JSON

API гаджетов предоставляет метод gadgets.json.stringify () для кодирования объекта в виде строк JSON и метод gadgets.json.parse () для преобразования строки JSON в объект. Обратите внимание, что, поскольку OpenSocial выполняет автоматическое экранирование HTML всех возвращаемых данных, включая данные приложения, перед их синтаксическим анализом необходимо отсоединить строковые объекты JSON в хранилище приложений, например: gadgets.util.unescapeString (jsondata).

В этом примере создается массив JavaScript, кодируется его как строка JSON, а затем преобразуется строка JSON обратно в объект Array:

Вывод этого гаджета выглядит следующим образом:

Установка типа авторизации

API гаджетов поддерживает следующие типы авторизации:

• gadgets.io.AuthorizationType.OAUTH (контейнер использует Протокол OAuth )
• gadgets.io.AuthorizationType.SIGNED (запрос подписан контейнером)
• gadgets.io.AuthorizationType.NONE (по умолчанию)

То, как вы используете эти методы, зависит от вашего контейнера. Вот один пример использования подписанного типа авторизации, характерного для Orkut. Для обсуждения использования OAuth в гаджетах см. Написание гаджетов OAuth ,

методы

makeRequest () позволяет вам выбирать между методами HTTP GET и POST.

ПОЛУЧИТЬ

Как правило, вы используете GET для получения информации с веб-сайта. GET является режимом по умолчанию для makeRequest (), но вы можете явно сделать запрос GET следующим образом:

Чтобы передать параметры на ваш сервер в GET-запросе, просто добавьте их в строку запроса при выполнении запроса:

СООБЩЕНИЕ

POST-запросы обычно используются для передачи данных на сервер с целью изменения или удаления записей. Вы можете передавать большие объемы данных в запросе POST, чем вы обычно можете сделать с помощью запроса GET.

POST может быть выполнен с использованием следующего кода:

Помимо указания МЕТОДА в параметрах opt_params для этого запроса, вы должны указать параметр под ключом gadgets.io.RequestParameters.POST_DATA. Кодировка по умолчанию для POST - application / x-www-form-urlencoded, что означает, что значение параметра POST_DATA должно представлять собой серию пар «ключ / значение» в формате urlencoded, соединенных с амперсандами (&). Чтобы упростить преобразование объектов данных в этот формат, предусмотрена функция gadgets.io.encodeValues. encodeValues ​​принимает объект JavaScript и возвращает закодированную строку, подходящую для параметра POST_DATA.

Например, работает:

производит строку:

Эта строка может быть передана непосредственно как значение для gadgets.io.RequestParameters.POST_DATA.

Обновление кеша

Если вы используете makeRequest () для извлечения контента, который обновляется более одного раза в час, например данных фида, вы можете не получить последние обновления. Это потому, что ваши результаты кэшируются, чтобы ваш гаджет работал быстрее. Если вы хотите быть уверены, что ваш гаджет содержит самые последние данные, вы можете использовать параметр refreshInterval для обхода кэша и принудительного обновления в указанный интервал. Другими словами, кэш обновляется каждые X секунд, где X = refreshInterval.

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

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

Поскольку содержимое обновляется по умолчанию каждый час, имеет смысл указывать интервал менее часа. Рекомендуемый диапазон для refreshInterval - больше 60 и меньше 3600.

Вернуться к началу

Похожие

Комментарии