Backbone js что это

Обновлено: 29.04.2024

Backbone.js — JavaScript-библиотека, основанная на шаблоне проектирования Model-View-Presenter, предназначена для разработки веб-приложений с поддержкой RESTful JSON интерфейса.

Backbone.Model

Backbone Models are the basic data object in the framework – frequently representing a row in a table in a database on your server. A discrete chunk of data and a bunch of useful, related methods for performing computations and transformations on that data.

Create a new model with the specified attributes. A client id ( cid ) is automatically generated and assigned for you.

Attach all inheritable methods to the Model prototype.

A hash of attributes whose current and previous value differ.

The value returned during the last failed validation.

The default name for the JSON id attribute is "id" . MongoDB and CouchDB users may want to set this to "_id" .

The prefix is used to create the client id which is used to identify models locally. You may want to override this if you’re experiencing name clashes with model ids.

preinitialize is an empty function by default. You can override it with a function or object. preinitialize will run before any instantiation logic is run in the Model.

Initialize is an empty function by default. Override it with your own initialization logic.

Return a copy of the model’s attributes object.

Proxy Backbone.sync by default – but override this if you need custom syncing semantics for this particular model.

Get the value of an attribute.

Get the HTML-escaped value of an attribute.

Returns true if the attribute contains a value that is not null or undefined.

Special-cased proxy to underscore’s _.matches method.

Set a hash of model attributes on the object, firing "change" . This is the core primitive operation of a model, updating the data and notifying anyone who needs to know about the change in state. The heart of the beast.

Handle both "key", value and -style arguments.

Extract attributes and options.

For each set attribute, update or delete the current value.

Trigger all relevant attribute changes.

You might be wondering why there’s a while loop here. Changes can be recursively nested within "change" events.

Remove an attribute from the model, firing "change" . unset is a noop if the attribute doesn’t exist.

Clear all attributes on the model, firing "change" .

Determine if the model has changed since the last "change" event. If you specify an attribute name, determine if that attribute has changed.

Return an object containing all the attributes that have changed, or false if there are no changed attributes. Useful for determining what parts of a view need to be updated and/or what attributes need to be persisted to the server. Unset attributes will be set to undefined. You can also pass an attributes object to diff against the model, determining if there would be a change.

Get the previous value of an attribute, recorded at the time the last "change" event was fired.

Get all of the attributes of the model at the time of the previous "change" event.

Fetch the model from the server, merging the response with the model’s local attributes. Any changed attributes will trigger a “change” event.

Set a hash of model attributes, and sync the model to the server. If the server returns an attributes hash that differs, the model’s state will be set again.

Handle both "key", value and -style arguments.

If we’re not waiting and attributes exist, save acts as set(attr).save(null, opts) with validation. Otherwise, check if the model will be valid when the attributes, if any, are set.

After a successful server-side save, the client is (optionally) updated with the server-side state.

Ensure attributes are restored during synchronous saves.

Set temporary attributes if to properly find new ids.

Destroy this model on the server if it was already persisted. Optimistically removes the model from its collection, if it has one. If wait: true is passed, waits for the server to respond before removal.

Default URL for the model’s representation on the server – if you’re using Backbone’s restful methods, override this to change the endpoint that will be called.

parse converts a response into the hash of attributes to be set on the model. The default implementation is just to pass the response along.

Create a new model with identical attributes to this one.

A model is new if it has never been saved to the server, and lacks an id.

Check if the model is currently in a valid state.

Run validation against the next complete set of model attributes, returning true if all is well. Otherwise, fire an "invalid" event.

Установка

Существует жесткая зависимость от библиотеки Underscore
Необходимо так же устанавливать jQuery
Сам Backbone прописывается только после этих двух библиотек

Содержание

Backbone.js состоит из следующих классов:

Model (Модель)
Collection (Коллекция)
View (Представление)
Router (Роутер)

Модель (model)

Модель — это какая-либо сущность предметной области, будь то пользователь, книга, продукт, элемент меню. Модели в Backbone.js позволяют хранить данные приложения, имеют методы для добавления, изменения и удаления этих данных (атрибуты модели).

Пример создания модели:

Создать новый экземпляр модели можно с помощью new :

Изменения в примере выше сохраняются только в оперативной памяти. Если вы хотите сохранить изменения модели на сервер, используйте метод save :

