Вложенные модели в Backbone.js, как подойти


117

Я получил следующий JSON с сервера. Таким образом, я хочу создать модель с вложенной моделью. Я не уверен, как этого добиться.

//json
[{
    name : "example",
    layout : {
        x : 100,
        y : 100,
    }
}]

Я хочу, чтобы они были преобразованы в две вложенные модели магистрали со следующей структурой:

// structure
Image
    Layout
...

Итак, я определяю модель Layout так:

var Layout = Backbone.Model.extend({});

Но какой из двух (если есть) нижеприведенных методов мне следует использовать для определения модели изображения? А или Б ниже?

A

var Image = Backbone.Model.extend({
    initialize: function() {
        this.set({ 'layout' : new Layout(this.get('layout')) })
    }
});

или, B

var Image = Backbone.Model.extend({
    initialize: function() {
        this.layout = new Layout( this.get('layout') );
    }
});

Ответы:


98

У меня такая же проблема, когда я пишу свое Backbone-приложение. Приходится иметь дело со встроенными / вложенными моделями. Я сделал несколько настроек, которые, на мой взгляд, были довольно элегантным решением.

Да, вы можете изменить метод синтаксического анализа, чтобы изменить атрибуты в объекте, но все это на самом деле довольно неудобный код IMO, и он больше похож на взлом, чем на решение.

Вот что я предлагаю для вашего примера:

Сначала определите вашу модель макета вот так.

var layoutModel = Backbone.Model.extend({});

Тогда вот ваша модель изображения:

var imageModel = Backbone.Model.extend({

    model: {
        layout: layoutModel,
    },

    parse: function(response){
        for(var key in this.model)
        {
            var embeddedClass = this.model[key];
            var embeddedData = response[key];
            response[key] = new embeddedClass(embeddedData, {parse:true});
        }
        return response;
    }
});

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

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

Вот так:

image.set({layout : new Layout({x: 100, y: 100})})

Также обратите внимание, что вы фактически вызываете метод анализа в своей вложенной модели, вызывая:

new embeddedClass(embeddedData, {parse:true});

Вы можете определить столько вложенных моделей в modelполе, сколько вам нужно.

Конечно, если вы хотите зайти так далеко, чтобы сохранить вложенную модель в отдельной таблице. Этого было бы недостаточно. Но в случае чтения и сохранения объекта в целом этого решения должно хватить.


4
Это хорошо ... должен быть принятый ответ, поскольку он намного чище, чем другие подходы. Единственные предложения, которые у меня есть, - это использовать первую букву ваших классов, расширяющих Backbone.Model для удобочитаемости .. т.е. ImageModel и LayoutModel
Стивен Хэндли

1
@StephenHandley Спасибо за комментарий и ваше предложение. Для информации я использую это в контексте requireJS. Итак, чтобы ответить на вопрос о заглавных буквах, var 'imageModel' фактически возвращается в requireJS. И ссылка на модель будет заключена в следующую конструкцию: define(['modelFile'], function(MyModel){... do something with MyModel}) Но вы правы. У меня есть привычка ссылаться на модель в соответствии с предложенным вами соглашением.
rycfung

@BobS Извините, это опечатка. Должен был быть ответ. Я исправил это, спасибо, что указали.
rycfung 01

2
Ницца! Я рекомендую добавить это в Backbone.Model.prototype.parseфункцию. Затем все, что нужно сделать вашим моделям, - это определить типы объектов подмоделей (в атрибуте «модель»).
jasop

1
Прохладно! Я закончил делать что-то подобное (особенно и, к сожалению, после того, как нашел этот ответ) и написал его здесь: blog.untrod.com/2013/08/declarative-approach-to-nesting.html Большая разница в том, что для глубоко вложенных моделей Я объявляю все сопоставление сразу в корневой / родительской модели, и код берет его оттуда и просматривает всю модель, гидратируя соответствующие объекты в коллекции и модели Backbone. Но действительно очень похожий подход.
Крис Кларк

