Заполнение и отправка форм в Dart

Получение данных из форм

20 February 2014 г. 12:50:00

Многие веб приложения используют формы чтобы для сбора данных и отправки данных на сервер. Формы обычно содержат несколько элементов для ввода данных различного типа, например имени, адреса, даты рождения email адрес и так далее. HTML поддерживает несколько типов элементов ввода включая текстовые поля, радио кнопки и чекбоксы. В HTML5 добавлено больше специальных элементов, таких как email, поле для пароля, выбор цвета, виджеты для отображения даты и времени, бегунки.

Главный пример этого руководства содержит клиенскую и серверную часть. Клиентская часть использует Polymer для предоставления пользовательского интерфейса (формы содержат множество типов элементов ввода) и интерфейс синхронизации данных с Dart. Клиент и сервер общаются используя некоторые классы из различных библиотек, включаю потоки, флючерсы, HttpRequest и так далее. Сервер использует заголовки CORS для использования кросс-доменных запросов.

Замечание эта статья основывается на том что вы прочитали в разделах: Cоздание собственных элементов, Использование API для фьючерсов Динамическая обработка данных, а так же вы должны быть знакомы с библиотекой Polymer, фьючерсами, JSON и HttpRequest.

Общая информация о формах

Пример slambook в частности

Отправка данных формы

Сброс данных из формы

Создание серверной части и прослушивание порта

Обработка запросов OPTIONS

Настройка CORS заголовков

Обработка POST запросов

Совет для разработки клиент-серверного веб приложения

Двухсторонняя привязка данных используя Polymer

Общая информация о формах

У форм есть свойство action, представляющий собой URL для отправки данных формы, и method который определяет как данные должны быть отправлены. Свойства action и method могут быть определены непосредственно в HTML, или в более сложном случае или чтобы получить больше контроля, Вы можете написать код Dart и использовать библиотеки Dart для предоставления этих свойств программно

Давайте начнем с основ, только с HTML форм, чтобы разобраться в свойствах action и method элементов ввода и понять стандартное поведение форм. Форма ниже, заключенная в тэг <form>, используется для поиска данных, введенных пользователем, в Google. Информация ищется по сайту, если чекбокс выбран (и в интернете если нет). Этот пример, названный search_form, по умолчанию ищет полезные ресурсы “cookbook” на сайте dartlang.org.

вот HTML код для создания формы:

<form action="http://www.google.com/search"
  method="GET"
  target="_blank">
…
</form>

Использование атрибутов action и method.

АтрибутОписание
action URL куда будет отправлен запрос. В этом примере, URL определен на использование поиска Google. Когда пользователь нажимает кнопку, параметры поиска добавляются к URL
method Каким образом будет отправлен запрос. В общем, вы должны использовать GET для запроса данных и POST для отправки данных

А вот HTML код которые добавляет в форму три элемента ввода - текстовое поле, кнопка отправки и чекбокс.

<input   type="text"     name="q"
                         value="Cookbook" size="31" maxlength="255">
<input   type="submit"   value="Google Search">
<label>
  <input type="checkbox" name="sitesearch"
                         value="dartlang.org" checked> Search dartlang.org<br>
</label>

Чекбокс обернут в тэг label, поэтому вы можете нажимать как на сам чекбокс так и на заголовок, чтобы изменить значение.

Этот HTML код предоставляет некоторое автоматическое поведение.

**<input type=”submit”...>**

Создает специальную кнопку, нажатие которой вызывает отправку данных формы. На основании атрибутов action и method, кнопка формирует запрос и отправляет его на сервер по указанному URL.

**name=q**
**name="sitesearch"**

определяет имя текстового поля и имя чекбокса.

Для элементов внутри формы, у которых указано имя предоставляют данные для этой формы. В данном примере, значение предоставляемое текстовым полем это значение для q, а чекбокс предоставляет значение для sitesearch, оба этих параметра являются частью корректного URL для запроса Google. Когда пользователь нажимает кнопку, имя и соответствующее значение добавляется к URL для поиска. Вот пример запроса:

http://www.google.com/search?q=Cookbook&sitesearch=dartlang.org

Этот пример полностью создан без использования кода Dart или Javascript. Потому как он очень прост, он может использовать обычное поведение HTML: публично доступный и прост для формирования URL, а так же обычный GET запрос. Для форм, которые содержать большое количество данных, или для web приложения, которое общается со специализированным сервером, вам обычно надо обрабатывать форму программно.