Установка атрибутов

Установить значения атрибутов можно как при инициализации экземпляра модели:

так и с помощью сеттера:

Получение атрибутов

Внутри модели все данные хранятся в объекте attributes. Получить значение атрибута можно с помощью метода get() .

Получить все атрибуты модели можно с помощью метода toJSON() :

События изменения состояния модели

На событие изменения любого атрибута модели может быть навешен обработчик:

В примере выше мы повесили обработчик только на событие изменения атрибута name . Обработчик будет срабатывать при изменении любого атрибута модели:

Валидация модели

Backbone.js позволяет определить метод validate() у модели, чтобы проверить корректность данных.

По умолчанию, валидация происходит при вызове метода save() или когда метод set() вызван с опцией .

Метод validate() всегда возвращает текст ошибки. Если все поля модели корректны — функция не должна ничего возвращать.

Если возвращается ошибка, то:

срабатывает событие invalid модели и устанавливается свойство validationError, в котором сохраняется текст ошибки;
метод save() не срабатывает и данные на сервере не изменяются

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

Представления в Backbone.js выполняют две основные функции:

Отображение состояния приложения и данных модели пользователям;
Реагирование на события от элементов DOM и моделей/коллекций

Cоздадим простое представление:

Атрибут $el ссылается на обертку, которую создает представление. В нашем примере, мы создали элемент <div> с классом book-item и поместили в него заголовок книги.

В этом примере мы не использовали возможность шаблонизации, если представление более сложное, можно использовать шаблонизатор из библиотеки Underscore.js.

Давайте изменим наш пример с использованием шаблонизатора:

Сам шаблон можно поместить непосредственно на HTML-странице:

Также представления в Backbone.js могут слушать события от элементов DOM и от моделей и коллекций.

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

Представления (View) в Backbone.js отвечают за отображение данных приложения, а также могут реагировать на события, возникающие в моделях, коллекциях или события DOM-элементов.

Функция initialize() вызывается при инициализации объекта представления

Свойство el

Свойство el представления — это ссылка на DOM-элемент. Представления в Backbone.js формируют внутри el отображение данных и только потом вставляют этот элемент в DOM.

Каждое представление должно быть связано с DOM-элементом и, если свойство el явно не определено, Backbone создает новый элемент. Управлять созданием этого элемента можно с помощью трех свойств: tagName , id и className , определяющих, соответственно, тег, id и class . По умолчанию, если ни одно из этих свойств не задано — будет создан пустой элемент <div></div> .

Для вызова jQuery (или Zepto) функций представление Backbone имеет свойство $el . Свойство $el хранит закешированный объект $(view.el) .

Если необходимо связать существующее представление с другим DOM-элементом — можно воспользоваться методом setElement . Такое изменение требует привязки всех событий к новому элементу.

Метод setElement удаляет обработчики всех событий элемента $el , создает новую ссылку $el и снова привязывает обработчики событий.

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

Для отображения представления в DOM необходимо реализовать метод render() и вызвать его при инициализации представления.

Библиотека Underscore.js, использующаяся в Backbone.js, предоставляет собственное решение для шаблонизации. Однако при желании можно использовать любой другой шаблонизатор.

На событие изменения модели можно повесить функцию render() представления:

Обратите внимание, мы использовали функцию _.bind (реализацию функции bind() из Underscore.js), чтобы явно указать, что значением this будет объект представления)

Обработчики событий

Чтобы создать обработчики событий в представлении, используется свойство events . Обработчики событий могут быть связаны только с элементами DOM внутри el .

Коллекция (Collection)

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

Определить коллекцию можно следующим образом:

С моделями коллекции можно совершать определенные действия, к примеру, отфильтруем модели по автору. Для этого мы создали новый метод, который принимает имя автора (тут вероятно ошибка, из кода следует, что принимает дату публикации) в качестве параметра:

Объявить объект коллекции можно так же, как и модель:

В данном примере мы создали объект коллекции и получили элемент коллекции с ID равным 0.

Наконец, если вам нужно получить данные коллекции с сервера, вы можете воспользоваться методом fetch() . При этом в атрибутах коллекции должен быть указан URL, откуда мы будет получать данные.

Написание сложных интерфейсов с Backbone.js