16

Я публикую этот код как пример предложения Питера Лайона переопределить синтаксический анализ. У меня был тот же вопрос, и это сработало для меня (с бэкэндом Rails). Этот код написан на Coffeescript. Я сделал несколько вещей понятными для людей, незнакомых с ним.

class AppName.Collections.PostsCollection extends Backbone.Collection
  model: AppName.Models.Post

  url: '/posts'

  ...

  # parse: redefined to allow for nested models
  parse: (response) ->  # function definition
     # convert each comment attribute into a CommentsCollection
    if _.isArray response
      _.each response, (obj) ->
        obj.comments = new AppName.Collections.CommentsCollection obj.comments
    else
      response.comments = new AppName.Collections.CommentsCollection response.comments

    return response

или в JS

parse: function(response) {
  if (_.isArray(response)) {
    return _.each(response, function(obj) {
      return obj.comments = new AppName.Collections.CommentsCollection(obj.comments);
    });
  } else {
    response.comments = new AppName.Collections.CommentsCollection(response.comments);
  }
  return response;
};

Реквизиты для примера кода и предложения переопределения синтаксического анализа. Спасибо!
Эдвард Андерсон

11
было бы неплохо получить ваш ответ на настоящем JS
Джейсон

6
счастлив иметь версию coffeescript, спасибо. Для других попробуйте js2coffee.org
ABCD.ca

16
Если вопрос - настоящий JS, ответ тоже должен быть.
Мануэль Эрнандес

12

Использование Backbone.AssociatedModelиз Backbone-ассоциаций :

    var Layout = Backbone.AssociatedModel.extend({
        defaults : {
            x : 0,
            y : 0
        }
    });
    var Image = Backbone.AssociatedModel.extend({
        relations : [
            type: Backbone.One,
            key : 'layout',
            relatedModel : Layout          
        ],
        defaults : {
            name : '',
            layout : null
        }
    });

Хорошее решение. Есть похожий проект и там: github.com/PaulUithol/Backbone-relational
michaelok

11

Я не уверен, что у Backbone есть рекомендуемый способ сделать это. Есть ли у объекта Layout собственный идентификатор и запись в серверной базе данных? Если это так, вы можете сделать его собственной моделью, как и у вас. Если нет, то вы можете просто оставить его в качестве вложенного документа, просто убедитесь , что вы преобразовать его в и из JSON должным образом в saveи parseметодов. Если вы в конечном итоге воспользуетесь таким подходом, я думаю, что ваш пример A более совместим с backbone, поскольку он setбудет правильно обновляться attributes, но опять же, я не уверен, что Backbone делает с вложенными моделями по умолчанию. Скорее всего, для этого вам понадобится специальный код.


Ах! Извините, не хватало newоператора. Я отредактировал его, чтобы исправить эту ошибку.
Росс

О, тогда я неверно истолковал ваш вопрос. Я обновлю свой ответ.
Питер Лайонс

8

Я бы выбрал вариант Б, если вы хотите, чтобы все было проще.

Еще один хороший вариант - использовать Backbone-Relational . Вы бы просто определили что-то вроде:

var Image = Backbone.Model.extend({
    relations: [
        {
            type: Backbone.HasOne,
            key: 'layout',
            relatedModel: 'Layout'
        }
    ]
});

+1 Backbone-Releational кажется вполне устоявшимся: собственный сайт, 1.6k звезд, 200+ форков.
Росс


5

Версия CoffeeScript красивого ответа rycfung :

class ImageModel extends Backbone.Model
  model: {
      layout: LayoutModel
  }

  parse: (response) =>
    for propName,propModel of @model
      response[propName] = new propModel( response[propName], {parse:true, parentModel:this} )

    return response

Разве это не мило? ;)


11
Я не использую сахар в своем JavaScript :)
Росс

2

