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

Зачем

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

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

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

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

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

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

PM> Uninstall-Package jssite
Successfully removed 'JsSite 0.3.2' from JsSitePackageDemo.
Successfully uninstalled 'JsSite 0.3.2'.

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.5'.
Successfully installed 'underscore.js 1.4.4'.
Successfully installed 'JsSite 0.4.2'.
Successfully removed 'toastr 1.1.4.2' from JsSitePackageDemo.
Successfully added 'toastr 1.1.5' to JsSitePackageDemo.
Successfully removed 'underscore.js 1.4.3' from JsSitePackageDemo.
Successfully added 'underscore.js 1.4.4' to JsSitePackageDemo.
'Images\ms-loader.gif' already exists. Skipping...
Successfully added 'JsSite 0.4.2' to JsSitePackageDemo.
Successfully uninstalled 'toastr 1.1.4.2'.
Successfully uninstalled 'underscore.js 1.4.3'.

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):

@{
    ViewBag.Title = "Демо: Knockout paging";
}

<h1>DEMO: JsSite (Knockout) <span data-bind="text: clock.time">span>h1>
<h3>EXAMPLE: using package for create Twitter searchh3>
<p>
    <label>Twitter search:label>
    <input data-bind="value: term" />
    <button data-bind="click: search">searchbutton>
p>
<div data-bind="blockUI: indicator">
    <table>  <thead>
            <tr>   <th>найденоth>
            tr>  thead>  <tbody>

            <tr>   <td>
                    <img data-bind="attr: {'src': profile_image_url}" />
                    <span data-bind="date: created_at">span>
                    <span data-bind="html: decodeURI(text())">span>
                    <span data-bind="text: source">span>
                    <div data-bind="html: source">div>   td>
            tr>
              tbody>
    table>
div>

@section scripts
{
    <script src="~/Scripts/moment.min.js">script>
    <script src="~/Scripts/amplify.js">script>
    <script src="~/Scripts/toastr.min.js">script>

    <script src="~/Scripts/knockout-2.2.1.debug.js">script>
    <script src="~/Scripts/knockout.mapping-latest.js">script>

    <script src="~/Scripts/app/site.core.js">script>
    <script src="~/Scripts/app/site.bindingHandlers.js">script>
    <script src="~/Scripts/app/site.services.js">script>
    <script src="~/Scripts/app/site.controls.js">script>
    <script src="~/Scripts/app/site.vm.indexPage.js">script>
}

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

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

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

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

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

$(function () {

    "use strict";

    site.vm.home_index = function () {  var clock = new site.controls.Clock(),
            term = ko.observable(),
            indicator = new site.controls.BusyIndicator(),
            items = ko.observableArray([]),
            search = function () {   indicator.isbusy(true);   site.services.twitter.search(term(), {
                    success: function (json) {
                        site.logger.success("Loaded items: " json.results.length);
                        ko.mapping.fromJS(json.results, {}, items);
                        indicator.isbusy(false);
                    },
                    error: function (message, status) {
                        site.logger.error(status);
                        indicator.isbusy(false);
                    }   });
            };    return {
            term:term,
            search: search,
            items:items,
            indicator: indicator,
            clock: clock  };
    }();


    ko.applyBindings(site.vm.home_index);
});

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

Заключение

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