HTML 5: Пример использования knockout или JsSite как стартовая архитектура для сайта

Зачем

Для того чтобы начать приложение на HTML5 с использованием knockout мне обычно приходилось устанавливать некоторое количество nuget-пакетов, потом создавать некоторое подобие архитектуры, каждый раз копируя придумывая всё заново. Конце-концов, я довел до ума свой собственный nuget-пакет, который как раз для этого и задумывался.

Итак, для чего? Чтобы установив один nuget-пакет, сразу приступить к разработке сайта с использованием Knockout и всех сопутствующих библиотек (маппинг, валидаци и всё такое).

Пример клиента Twitter

Задача: Надо сделать форму поиска твитов для отправки запроса к Twitter.com.

Первым делом: Создаю новый проект MVC4, запускаю обновление всех пакетов. Я делаю это из консоли Nuget Manager. Лог обновления показывать не буду, ибо нет смысла.

Далее устанавливаю свой пакет JsSite. В логе установки видно, что вместе с ним устанавливается пачка пакетов (простите за каламбур):

PM> install-package jssite
Attempting to resolve dependency 'toastr (≥ 1.1.4.2)'.
Attempting to resolve dependency 'jQuery (≥ 1.6.3)'.
Attempting to resolve dependency 'AmplifyJS (≥ 1.1.0)'.
Attempting to resolve dependency 'knockoutjs (≥ 2.2.1)'.
Attempting to resolve dependency 'Knockout.Mapping (≥ 2.4.0)'.
Attempting to resolve dependency 'underscore.js (≥ 1.4.3)'.
Attempting to resolve dependency 'Moment.js (≥ 1.7.2)'.
Successfully installed 'toastr 1.1.4.2'.
Successfully installed 'AmplifyJS 1.1.0'.
Successfully installed 'knockoutjs 2.2.1'.
Successfully installed 'Knockout.Mapping 2.4.0'.
You are downloading underscore.js from Jeremy Ashkenas, the license agreement to which is available at https://github.com/documentcloud/underscore/blob/master/LICENSE. Check the package for additional dependencies, which may come with their own license agreement(s). Your use of the package and dependencies constitutes your acceptance of their license agreements. If you do not accept the license agreement(s), then delete the relevant components from your device.
Successfully installed 'underscore.js 1.4.3'.
Successfully installed 'Moment.js 1.7.2'.
Successfully installed 'JsSite 0.3.2'.
Successfully added 'toastr 1.1.4.2' to JsSitePackageDemo.
Successfully added 'AmplifyJS 1.1.0' to JsSitePackageDemo.
Successfully added 'knockoutjs 2.2.1' to JsSitePackageDemo.
Successfully added 'Knockout.Mapping 2.4.0' to JsSitePackageDemo.
Successfully added 'underscore.js 1.4.3' to JsSitePackageDemo.
Successfully added 'Moment.js 1.7.2' to JsSitePackageDemo.
Successfully added 'JsSite 0.3.2' to JsSitePackageDemo.

PM>

Итак, в папке Scripts/App уже есть всё необходимое.

Вторым делом: Наверное есть необходимость описать содержимое файов.

• site.bindingHandlers.js – содержит custom binding handlers (расширения knockout, для связывания данных). В планах постоянно пополнять и расширять существующий набор.
• site.core.js – основное ядро, “запускатель” (bootstrapper), в котором определные все разделы (namespaces).
• site.controls.js – компоненты, управляемые контролы (controls), которые опять же расширяют функционал фреймфорка. Контролы собираются с просторов сети, а так же переносятся из других моих проектов.
• site.services.js – в этом файле пример сервиса. Для работы с ajax-запросами используется amplify.js, меня подкупил тот факт, что даже запросами можно управлять (кэш, обработка результатов и т.д.)

Представление (View)

Дело №3: Прежде чем приступить описанию viewModel’а, подготовлю представление. Вот так оно должно выглядеть перед тем как сделать запрос на поиск:

Теперь разметка (весь код Index.cshtml):

   1:  @{

   2:      ViewBag.Title = "Демо: Knockout paging";

   3:  }

   4:   

   5:  <h1>DEMO: JsSite (Knockout) 

   6:      <span data-bind="text: clock.time"></span>

   7:  </h1>

   8:  <h3>EXAMPLE: using package for create Twitter search</h3>

   9:  <p>

  10:      <label>Twitter search:</label>

  11:      <input data-bind="value: term" />

  12:      <button data-bind="click: search">search</button>

  13:  </p>

  14:  <div data-bind="blockUI: indicator">

  15:      <table>

  16:          <thead>

  17:              <tr>

  18:                  <th>найдено</th>

  19:              </tr>

  20:          </thead>

  21:          <tbody>

  22:              <!-- ko foreach: items -->

  23:              <tr>

  24:                  <td>

  25:                      <img data-bind="attr: {'src': profile_image_url}" />

  26:                      <span data-bind="date: created_at"></span>

  27:                      <span data-bind="html: decodeURI(text())"></span>

  28:                      <span data-bind="text: source"></span>

  29:                      <div data-bind="html: source"></div>

  30:                  </td>

  31:              </tr>

  32:              <!-- /ko -->

  33:          </tbody>

  34:      </table>

  35:  </div>

  36:   

  37:  @section scripts

  38:  {

  39:      <script src="~/Scripts/moment.min.js"></script>

  40:      <script src="~/Scripts/amplify.js"></script>

  41:      <script src="~/Scripts/toastr.min.js"></script>

  42:   

  43:      <script src="~/Scripts/knockout-2.2.1.debug.js"></script>

  44:      <script src="~/Scripts/knockout.mapping-latest.js"></script>

  45:  

  46:      <script src="~/Scripts/app/site.core.js"></script>

  47:      <script src="~/Scripts/app/site.bindingHandlers.js"></script>

  48:      <script src="~/Scripts/app/site.services.js"></script>

  49:      <script src="~/Scripts/app/site.controls.js"></script>

  50:      <script src="~/Scripts/app/site.vm.indexPage.js"></script>

  51:  }

Введу слово “calabonga”  и нажму кнопку поиска. Пока идет поиск твитов, сайт закрывается “шторкой” с анимацией.

Возможно сильно бросается в глаза тот факт, что я не очень заморачивался на дизайне.

ViewModel для представления

Дело четвертое: Последним файлом, который я не описал, рассказывая про папку App является ViewModel, который я уже создал чтобы реализовать поставленную задачу. По большому счеты, это и есть пример использования JsSite.

Вот, опять же, весь код основного файла:

   1:  /// <reference path="../jquery-1.9.1.js" />

   2:  /// <reference path="../knockout-2.2.1.debug.js" />

   3:  /// <reference path="site.core.js" />

   4:  /// <reference path="site.controls.js" />

   5:  /// <reference path="site.services.js" />

   6:  /// <reference path="../knockout.mapping-latest.debug.js" />

   7:   

   8:  $(function () {

   9:   

  10:  "use strict";

  11:   

  12:      site.vm.home_index = function () {

  13:   

  14:  var clock = new site.controls.Clock(),

  15:              term = ko.observable(),

  16:              indicator = new site.controls.BusyIndicator(),

  17:              items = ko.observableArray([]),

  18:              search = function () {

  19:                  indicator.isbusy(true);

  20:                  site.services.twitter.search(term(), {

  21:                      success: function (json) {

  22:                          site.logger.success("Loaded items: "+json.results.length);

  23:                          ko.mapping.fromJS(json.results, {}, items);

  24:                          indicator.isbusy(false);

  25:                      },

  26:                      error: function (message, status) {

  27:                          site.logger.error(status);

  28:                          indicator.isbusy(false);

  29:                      }

  30:                  });

  31:              };

  32:  

  33:   

  34:  return {

  35:              term:term,

  36:              search: search,

  37:              items:items,

  38:              indicator: indicator,

  39:              clock: clock

  40:          };

  41:      }();

  42:   

  43:   

  44:      ko.applyBindings(site.vm.home_index);

  45:  });

ViewModel использует контрол Clock и BusyIndicator, а так же сервисы (site.services.js). Построен ViewModel по принципу Reveaking Module Pattern.

Заключение

Пятое дело: В качестве заключение хочу еще раз сказать о том, что это всего лишь пример архитектуры приложения на JavaScript (HTML5), которая может (и должна) быть расширена. Примите этот просто как вариант “с чего начать разработку на HTML5”.

Загрузить

Можно бесплатно загрузить проект с демонстрационным кодом.

• Комментарии