У меня была такая же проблема, и я экспериментировал с кодом в ответе rycfung , что является отличным предложением.
Однако, если вы не хотите setнапрямую обращаться к вложенным моделям или не хотите постоянно передавать {parse: true}их options, другим подходом будет переопределение setсебя.

В Backbone 1.0.0 , setназывается в constructor, unset, clear, fetchи save.

Рассмотрим следующую супермодель для всех моделей, которым необходимо вкладывать модели и / или коллекции.

/** Compound supermodel */
var CompoundModel = Backbone.Model.extend({
    /** Override with: key = attribute, value = Model / Collection */
    model: {},

    /** Override default setter, to create nested models. */
    set: function(key, val, options) {
        var attrs, prev;
        if (key == null) { return this; }

        // Handle both `"key", value` and `{key: value}` -style arguments.
        if (typeof key === 'object') {
            attrs = key;
            options = val;
        } else {
            (attrs = {})[key] = val;
        }

        // Run validation.
        if (options) { options.validate = true; }
        else { options = { validate: true }; }

        // For each `set` attribute, apply the respective nested model.
        if (!options.unset) {
            for (key in attrs) {
                if (key in this.model) {
                    if (!(attrs[key] instanceof this.model[key])) {
                        attrs[key] = new this.model[key](attrs[key]);
                    }
                }
            }
        }

        Backbone.Model.prototype.set.call(this, attrs, options);

        if (!(attrs = this.changedAttributes())) { return this; }

        // Bind new nested models and unbind previous nested models.
        for (key in attrs) {
            if (key in this.model) {
                if (prev = this.previous(key)) {
                    this._unsetModel(key, prev);
                }
                if (!options.unset) {
                    this._setModel(key, attrs[key]);
                }
            }
        }
        return this;
    },

    /** Callback for `set` nested models.
     *  Receives:
     *      (String) key: the key on which the model is `set`.
     *      (Object) model: the `set` nested model.
     */
    _setModel: function (key, model) {},

    /** Callback for `unset` nested models.
     *  Receives:
     *      (String) key: the key on which the model is `unset`.
     *      (Object) model: the `unset` nested model.
     */
    _unsetModel: function (key, model) {}
});

Обратите внимание , что model, _setModelи _unsetModelостается пустым на цели. На этом уровне абстракции вы, вероятно, не можете определить какие-либо разумные действия для обратных вызовов. Однако вы можете захотеть переопределить их в расширяющихся подмоделях CompoundModel.
Эти обратные вызовы полезны, например, для привязки слушателей и распространения changeсобытий.


Пример:

var Layout = Backbone.Model.extend({});

var Image = CompoundModel.extend({
    defaults: function () {
        return {
            name: "example",
            layout: { x: 0, y: 0 }
        };
    },

    /** We need to override this, to define the nested model. */
    model: { layout: Layout },

    initialize: function () {
        _.bindAll(this, "_propagateChange");
    },

    /** Callback to propagate "change" events. */
    _propagateChange: function () {
        this.trigger("change:layout", this, this.get("layout"), null);
        this.trigger("change", this, null);
    },

    /** We override this callback to bind the listener.
     *  This is called when a Layout is set.
     */
    _setModel: function (key, model) {
        if (key !== "layout") { return false; }
        this.listenTo(model, "change", this._propagateChange);
    },

    /** We override this callback to unbind the listener.
     *  This is called when a Layout is unset, or overwritten.
     */
    _unsetModel: function (key, model) {
        if (key !== "layout") { return false; }
        this.stopListening();
    }
});

Благодаря этому у вас есть автоматическое создание вложенной модели и распространение событий. Также предоставляется и протестирован пример использования:

function logStringified (obj) {
    console.log(JSON.stringify(obj));
}

// Create an image with the default attributes.
// Note that a Layout model is created too,
// since we have a default value for "layout".
var img = new Image();
logStringified(img);

// Log the image everytime a "change" is fired.
img.on("change", logStringified);

// Creates the nested model with the given attributes.
img.set("layout", { x: 100, y: 100 });