Backbone.js это каркас для создания RIA JavaScript приложений, его автором является Jeremy Ashkenas, создатель CoffeeScript, Backbone является частью компании Document Cloud ей же «принадлежит» Underscrore.js. Backbone — очень легкая библиотека, помогающая вам создавать интерфейсы. Она может работать с любыми библиотеками, к которым вы привыкли.

Backbone это набор классов, размером менее 4Кб, которые формируют структуру вашего кода и помогают создавать качественные MVC веб-приложения.

Backbone формирует структуру тяжелых JavaScript приложений, внесением моделей с key-value подобным хранилищем и своими событиями, коллекций с богатыми API, видов (ориг. views) с декларативной обработкой событий и соединяет все это в в одно приложение, поддерживающее RESTful JSON интерфейс.

Backbone не может работать без Underscore.js. Для поддержки REST API и работы с DOM элементами в Backbone.View настоятельно рекомендуется подключить json2.js и jQuery-подобную библиотеку: jQuery или Zepto

В статье будет рассмотрена структура Backbone.js, будет поэтапно создано простое Todo приложение.

Вот те рычаги, которые нам дает Backbone

Хранилище типа ключ-значение и пользовательские события

Когда содержание модели изменяется все объекты, которые были подписаны на изменения модели получают уведомления и могут предпринять дальнейшие действия. Например, виды (ориг. views) слушают изменения в модели и обновляют свое состояние вместо того, чтобы модель меняла состояние видов. Применяется паттерн loose coupling «слабая связь».

Богатый API перечисляемых функций

Backbone поставляется с набором очень полезных функций для обработки ваших данных. В отличии от других языков, в JavaScript массивы «недоделанные», что доставляет много хлопот если вы работаете с большим объемом данных.

Виды с декларативной обработкой событий

Те дни, когда вы писали спагетти-подобный код подходят к концу. Вы можете программно определить какой callback ассоциирован с каким объектом.

RESTful JSON интерфейс

Если вам необходимо пообщаться с сервером, вам приходится выполнить AJAX запрос в коде «вида» и получать то, что вам необходимо. Все это частично упрощается с использованием различных xhr-адаптеров, WebSockets и localStorage, но можно сделать проще. Такую сущность следует поделить на несколько мелких, Backbone нам в этом поможет:

Backbone дает нам возможность отделить данные от представления. Модель, которая работает с данными и синхронизируется с сервером, тогда когда вид слушает изменения модели и изменяет свое состояние (отрисовывает данные в HTML)

Сразу перечислю ответы на вопросы, которые могут сейчас возникнуть:

Заменяет ли оно jQuery?

Нет. Они очень отличаются в своих целях. Backbone работает с высокоуровневыми абстракциями, в то время как jQuery или подобные библиотеки работают с DOM, нормализует события и так далее.

У них различные области применения, если вы знаете одну библиотеку это не значит, что вам нужно знать другую. Но как JavaScript разработчик, вы должны знать, как эффективно работать с обеими.

Почему я должен использовать её?

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

Где я должен использовать её?

Backbone идеально подходит для создания тяжелых интерфейсов и приложений, управляемых данными. Например, интерфейс GMail, новый Twitter или другие связанные приложения. Backbone позволяет создавать сложные приложения проще.

С её помощью вы можете создавать и простые html страницы, насыщенные JavaScript, но по большему счету Backbone предназначен для создания веб-приложений.

Похож ли он на Cappuccino или Sproutcore?

И да и нет. Да потому, что как и в вышеупомянутых фрэймворках, основная цель — создание сложных интерфейсов для веб-приложений. Отличаются они тем, что Backbone очень легкий, ни одна вышеупомянутая библиотека не может сравниться с ним.

На самом деле про 4kb это не правда: Backbone 4кб + Underscore.js 3кб + jQuery 31Кб = 38кб

Cappuccino заставляет вас писать код на Objective-J, тогда как виды Sproutcore должны объявляться в JavaScript коде. Но я не могу назвать ни один из этих подходом не верным, но с Backbone вы пишете обычный JavaScript и используете обычный HTML и CSS вам практически ничего не нужно менять.

Могу ли я использовать другие библиотеки вместе с Backbone?

Безусловно. Не только обращение к DOM, обертки AJAX, но также шаблоны и загрузчики скриптов. Backbone имеет очень-очень слабую связь (very, very loosely coupled) — это значит, что вы можете использовать практически все ваши инструменты в сочетании с Backbone.