Следующий пример показывает более сложную форму, которая программно отправляет данные на сервер, используя POST запрос.

Пример slambook в частности

Этот раздел включает две программы в качестве основных примеров.

  • Первая, это обычная серверная программа, названная slambookserver, которая слушает на локальном компьютере порт 4040 и обрабатывает запросы POST и OPTIONS создавая сообщения и отправляя подтверждение клиенту. Сервер использует заголовки CORS для того чтобы разрешить приложению использовать запросы отправленные с других серверов.

  • Вторая, это клиентская программа, названная slambook, предоставляющая форму, в которой пользователь может вводить информацию. Эта программа использует Polymer для двойной связи данных, между элементами ввода и переменными Dart. Когда пользователь нажимает кнопку, код Dart преобразует данные в строку JSON, отправляет запрос OPTIONS чтобы получить разрешение сервера, а затем отравляет POST запрос для отправки данных. Когда запрос от сервера получен, он отображается клиенту.

Следующая диаграмма показывает последовательность общения между сервером и клиентом в данном примере.

Клиентское и серверное приложение

Попробуйте! Введите любые данные и нажмите кнопку Отправить.

Приложение slambook

Замечание о версии. Приложение slambook совместимо с polymer.dart 0.9.

Запрос возвращает сообщение “No server” потому что вы не запустили сервер на своей машине. Давайте это исправим.

Запуск сервера

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

Запустите серверную программу из командной строки

% dart slambookserver.dart
Listening for GET and POST on http://127.0.0.1:4040

Теперь Вы снова можете попробовать отправить данные из приложения slambook выше.

Замечание: Если какая-то другая программа уже использует порт 4040, сервер вернет сообщение об ошибке и завершит выполнение. Программа на этой странице рассчитывает что slambookserver будет расположен на локальной машине, порт 4040. Поэтому чтобы приложение могло работать вы должны завершить другой процесс и снова запустить slambookserver. Или вы можете изменить номер порта в серверной и клиентской программе. Избегайте использования 3030, так как его использует Dart Editor. Затем запустите клиент и сервер на вашем локальном компьютере.

Оставшаяся часть этого руководства поясняет код сервера и клиента.

О клиентской части Вы узнаете об:

  • Отправке данных формы

  • Сброс формы

  • Использовании Polymer для связи данных формы

Серверная часть в этом разделе расскажет о:

  • Заголовках CORS

  • Обработке запросов OPTIONS

  • Обработке запросов POST

Отправка данных формы

Первым делом давайте взглянем на то как данные отправлены на сервер.

Напомним что пример search_form был основан на использовании атрибутов action и method для задания назначения и метода, для отправки формы. Также напомним что пример search_form основывается на автоматическом поведении специальной кнопки отправки. С другой стороны, пример slambook принимает непосредственное участие в процессе отправки:

  • Во-первых в форме не определен ни action ни method

  • Во-вторых у кнопки отправки данных есть обработчик нажатия в Dart

  • В-третьих обработчик нажатия переопределяет автоматическое поведение кнопки отправки

  • И наконец данные формы отправляются на сервер при помощи библиотек Dart

Форма в примере slambook представлена пользовательским элементом tute-slambook-form, который представлен следующим кодом HTML:

<div class="container">
  <form is="tute-slambook-form" id="slambookform"></form>
</div>

Обратите внимание на отсутствие атрибутов action и method. Вместо этого поведение кнопки отправки определено в обработчике нажатия кнопки в Dart. Ниже представлен HTML код, который создает кнопку отправки и связывает ее с обработчиком Dart.

<div class="submitarea">
  <input type="submit" value="Submit" on-click="{{submitForm}}">
  …
</div>

А вод и сам код обработчика нажатия кнопки submitForm():

Выполнение запроса на сервер

Давайте рассмотрим каждый элемент кода обработчика

Отмена стандартного обработчика

Это событие без атрибутов action и method, кнопка отправки содержит автоматическое поведение, которое не нужно в примере slambook. Поэтому в первой строке кода обработчика вызывается e.preventDefault(), чтобы отменить поведение кнопки по умолчанию.

void submitForm(Event e) {
  e.preventDefault(); // Don't do the default submit.
  …
}

Настройка и отправка POST запроса