// Writing on the layout propagates "change" to the image.
// This makes the image also fire a "change", because of `_propagateChange`.
img.get("layout").set("x", 50);

// You may also set model instances yourself.
img.set("layout", new Layout({ x: 100, y: 100 }));

Вывод:

{"name":"example","layout":{"x":0,"y":0}}
{"name":"example","layout":{"x":100,"y":100}}
{"name":"example","layout":{"x":50,"y":100}}
{"name":"example","layout":{"x":100,"y":100}}

2

Я понимаю, что опаздываю на эту вечеринку, но недавно мы выпустили плагин для работы именно с этим сценарием. Это называется backbone-nestify .

Таким образом, ваша вложенная модель остается неизменной:

var Layout = Backbone.Model.extend({...});

Затем используйте плагин при определении содержащей модели (используя Underscore.extend ):

var spec = {
    layout: Layout
};
var Image = Backbone.Model.extend(_.extend({
    // ...
}, nestify(spec));

После этого, если у вас есть модель, mкоторая является экземпляром Image, и вы установили JSON из вопроса m, вы можете сделать:

m.get("layout");    //returns the nested instance of Layout
m.get("layout|x");  //returns 100
m.set("layout|x", 50);
m.get("layout|x");  //returns 50

2

Используйте backbone-формы

Он поддерживает вложенные формы, модели и toJSON. ВСЕ РАЗМЕЩЕННЫЕ

var Address = Backbone.Model.extend({
    schema: {
    street:  'Text'
    },

    defaults: {
    street: "Arteaga"
    }

});


var User = Backbone.Model.extend({
    schema: {
    title:      { type: 'Select', options: ['Mr', 'Mrs', 'Ms'] },
    name:       'Text',
    email:      { validators: ['required', 'email'] },
    birthday:   'Date',
    password:   'Password',
    address:    { type: 'NestedModel', model: Address },
    notes:      { type: 'List', itemType: 'Text' }
    },

    constructor: function(){
    Backbone.Model.apply(this, arguments);
    },

    defaults: {
    email: "x@x.com"
    }
});

var user = new User();

user.set({address: {street: "my other street"}});

console.log(user.toJSON()["address"]["street"])
//=> my other street

var form = new Backbone.Form({
    model: user
}).render();

$('body').append(form.el);

1

Если вы не хотите , чтобы добавить еще одну базу, вы могли бы рассмотреть вопрос о создании базового класса с переопределяется setи toJSONи использовать его как это:

// Declaration

window.app.viewer.Model.GallerySection = window.app.Model.BaseModel.extend({
  nestedTypes: {
    background: window.app.viewer.Model.Image,
    images: window.app.viewer.Collection.MediaCollection
  }
});

// Usage

var gallery = new window.app.viewer.Model.GallerySection({
    background: { url: 'http://example.com/example.jpg' },
    images: [
        { url: 'http://example.com/1.jpg' },
        { url: 'http://example.com/2.jpg' },
        { url: 'http://example.com/3.jpg' }
    ],
    title: 'Wow'
}); // (fetch will work equally well)

console.log(gallery.get('background')); // window.app.viewer.Model.Image
console.log(gallery.get('images')); // window.app.viewer.Collection.MediaCollection
console.log(gallery.get('title')); // plain string

Вам понадобится BaseModelэтот ответ (доступный, если хотите, как суть ).


1

У нас тоже есть эта проблема, и сотрудник команды реализовал плагин с именем backbone-nested-attributes.

Использование очень простое. Пример:

var Tree = Backbone.Model.extend({
  relations: [
    {
      key: 'fruits',
      relatedModel: function () { return Fruit }
    }
  ]
})

var Fruit = Backbone.Model.extend({
})

При этом модель дерева может получить доступ к фруктам:

tree.get('fruits')

Вы можете увидеть больше информации здесь:

https://github.com/dtmtec/backbone-nested-attributes

Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.