Строение Backbone

Модель (Model)
Коллекция (Collection)
Вид (View)
Контроллер (Controller)

Модель

Моделями называются разные вещи в различных MVC фрэймворках. В Backbone моделью называется отдельная сущность, ближайший аналог — запись в базе. Но здесь нет жестких правил. С сайта фрэймворка:

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

Модель — это способ чтения и записи свойств или атрибутов в наборе данных. Вот пример модели:

Давайте немного усложним:

Метод initialize будет выполнен, когда создастся объект. В этом методе я не делаю ничего полезного. Также я определяю несколько переменных по умолчанию, на случай если часть данных не будет передана.

Давайте посмотрим как читать и записывать атрибуты. Но сперва, создадим объект:

Вы не можете работать с атрибутами напрямую (object.attribute) вы должны вызвать метод для изменения или получения данных (думаю с появлением Proxy ситуация изменится).
Сейчас все данные находятся в памяти приложения. Давайте сохраним их на сервер:

Вы ожидали что-то большее? AJAX? Одной строчкой мы отправляем запрос на сервер. Помните, что тип запроса меняется: если вы создаете новый объект, то будет отправлен POST запрос, иначе будет PUT.
Я кратко затронул модели. Backbone дает значительно больше возможностей по работе с моделями. Подробности можно найти в документации.

Коллекции

Коллекции в Backbone это просто набор моделей. По аналогии с базой данных коллекции — это результаты запросов к БД, содержащие строки (Модели).
Создадим коллекцию игр:

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

Теперь вы можете работать с данными. Для примера, давайте расширим коллекцию, добавив метод, определяющий старые игры.

Просто, не правда ли? Мы просто проверяем те игры, которые были созданы до 2009 года и возвращаем их. Также вы можете управлять коллекцией напрямую:

Пример выше создает новую коллекцию и получает модель с ID 0. Вы можете найти элемент в определенной позиции через ссылку на позицию объекта: games.at(0);

И, наконец, вы можете динамически пополнять вашу коллекцию вот так:

Мы оповещаем Backbone с помощью какого url управлять данными. Дальше мы просто создаем новый объект и вызываем метод fetch , который приводит к асинхронному запросу данных с сервера и заполняет коллекцию.

Теперь вы знаете основы коллекций Backbone. Как я отметил выше, существуют ещё тонны полезных вещей, которые умеет Backbone, например все методы библиотеки Underscore. Ознакомьтесь с документацией перед началом экспериментов.

На первый взгляд виды могут показаться запутанными. В отличии от чистого MVC, виды в Backbone имеют часть функций контроллера.

Слушание событий DOM, моделей и коллекций.
Представление состояния приложения (отрисовка вида).

Все довольно просто. Я просто определяю, какой HTML элемент должен использоваться для обертки вида (tagName и className).

Следующий код отрисовывает вид:

el ссылается на DOM элемент, который представляет этот вид. Мы просто кладем имя игры в HTML элемент. Очевидно, что используя jQuery все немного проще.

В более сложных разметках использование HTML кода внутри JavaScript утомительно и бессмысленно. В этих случаях стоит применять шаблоны.

Backbone имеет собственный шаблонизатор (часть Underscore.JS) но вы свободны применять любой вид шаблона.

Наконец, давайте посмотрим, как виды слушают события. Сначала DOM события.

Конечно, не так как привычно как у jQuery, но тоже просто. Мы определяем, какие события слушаем через объект Events. Как видно из кода выше, первая часть ссылается на событие, а следующая определяет функцию, которая связана с событием.

Теперь свяжем наш вид с моделью:

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

bindAll это метод Underscore, который связывает контекст this с функцией. Это особенно полезно в событиях.

Теперь как только имя модели будет изменено, вызовется функция changeName . Вы можете использовать другие префиксы вместо change: для опроса состояния модели.

Контроллер

Контроллеры позволяют создавать приложение, запоминающие свое состояние в url hash (hashbangs).

Используя hashbangs, вы можете создавать веб-приложения, которые запоминают свое состояние и могут индексироваться Google.

Теперь вы знаете основы Backbone, попробуем создать тестовое приложение.

Пример: Список Todo