Следующая часть кода создает объект HttpRequest. В этом коде используется new чтобы создать экземпляр объекта HttpRequest, который используется чтобы настроить и отправить POST запрос. Класс HttpRequest имеет соответствующую функцию getString(), чтобы Вы могли использовать и отправлять обычные GET запросы к URL.

Следующая строка предоставляет объекту HttpRequest колбэк функцию, названную onData, которая вызывается при получении ответа от сервера. Мы рассмотрим детали объявления функции onData() позже.

Важно: Вы должны зарегистрировать колбэк функцию до отправки запроса!

request = new HttpRequest();
request.onReadyStateChange.listen(onData);

var url = 'http://127.0.0.1:4040';
request.open('POST', url);
request.send(slambookAsJsonData());

Далее в коде открывает POST запрос используя хост и порт, соответствующий тем которые использует серверная часть slambookserver.

И наконец функция отправляет данные формы на сервер в виде JSON строки. Иногда данные отправляются по частям. Но этот пример достаточно мал, чтобы данные отправлялись за раз. Этот запрос является асинхронным, поэтому метод send() завершится как только запрос будет отправлен.

Ожидание ответа от сервера

Объект HttpRequest общается с сервером. Вы можете получить состояние используя поле readyState объекта HttpRequest. Состояние готовности может принимать пять различных значений: не отправлено (unsent), открыто (opened), заголовки получены (headers received), загрузка (loading) и выполнено (done). Когда состояние готовности меняется, HttpRequest вызывает событие, и вызывается колбэк функция onData().

Напомним строчку кода, в которой регистрируется обработчик события onReadyStateChange:

request.onReadyStateChange.listen(onData);

Единственным требуемым аргументом метода listen() является колбэк функция с сигнатурой: void onData(T). Метод listen() также позволяет вам определить три дополнительных аргумента, например обработчик ошибок.

Ниже колбэк функция onData():

void onData(_) {
  if (request.readyState == HttpRequest.DONE &&
      request.status == 200) {
    // Data saved OK.
    serverResponse = 'Server Sez: ' + request.responseText;
  } else if (request.readyState == HttpRequest.DONE &&
      request.status == 0) {
    // Status is 0...most likely the server isn't running.
    serverResponse = 'No server';
  }
}

Первым делом в коде проявляется завершился ли успешно запрос. Если да то содержание ответа помещается в строку названную serverResponse, которая привязана к значению элемента textarea приложения slambook. При изменении строки интерфейс пользователя будет автоматически обновлен, о сообщение будет показано пользователю.

Если запрос выполнен с ошибкой, то программа выведет в serverResponse сообщение об ошибке, которое будет показано пользователю.

Сброс данных из формы

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

void resetForm(Event e) {
  e.preventDefault();
  favoriteThings['kittens'] = false;
  favoriteThings['raindrops'] = false;
  favoriteThings['mittens'] = false;
  favoriteThings['kettles'] = false;

  theData['firstName'] = '';
  theData['favoriteQuote'] = '';
  theData['favoriteColor'] = '#FFFFFF';
  theData['birthday'] = '2013-01-01';
  theData['volume'] = '0';
  theData['catOrDog'] = 'cat';
  theData['music'] = 0;
  theData['zombies'] = false;
  serverResponse = "Data reset.";
}

Создание серверной части и прослушивание порта

