migliore soluzione per le collezioni Backbone.js annidati

Question

Molti dei miei modelli Backbone affrontare spesso con modelli annidati e raccolte, fino ad ora sto usando una combinazione di defaults, parse e toJSON manualmente per ottenere la nidificazione:

ACME.Supplier = Backbone.Model.extend({ 
    defaults: function() { 
     return { 
      contacts: new ACME.Contacts(), 
      tags: new ACME.Tags(), 
      attachments: new ACME.Attachments() 
     }; 
    }, 

    parse: function(res) { 
     if (res.contacts) res.contacts = new ACME.Contacts(res.contacts); 
     if (res.tags) res.tags = new ACME.Tags(res.tags); 
     if (res.attachments) res.attachments = new ACME.Attachments(res.attachments); 

     return res; 
    } 
}); 

ACME.Tag = Backbone.Model.extend({ 
    toJSON: function() { 
     return _.pick(this.attributes, 'id', 'name', 'type'); 
    } 
}); 

Ho esaminato alcuni plugin là fuori che fondamentalmente fa lo stesso di sopra ma con molto meno controllo e più boilerplate, quindi mi chiedo se qualcuno abbia una soluzione più elegante a questo comune problema di Backbone.js.

---

Edit: ho finito con il seguente approccio:

ACME.Supplier = Backbone.Model.extend({ 
    initialize: function(options) { 
     this.tags = new ACME.Tags(options.tags); 
    }, 

    parse: function(res) { 
     res.tags && this.tags.reset(res.tags); 

     return res; 
    } 
}); 

ACME.Tag = Backbone.Model.extend({ 
    toJSON: function() { 
     return _.pick(this.attributes, 'id', 'name', 'type'); 
    } 
}); 

Vale la pena notare che più tardi ho scoperto che è necessario passare i dati del modello/raccolta nidificate dal costruttore in il costruttore del modello annidato tramite l'oggetto options.

Answer 1

Non vedo alcun problema con il tuo approccio.

IMHO il metodo Model.parse() se per questo: da sovrascrivere nel caso in cui sia necessario un comportamento di analisi speciale.

L'unica cosa che vorrei cambiare sarebbe cose come questa:

if (res.tags) res.tags = new ACME.Tags(res.tags); 

Per questo:

if (res.tags) this.tags.reset(res.tags); 

causa si dispone già di un'istanza di ACME.Tags raccolta avrei riutilizzarlo.

Inoltre non mi piace molto l'implementazione defaults, sono abituato a fare queste inizializzazioni nel Model.initialize() ma penso sia una questione di gusti.

Answer 2

Ho scoperto che con questo approccio la funzione toJSON del fornitore sarà obsoleta, quindi potrebbe essere una buona idea riassemblare lo stato JSON da esso, e sono i dati dei bambini.

ACME.Supplier = Backbone.Model.extend({ 
    initialize: function(options) { 
     this.tags = new ACME.Tags(options.tags); 
    }, 

    parse: function(res) { 
     res.tags && this.tags.reset(res.tags); 

     return res; 
    }, 

    toJSON: function({ 
     return _.extend(
      _.pick(this.attributes, 'id', 'attr1', 'attr2'), { 
      tags: this.tags.toJSON(), 
     }); 
    }) 

});

Answer 3

Non volevamo aggiungere un altro framework per ottenerlo, quindi lo abbiamo astratto in una classe del modello di base. Ecco come si dichiara e usarlo (available as a gist):

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

Funziona altrettanto bene con set e toJSON.
Ed ecco BaseModel:

window.app.Model.BaseModel = Backbone.Model.extend({ 
    constructor: function() { 
    if (this.nestedTypes) { 
     this.checkNestedTypes(); 
    } 

    Backbone.Model.apply(this, arguments); 
    }, 

    set: function (key, val, options) { 
    var attrs; 

    /* jshint -W116 */ 
    /* jshint -W030 */ 
    // Code below taken from Backbone 1.0 to allow different parameter styles 
    if (key == null) return this; 
    if (typeof key === 'object') { 
     attrs = key; 
     options = val; 
    } else { 
     (attrs = {})[key] = val; 
    } 
    options || (options = {}); 
    // Code above taken from Backbone 1.0 to allow different parameter styles 
    /* jshint +W116 */ 
    /* jshint +W030 */ 

    // What we're trying to do here is to instantiate Backbone models and collections 
    // with types defined in this.nestedTypes, and use them instead of plain objects in attrs. 

    if (this.nestedTypes) { 
     attrs = this.mapAttributes(attrs, this.deserializeAttribute); 
    } 

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

    toJSON: function() { 
    var json = Backbone.Model.prototype.toJSON.apply(this, arguments); 

    if (this.nestedTypes) { 
     json = this.mapAttributes(json, this.serializeAttribute); 
    } 

    return json; 
    }, 

    mapAttributes: function (attrs, transform) { 
    transform = _.bind(transform, this); 
    var result = {}; 

    _.each(attrs, function (val, key) { 
     result[key] = transform(val, key); 
    }, this); 

    return result; 
    }, 

    serializeAttribute: function (val, key) { 
    var NestedType = this.nestedTypes[key]; 
    if (!NestedType) { 
     return val; 
    } 

    if (_.isNull(val) || _.isUndefined(val)) { 
     return val; 
    } 

    return val.toJSON(); 
    }, 

    deserializeAttribute: function (val, key) { 
    var NestedType = this.nestedTypes[key]; 
    if (!NestedType) { 
     return val; 
    } 

    var isCollection = this.isTypeASubtypeOf(NestedType, Backbone.Collection), 
     child; 

    if (val instanceof Backbone.Model || val instanceof Backbone.Collection) { 
     child = val; 
    } else if (!isCollection && (_.isNull(val) || _.isUndefined(val))) { 
     child = null; 
    } else { 
     child = new NestedType(val); 
    } 

    var prevChild = this.get(key); 

    // Return existing model if it is equal to child's attributes 

    if (!isCollection && child && prevChild && _.isEqual(prevChild.attributes, child.attributes)) { 
     return prevChild; 
    } 

    return child; 
    }, 

    isTypeASubtypeOf: function (DerivedType, BaseType) { 
    // Go up the tree, using Backbone's __super__. 
    // This is not exactly encouraged by the docs, but I found no other way. 

    if (_.isUndefined(DerivedType['__super__'])) { 
     return false; 
    } 

    var ParentType = DerivedType['__super__'].constructor; 
    if (ParentType === BaseType) { 
     return true; 
    } 

    return this.isTypeASubtypeOf(ParentType, BaseType); 
    }, 

    checkNestedTypes: function() { 
    _.each(this.nestedTypes, function (val, key) { 
     if (!_.isFunction(val)) { 
     console.log('Not a function:', val); 
     throw new Error('Invalid nestedTypes declaration for key ' + key + ': expected a function'); 
     } 
    }); 
    }, 
} 

Answer 4

Di fronte lo stesso problema, faccio una cosa del genere (il codice qui sotto è l'uscita del compilatore dattiloscritto quindi è un po 'prolisso):

var Model = (function (_super) { 
    __extends(Model, _super); 
    function Model() { 
     _super.apply(this, arguments); 
    } 
    Model.prototype.fieldToType = function() { 
     return {}; 
    }; 

    Model.prototype.parse = function (response, options) { 
     _.each(this.fieldToType(), function (type, field) { 
      if (response[field]) { 
       if (_.isArray(response[field])) { 
        response[field] = _.map(response[field], function (value) { 
         return new type(value, { parse: true }); 
        }); 
       } else { 
        response[field] = new type(response[field], { parse: true }); 
       } 
      } 
     }); 
     return _super.prototype.parse.call(this, response, options); 
    }; 
    Model.prototype.toJSON = function() { 
     var j = _super.prototype.toJSON.call(this); 
     _.each(this.fieldToType(), function (type, field) { 
      if (j[field]) { 
       if (_.isArray(j[field])) { 
        j[field] = _.map(j[field], function (value) { 
         return value.toJSON(); 
        }); 
       } else { 
        j[field] = j[field].toJSON(); 
       } 
      } 
     }); 
     return j; 
    }; 
    return Model; 
})(Backbone.Model); 

E poi ho può semplicemente sovrascrivere il metodo fieldToType per definire i tipi dei miei campi:

PendingAssignmentOffer.prototype.fieldToType = function() { 
    return { 
     'creator': User, 
     'task_templates': TaskTemplateModel, 
     'users': User, 
     'school_classes': SchoolClass 
    }; 
};