Это приложение было создано Jérôme Gravel-Niquet. Оно использует простой localStorage адаптер для сохранения ваших данных в браузере (не останавливаюсь на адаптере, посмотрите его код — там все предельно просто). Посмотрите, что получится в конце, чтобы лучше понять код: Список Todo

Модель Туду

Наша базовая модель описывает элемент туду списка, который имеет атрибуты content , order и done .

Backbone.sync

Override this function to change the manner in which Backbone persists models to the server. You will be passed the type of request, and the model in question. By default, makes a RESTful Ajax request to the model’s url() . Some possible customizations could be:

CollectionIterator

A CollectionIterator implements JavaScript’s Iterator protocol, allowing the use of for of loops in modern browsers and interoperation between Backbone.Collection and other JavaScript functions and third-party libraries which can operate on Iterables.

This “enum” defines the three possible kinds of values which can be emitted by a CollectionIterator that correspond to the values(), keys() and entries() methods on Collection, respectively.

All Iterators should themselves be Iterable.

Only continue iterating if the iterated collection is long enough.

Construct a value depending on what kind of values should be iterated.

Once exhausted, remove the reference to the collection so future calls to the next method always return done.

Initial Setup

Save the previous value of the Backbone variable, so that it can be restored later on, if noConflict is used.

Create a local reference to a common array method we’ll want to use later.

Current version of the library. Keep in sync with package.json .

For Backbone’s purposes, jQuery, Zepto, Ender, or My Library (kidding) owns the $ variable.

Runs Backbone.js in noConflict mode, returning the Backbone variable to its previous owner. Returns a reference to this Backbone object.

Turn on emulateJSON to support legacy servers that can’t deal with direct application/json requests … this will encode the body as application/x-www-form-urlencoded instead and will send the model in a form param named model .

backbone.js

Establish the root object, window ( self ) in the browser, or global on the server. We use self instead of window for WebWorker support.

Set up Backbone appropriately for the environment. Start with AMD.

Export global even in AMD case in case this script is loaded with others that may still expect a global Backbone.

Next for Node.js or CommonJS. jQuery may not be needed as a module.

Finally, as a browser global.

Backbone.Events

A module that can be mixed in to any object in order to provide it with a custom event channel. You may bind a callback to an event with on or remove with off ; trigger -ing an event fires all callbacks in succession.

Regular expression used to split event strings.

A private global variable to share between listeners and listenees.

Iterates over the standard event, callback (as well as the fancy multiple space-separated events "change blur", callback and jQuery-style event maps ).

Handle event maps.

Handle space-separated event names by delegating them individually.

Finally, standard events.

Bind an event to a callback function. Passing "all" will bind the callback to all events fired.

Allow the listening to use a counter, instead of tracking callbacks for library interop

Inversion-of-control versions of on . Tell this object to listen to an event in another object… keeping track of what it’s listening to for easier unbinding later.

This object is not listening to any other events on obj yet. Setup the necessary references to track the listening callbacks.

Bind callbacks on obj.

If the target obj is not Backbone.Events, track events manually.

The reducing API that adds a callback to the events object.

Remove one or many callbacks. If context is null, removes all callbacks with that function. If callback is null, removes all callbacks for the event. If name is null, removes all bound callbacks for all events.

Tell this object to stop listening to either specific events … or to every object it’s currently listening to.

If listening doesn’t exist, this object is not currently listening to obj. Break out early.

The reducing API that removes a callback from the events object.

Delete all event listeners and “drop” events.

Bail out if there are no events stored.

Find any remaining events.

Replace events if there are any remaining. Otherwise, clean up.

Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.

Map the event into a object.

Inversion-of-control versions of once .

Map the event into a object.

Reduces the event callbacks into a map of . offer unbinds the onceWrapper after it has been called.

Trigger one or many events, firing all bound callbacks. Callbacks are passed the same arguments as trigger is, apart from the event name (unless you’re listening on "all" , which will cause your callback to receive the true name of the event as the first argument).

Handles triggering the appropriate event callbacks.

A difficult-to-believe, but optimized internal dispatch function for triggering events. Tries to keep the usual cases speedy (most internal Backbone events have 3 arguments).

A listening class that tracks and cleans up memory bindings when all callbacks have been offed.

Offs a callback (or several). Uses an optimized counter if the listenee uses Backbone.Events. Otherwise, falls back to manual tracking to support events library interop.