Теперь давайте обратим рассмотрим серверную часть, которая называется slambookserver, она возвращает HTTP ответ, на запрос отправленный из клиентского приложения slambook. Код серверной части основывается на статье [Использование Dart для создания JSON Web сервисов (#)

Сервер слушает порт 4040 на локальной машине и обрабатывать только запросы типа POST и OPTIONS. Оба типа запросов используют для разрешения доступа CORS заголовки. Для POST запросов, сервер возвращает короткое сообщение о подтверждении, которое включает данные в формате JSON которые он получил из запроса.

Давайте взглянем на код.

Функция main() приложения slambookserver приведена полностью чуть ниже. Используя класс HttpServer приложение slambookserver начинает прослушивание порта 4040 локальной машины после вызова функции верхнего уровня bind()

final HOST = '127.0.0.1';
final PORT = 4040;

void main() {
  HttpServer.bind(HOST, PORT).then(gotMessage, onError: printError);
}

Функция bind() возвращает фьючерс, при помощи которого можно получить значение в будущем (больше информации будет буквально через минуту). Функция then() регистрирует две колбэк функции в виде фьючерса. Первая функция gotMessage(), вызывается когда фьючерс получает значения. Вторая printError вызывается при неудачной попытке соединения. Ошибка может возникнуть, например, если другая программа уже слушает тот-де порт.

Фильтрация запросов и вызов остальных методов для обработки каждого типа запроса функции gotMessage() ниже.

void gotMessage(_server) {
  _server.listen((HttpRequest request) {
    switch (request.method) {
      case 'POST':
        handlePost(request);
        break;
      case 'OPTIONS':
        handleOptions(request);
        break;
      default: defaultHandler(request);
    }
  },

  onError: printError); // Listen failed.
  print('Listening for GET and POST on http://$HOST:$PORT');
}

Для обработке других типов запросов, таких как GET, вы можете просто добавить больше значений в case например case ‘GET’.

Немного о фьючерсах.

Давайте немного рассмотрим фьючерсы, до того как будем разбираться с кодом обработки POST и OPTIONS запросов.

Фьючерс представляет способ получения значения через некоторое время в будущем. Вы используете фьючерсы для предотвращения блокировки программы пока она ожидает данные, например если необходимы долгие вычисления для предоставления значения, или если значение должно быть прочитано или получено с использованием ввода/вывода.

Когда вызывается функция возвращающая фьючерс, происходит две вещи

  • Функция помещается в очередь на выполнение и немедленно возвращает незавершенный объект фьючерс.

  • Позже, когда значение получено, объект фьючерса завершается с полученным значением или с ошибкой.

Чтобы получить значение возвращаемое фьючерсом используется метод then() для регистрации колбэка.

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

Обработка запросов OPTIONS

С помощью класса HttpRequest, клиентское приложение slambook отправляет запросы, когда пользователь нажимает кнопку “отправить”. Вы видели код ранее в этой статье.

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

Сервер получает предварительный запрос OPTIONS до того как получает основной запрос. Вот код приложения slambookserver который обрабатывает OPTIONS запросы.

void handleOptions(HttpRequest req) {
  HttpResponse res = req.response;
  addCorsHeaders(res);
  print('${req.method}: ${req.uri.path}');
  res.statusCode = HttpStatus.NO_CONTENT;
  res.close();
}

Этот код выполняет следующее:

  • Получает объект HttpResponse, который заботится о том чтобы сервер послал ответ клиенту

  • Добавляет CORS заголовки для управления доступом

  • Выводит сообщение в консоль

  • Сигнализирует о том, что у ответ нет содержания

  • Завершает ответ, который будет отправлен клиенту.

Когда клиент получает запрос, CORS заголовок сигнализирует о том, запросы POST будут приняты.

Настройка CORS заголовков

Серверное приложение использует следующую функцию для добавления в ответ CORS заголовков для OPTIONS и POST запросов. Функция добавляет ответ сервера три заголовка Access-Control (которые включаются в ответ HttpResponse).

void addCorsHeaders(HttpResponse res) {
  res.headers.add('Access-Control-Allow-Origin', '*, ');
  res.headers.add('Access-Control-Allow-Methods', 'POST, OPTIONS');
  res.headers.add('Access-Control-Allow-Headers',
      'Origin, X-Requested-With, Content-Type, Accept');
}

Первые две строки CORS заголовка разрешают запросы POST и OPTIONS из любых источников. Третий определяет тип запросов POST и OPTIONS сервер разрешает принимать запросы только с определенными заголовками.

Обработка POST запросов

Вот функция, которая обрабатывает клиентские POST запросы.

void handlePost(HttpRequest req) {
  HttpResponse res = req.response;
  print('${req.method}: ${req.uri.path}');

  addCorsHeaders(res);

  req.listen((List<int> buffer) {
    // Return the data back to the client.
    res.write('Thanks for the data. This is what I heard you say: ');
    res.write(new String.fromCharCodes(buffer));
    res.close();
  },

  onError: printError);
}

Так же как и запрос OPTIONS, slambookserver получает объект HTTP ответа из запроса, выводит сообщение в консоль и добавляет CORS заголовки к ответу.

Далее в этом коде прослушиваются данные из клиентского запроса POST. Если все данные готовы, вызывается колбэк функция. Эта функция написана в то же месте. Аргументом функции является список чисел, включающий все данные. Каждое число представлено кодом, который может быть представлен в виде символа UTF-16. Но вам не надо беспокоиться об этом, потому что Вы можете просто вызвать метод String.fromCharCodes для конвертации в обычную строку.

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

При закрытии потока, объект HttpResponse отправляет данные клиенту.

Совет для разработки клиент-серверного веб приложения

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

Вот образец того что должна выполнять клиентская часть.

  • Использовать формы для сбора данных пользователя.

  • Помещать поля ввода в ваши формы, для отдельных элементов данных.

  • Использовать Polymer для обратной связи, чтобы данные формы были синхронизированы с кодом Dart.

  • Отправлять данные напрямую (свойства формы action и method)

  • Или программно (переопределяя стандартное поведение кода Dart кнопки отправки)

  • Создавать объект ответа на сервере из объекта HttpRequest.

  • Обрабатывать данные асинхронно используя фьючерсы.

А вот что должен делать сервер.

  • Использовать HttpServer для настройки сервера и прослушивания порта.

  • Обрабатывать ответы.

  • Использовать заголовки CORS чтобы разрешить каждый запрос.

  • Ответ на запрос использует HttpResponse.

  • Обрабатывать данные асинхронно используя фьючерсы.

Использовать потоки для записи данных в ответ.

Эти ресурсы по большей части на основе библиотек Dart, предоставляющих поддержку для написания клиентов и серверов. Учтите что бывает два класса HttpRequest: один в dart:html (для клиентов) и второй dart:io (для серверов).

РесурсБиблиотекаОписание
HttpRequest dart:html Клиентская часть HTTP запроса
HttpRequest dart:io Серверная часть HTTP запроса
HttpServer dart:io Серверная часть обрабатывающее HTTP связь с сервером
HttpResponse dart:io Серверная часть которая заботится об отправке ответов на запрос
Streams dart:async Поток данных
Future dart:async Способ получать данные асинхронно
JSON dart:convert Объявление преобразования в JSON по умолчанию
Polymer Polymer Пользовательские элементы, данные связанные с шаблоном

Двухсторонняя привязка данных используя Polymer

Пример slambook использует Polymer для обратной связи, значения элемента ввода с переменными Dart. Если пользователь меняет значение элемента ввода, связанная переменная в коде Dart меняется автоматически. Или если значение меняется в коде Dart, связанный объект пользовательского элемента обновляется автоматически. Статья определение пользовательских элементов предоставит больше деталей о связывании данных и о Polymer.

Этот пример так же использует объявление обработки событий для перехватывания и обработки функций для элементов ввода.

При помощи примера slambook вы можете рассмотреть используется двунаправленное связывание данных для различных элементов ввода, включая новые элементы HTML5. Эта таблица объединяет все двунаправленные атрибуты, которые вы можете использовать с помощью Polymer:

АтрибутТип данныхЭлемент ввода
value String Любой
selectrdIndex integer элемент <select> который разрешает выбор только одного элемента
checked bool отдельная радиокнопка или чекбокс

Использование атрибута value в любом элементе ввода

Атрибут value работает в любых элементах ввода и связывает значение со строкой Dart. Этот пример использует value для тактового поля, поля ввода текста, выбора цвета, выбора даты и выбора диапазона.

Связывание атрибута value со строкой Dart

(Отметим что некоторый код вокруг, например <label> был убран для большей читаемости кода)

Словарь в коде Dart названный theData содержит данные формы. Код объекта словаря выделяется при помощи @observable и вызывает toObservable() для связывания.

Словарь содержит пары ключ/значение для каждого элемента ввода, где ключ является строкой. Значения элементов связанных с value являются строками. HTML ссылается на элементы словаря используя их имена (идентификаторы) в Dart. Например значение элемента выбора цвета связано с theData[‘favoriteColor’].

Использование selectedIndex в выпадающем меню

Элемент <select> соденжит один или более элементов <option>, но по умолчанию за раз может быть выделен только один из них. Выбор одного элемента обычно объявляется в виде выпадающего списка. Вы можете использовать атрибут selectedIndex для связи переменной Dart типа integer с выпадающим списком. Число отображает индекс выбранного элемента. Индекс начинается с 0.

Использование checked в чекбоксах

Вы можете использовать атрибут checked булевой переменной Dart с отдельным чекбоксом. Здесь каждый чекбокс связан с отдельной булевской переменной.

Использование свойства checked для связи с переменной boolean


Оставьте свой комментарий

comments powered by Disqus
Меню

Cult of digits 2014 Яндекс.Метрика