Backbone.js 中的嵌套模型，如何处理

Question

我已从服务器提供了以下 JSON。有了这个，我想创建一个带有嵌套模型的模型。我不确定哪种方法可以实现这一目标。

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

我希望将它们转换为具有以下结构的两个嵌套骨干模型：

// structure
Image
    Layout
...

因此，我像这样定义布局模型：

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

但是我应该使用下面两种（如果有）技术中的哪一种来定义图像模型？下面是A还是B？

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') );
    }
});

Answer 1

我在编写 Backbone 应用程序时遇到了同样的问题。必须处理嵌入式/嵌套模型。我做了一些调整，我认为这是一个非常优雅的解决方案。

是的，您可以修改解析方法来更改对象中的属性，但在我看来，所有这些实际上都是相当难以维护的代码，并且感觉更像是一种黑客而不是解决方案。

这是我对您的示例的建议：

首先像这样定义您的布局模型。

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

另请注意，您实际上是通过以下方式调用嵌套模型中的 parse 方法：

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

您可以根据需要在 model 字段中定义任意数量的嵌套模型。

当然，如果您想将嵌套模型保存在自己的表中。这还不够。但在读取和保存整个对象的情况下，这个解决方案应该足够了。

Answer 2

我发布此代码作为 Peter Lyon 建议重新定义解析的示例。我有同样的问题，这对我有用（使用 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;
};

Answer 3

使用 Backbone-associations 中的 Backbone.AssociatedModel ：

    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
        }
    });

Answer 4

我不确定 Backbone 本身是否有推荐的方法来执行此操作。 Layout对象是否有自己的ID并在后端数据库中有记录？如果是这样，您可以将其设为自己的模型。如果没有，您可以将其保留为嵌套文档，只需确保在 save 和 parse 方法中正确地将其与 JSON 相互转换即可。如果您最终采取了这样的方法，我认为您的 A 示例与骨干网更加一致，因为 set 将正确更新attributes，但是我再次不确定 Backbone 默认情况下对嵌套模型做了什么。您可能需要一些自定义代码来处理此问题。

Answer 5

如果你想让事情变得简单，我会选择选项 B。

另一个不错的选择是使用 Backbone-Relational。你只需定义类似的东西：

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

Answer 6

我使用 Backbone DeepModel 插件来实现嵌套模型和属性。

https://github.com/powmedia/backbone-deep-model

您可以绑定到深度改变事件。例如：
model.on('change:example.nestedmodel.attribute', this.myFunction);

Answer 7

rycfung 漂亮答案的 CoffeeScript 版本：

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

那不是很甜吗？ ;)

Answer 8

我遇到了同样的问题，并且一直在尝试 rycfung 的答案中的代码，这是一个很好的建议。
但是，如果您不想直接设置嵌套模型，或者不想不断地
在 options 中传递 {parse: true} ，另一种方法是重新定义 set 本身。

在Backbone 1.0.0中，set在constructor中调用，unset，clear ，获取并保存。

对于需要嵌套模型和/或集合的所有模型，请考虑以下超级模型。

/** 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}}

Answer 9

我意识到我参加这个聚会迟到了，但我们最近发布了一个插件来处理这种情况。它称为 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

Answer 10

使用backbone-forms

支持嵌套表单、模型和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: "[email protected]"
    }
});

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

Answer 11

如果您不想添加另一个框架，您可以考虑创建一个覆盖 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 来自此答案（如果您愿意，可以使用作为要点）。

Answer 12

我们也遇到这个问题，团队工作人员实现了一个名为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