Cleans up memory bindings between the listener and the listenee.

Aliases for backwards compatibility.

Allow the Backbone object to serve as a global event bus, for folks who want global “pubsub” in a convenient place.

Backbone.Collection

If models tend to represent a single row of data, a Backbone Collection is more analogous to a table full of data … or a small slice or page of that table, or a collection of rows that belong together for a particular reason – all of the messages in this particular folder, all of the documents belonging to this particular author, and so on. Collections maintain indexes of their models, both in order, and for lookup by id .

Create a new Collection, perhaps to contain a specific type of model . If a comparator is specified, the Collection will maintain its models in sort order, as they’re added and removed.

Splices insert into array at index at .

Define the Collection’s inheritable methods.

The default model for a collection is just a Backbone.Model. This should be overridden in most cases.

preinitialize is an empty function by default. You can override it with a function or object. preinitialize will run before any instantiation logic is run in the Collection.

Initialize is an empty function by default. Override it with your own initialization logic.

The JSON representation of a Collection is an array of the models’ attributes.

Proxy Backbone.sync by default.

Add a model, or list of models to the set. models may be Backbone Models or raw JavaScript objects to be converted to Models, or any combination of the two.

Remove a model, or a list of models from the set.

Turn bare objects into model references, and prevent invalid models from being added.

If a duplicate is found, prevent it from being added and optionally merge it into the existing model.

If this is a new, valid model, push it to the toAdd list.

Remove stale models.

See if sorting is needed, update length and splice in new models.

Silently sort the collection if appropriate.

Unless silenced, it’s time to fire all appropriate add/sort/update events.

Return the added (or merged) model (or models).

When you have more items than you want to add or remove individually, you can reset the entire set with a new list of models, without firing any granular add or remove events. Fires reset when finished. Useful for bulk operations and optimizations.

Add a model to the end of the collection.

Remove a model from the end of the collection.

Add a model to the beginning of the collection.

Remove a model from the beginning of the collection.

Slice out a sub-array of models from the collection.

Get a model from the set by id, cid, model object with id or cid properties, or an attributes object that is transformed through modelId.

Returns true if the model is in the collection.

Get the model at the given index.

Return models with matching attributes. Useful for simple cases of filter .

Return the first model with matching attributes. Useful for simple cases of find .

Force the collection to re-sort itself. You don’t need to call this under normal circumstances, as the set will maintain sort order as each item is added.

Run sort based on type of comparator .

Pluck an attribute from each model in the collection.

Fetch the default set of models for this collection, resetting the collection when they arrive. If reset: true is passed, the response data will be passed through the reset method instead of set .

Create a new instance of a model in this collection. Add the model to the collection immediately, unless wait: true is passed, in which case we wait for the server to agree.

parse converts a response into a list of models to be added to the collection. The default implementation is just to pass it through.

Create a new collection with an identical list of models as this one.

Define how to uniquely identify models in the collection.

Get an iterator of all models in this collection.

Get an iterator of all model IDs in this collection.

Get an iterator of all [ID, model] tuples in this collection.

Private method to reset all internal state. Called when the collection is first initialized or reset.

Prepare a hash of attributes (or other model) to be added to this collection.

Internal method called by both remove and set.

Method for checking whether an object should be considered a model for the purposes of adding to the collection.

Internal method to create a model’s ties to a collection.

Internal method to sever a model’s ties to a collection.

Internal method called every time a model in the set fires an event. Sets need to update their indexes when models change ids. All other events simply proxy through. “add” and “remove” events that originate in other collections are ignored.

Defining an @@iterator method implements JavaScript’s Iterable protocol. In modern ES2015 browsers, this value is found at Symbol.iterator.

Backbone.View

Backbone Views are almost more convention than they are actual code. A View is simply a JavaScript object that represents a logical chunk of UI in the DOM. This might be a single item, an entire list, a sidebar or panel, or even the surrounding frame which wraps your whole app. Defining a chunk of UI as a View allows you to define your DOM events declaratively, without having to worry about render order … and makes it easy for the view to react to specific changes in the state of your models.

Creating a Backbone.View creates its initial element outside of the DOM, if an existing element is not provided…

Cached regex to split keys for delegate .

List of view options to be set as properties.

Set up all inheritable Backbone.View properties and methods.

The default tagName of a View’s element is "div" .

jQuery delegate for element lookup, scoped to DOM elements within the current view. This should be preferred to global lookups where possible.

preinitialize is an empty function by default. You can override it with a function or object. preinitialize will run before any instantiation logic is run in the View

Initialize is an empty function by default. Override it with your own initialization logic.

render is the core function that your view should override, in order to populate its element ( this.el ), with the appropriate HTML. The convention is for render to always return this .

Remove this view by taking the element out of the DOM, and removing any applicable Backbone.Events listeners.

Remove this view’s element from the document and all event listeners attached to it. Exposed for subclasses using an alternative DOM manipulation API.

Change the view’s element ( this.el property) and re-delegate the view’s events on the new element.

Creates the this.el and this.$el references for this view using the given el . el can be a CSS selector or an HTML string, a jQuery context or an element. Subclasses can override this to utilize an alternative DOM manipulation API and are only required to set the this.el property.

Set callbacks, where this.events is a hash of

pairs. Callbacks will be bound to the view, with this set properly. Uses event delegation for efficiency. Omitting the selector binds the event to this.el .

Add a single event listener to the view’s element (or a child element using selector ). This only works for delegate-able events: not focus , blur , and not change , submit , and reset in Internet Explorer.

Clears all callbacks previously bound to the view by delegateEvents . You usually don’t need to use this, but may wish to if you have multiple Backbone views attached to the same DOM element.

A finer-grained undelegateEvents for removing a single delegated event. selector and listener are both optional.

Produces a DOM element to be assigned to your view. Exposed for subclasses using an alternative DOM manipulation API.

Ensure that the View has a DOM element to render into. If this.el is a string, pass it through $() , take the first matching element, and re-assign it to el . Otherwise, create an element from the id , className and tagName properties.

Set attributes from a hash on this view’s element. Exposed for subclasses using an alternative DOM manipulation API.

Proxy Backbone class methods to Underscore functions, wrapping the model’s attributes object or collection’s models array behind the scenes.

Underscore methods that we want to implement on the Model, mapped to the number of arguments they take.

O Backbone.js очень просто и кратко для любителей MVC-фреймворков

Итак, представим себе среднестатистический проект, использующий MVC подход. Это, вероятно, будет интернет-магазин с несколькими моделями (около 10-15 обычно), связанными друг с другом различными видами отношений. Проект будет иметь соответственное количество контроллеров, 2-3 layout'а для разных устройств вывода, несколько контроллеров в namespace'е /api/v1, масса view'шек и partial'ов. Всё это работает стандартно, браузер шлёт запросы, контроллеры делают выборки данных, передают их во view'шки, те, в свою очередь, отсылаются пользователю в браузер. Есть функция «Поиск», которая ищет определённые экземпляры какой-то модели, есть view для результатов, содержащая цикл, который создаёт на странице отображение этих найденных экземпляров, есть даже мобильное приложение для Android, которое общается с Вашим серверов через API (запрашивает контроллеры, которые ждут в namespace'e /api/v1, кстати, часто дублирующие аналогичные 'обычные' контроллеры, только отдающие информацию в другом виде).

Теперь включаем режим Ванги. Я знаю, что в проекте обязательно есть некоторое количество кода на JavaScript. В различных веб-приложениях JavaScript'ом решаются разнообразные задачи — почти везде используется jQuery с плагинами или без, jQuery UI и прочие другие модули и плагины. Мы не будем рассматривать здесь использование JavaScript для создания всякого рода эффектов, выпадающих меню, drap&drop'ающихся элементов и прочее, что относится к украшательствам, мы рассмотрим работу с данными.

Итак, режим Ванги позволяет мне предположить, что вас есть модель Product (у нас ведь интернет-магазин, помните?) и безусловно есть интерфейс менеджера, который может вывести себе список товаров по некоторому критерию. У менеджера, есть стилизованный индикатор количества новых заказов, чтобы сразу же, как можно быстрее увидеть, что появился новый заказ. Я думаю, что этот индикатор работает так: в document.ready() вы сделали таймер и раз в 60 секунд запрашиваете адрес вроде /api/v1/kolichestvo_zakazov. Ну или /api/v1/orders/new/count, смотря по вашему отношению к лингвистике. В функции, которую запускает таймер у вас есть написанный на jQuery ajax запрос, который получает по ранее указанному URL'у какие-то данные. Почему какие-то? Я не знаю, Ванга не поможет. Один программист может в ответе слать корректный json вроде >, другой может слать просто цифру 3. Третий может на стороне сервера отрендерить и прислать в ответе целый кусок html-кода, пригодный сразу к вставке в нужное место документа. В общем, Ванга тут не поможет, тут нет никакого порядка, закона и максимальный уровень неожиданности. Но самое главное — данные, после получения, просто говоря, теряются. Клиентская сторона получила что-то, сделала с этими данными что-то и они больше не принесут вам никакой пользы.

С точки зрения философа-перфекциониста — это ужасно. Согласитесь, если уже придуманы сотни способов упорядочивать данные на стороне сервера (MVC-подход, любая СУБД — это по своей сути методологии упорядочивания информации), стало быть нужно сделать следующий шаг — упорядочить данные на стороне клиента.

Что же нам может предложить Backbone.js? Первое, на мой взгляд, самое главное, это именно упорядочивание данных, которое в Backbone.js реализуется через знакомый нам MVC. Кратко о том, как это будет:

1. У вас в приложении есть модели. User, Product, Order… Отлично, с Backbone.js Вы сможете описать эти модели на стороне клиента! И эти модели будут настоящими, вы сможете создавать новые экземпляры, редактировать поля уже имеющихся, удалять ненужные. Вы можете не писать какие-то функции, для получения какой-то информации, которая потом будет выброшена, получайте с сервера экземпляры класса order. Быть может, order будет содержать много лишней информации, подумает кто-то, нужно было же только количество! Может быть. Но никто не запрещает передавать в JSON'е только нужные на стороне клиента поля order'ов. А ваш гипотетический менеджер вдруг может захотеть кроме количества заказов видеть ещё и суммы каждого — а у нас уже всё готово, информация уже там, только покажите её, обьекты уже у клиента и синхронизированы с сервером. А если менеджер захочет прямо на месте изменить эту сумму? Не проблема. Намного приятнее написать в коде order.save( this.input.val(> ), чем писать новую самодельную функцию. Модели будут знать URL, куда слать GET, POST, PUT и DELETE запросы и будут делать это сами, когда нужно. Например, product.delete() самостоятельно отправит DELETE на /api/v1/products/75 (75 это id этой модели).

2. У вас в приложении есть страницы, где обязательно есть множество однотипных блоков. Результаты поиска товаров тому пример. Каждый товар может быть расположен внутри какого-нибудь div . После создания этой страницы на сервере, связь этой области с товаром, в ней описанным теряется. Если Вы захотите что-нибудь делать на этой странице, вам придётся изобрести способ снова дать знать этой области с каким она товаром связана, например дать data-атрибут с id продукта и использовать его в формах и запросах… Backbone.js реализует такую привязку сам. Это будет называться View и будет делать даже больше: область продукта может реагировать на изменения продукта и перерисовываться сама, к примеру. Внутри области вам будет доступен экземпляр класса Product, именно тот самый, и вы сможете делать с ним всё, что угодно на стороне клиента. Не забудьте после сделать ему save(), чтобы Backbone.js сохранил ваши изменения на сервере.

Кстати. Хотите фильтр по некоторому полю таблицы товаров? Уже догадались, что это вообще не требует никаких дополнительных действий? Не надо ничего отправлять на сервер, получая ту же таблицу, только отфильтрованную, заново. Обьекты-то у вас уже есть, просто отфильтруйте коллекцию product'ов одной строкой кода на javascript. И да, они ещё и перерисуются сами, вам об этом нужно позаботиться всего лишь один раз, сообщив Backbone'у, что вы хотите обновлять кусок страницы, где находится информация об этом product'e при изменении product'a.

3. И ещё в тему упорядочивания данных. Используя MVC-фреймворк на стороне клиента вы, в некоторых случаях, можете свести трафик между клиентами и сервером к обмену небольшими кусками json'а, что позволит экономить огромное количество трафика. Вы будете передавать клиентам и получать от клиентов только данные, вы не будете постоянно пересылать клиентам полные страницы. Весь javascript и css может быть загружен единожды и закеширован, дальше будет происходить только обмен упорядоченными как вам удобно данными.

Читайте также: