ember-data:按需加载多个关联

Question

(更新为ember-data API Rev 11 ...)

TL; DR

使用按需加载关联的正确方法是什么？特别是,一旦你加载子记录,你如何处理从服务器重新加载父记录清空hasMany数组的事实？我不希望(也许不能)包括的子记录的ID在父的数组.还是有其他方法可以做到这一点,我错过了？DS.Adapter.findAssociation(...)DS.Adapter.findHasMany(...)hasMany

作为旁注,我很困惑应该在关键链接的hasMany/ belongsTo定义中传递哪些选项(如果我没有侧载数据或ID数组,我应该使用映射吗？),所以如果你认为我的问题可以在我的协会定义中,你很有可能是对的.

长版

我正在编写自己的子类,DS.RESTAdapter将ember-data绑定到ASP.NET WebAPI后端(使用Entity Framework).到目前为止一切都那么好,但我有一段时间让协会正常工作.

类似这样的海报,我注意到烬数据的头版说 使用地说,如果你有一个hasMany在你的模型关联,你get该财产,商店会发出为孩子记录的请求.从页面引用:

如果您要请求个人资料,请执行以下操作:

author.get('profile');

... REST适配器会向URL/profiles发送请求吗？author_id = 1.

这意味着如果你没有侧载并且不包含一组id,会发生这种情况.我意识到这些文档有点过时了,但是我无法在API版本7或更新的版本9中实现这一点.但是在版本9中我确实找到了findAssociation方法,在版本11中有findHasMany方法,我猜是可能已经用来实现这一点,我现在正在尝试使用它.

为什么不包括一组id或sideload？

我不想做的三个主要原因(可能不能):

1. 使用ASP.NET WebAPI如何做这些事情并不明显,至少不是我使用的基于装饰的简单方法.而且,我现在非常喜欢后端的简单性和轻薄性,使用EF和WebAPI它几乎完全是每个实体的样板,我已经完成了!我甚至可以"免费"获得OData过滤支持.

2. 我的子记录通常会通过昂贵的查询生成(例如聚合...指标汇总).并且单个父实体有许多不同类的子实体.因此,即使为所有子类型获取ID 也会很昂贵,并且生成和侧载所有子记录都是不可能的.

3. 我有子实体,主键是复合键.我还没有看到这样的例子甚至在ember-data中得到支持/可能,至少不是用于处理关联(例如,你将如何做一组id？).我在我的客户端模型中创建了一个计算属性,它将复合键强制转换为单个字符串,因此我可以使用从存储中检索单个记录find(...),但是我再也不知道它如何与关联一起工作.

试着用 findAssociationfindHasMany

我已经发现在API版本9(和一些早期版本但不是全部？) 11中,我可以实现该方法来检索关联的子记录.这大部分都有效,但需要一些体操.这是我的通用方法:DS.Adapter.findAssociation DS.Adapter.findHasManyhasManyfindAssociation findHasMany

findHasMany: function (store, record, relationship, ids) {

    var adapter = this;
    var root = this.rootForType(relationship.type);
    var query = relationship.options.query(record);

    var hits = store.findQuery(relationship.type, query);

    hits.on('didLoad', function () {
        // NOTE: This MUST happen in the callback, because findHasMany is in
        // the execution path for record.get(relationship.key)!!! Otherwise causes
        // infinite loop!!!
        var arrMany = record.get(relationship.key);

        if (hits.get('isLoaded')) {
            arrMany.loadingRecordsCount = 1 + hits.get('length') + (typeof arrMany.loadingRecordsCount == "number" ? arrMany.loadingRecordsCount : 0);
            hits.forEach(function (item, index, enumerable) {
                arrMany.addToContent(item);
                arrMany.loadedRecord();
            });
            arrMany.loadedRecord(); // weird, but this and the "1 +" above make sure isLoaded/didLoad fires even if there were zero results.
        }
    });

}

为了使这项工作,我的hasMany定义设置了一个query选项值,它是记录上的一个函数,它返回子请求中查询字符串的参数哈希值.由于这是一个ASP.NET WebAPI后端,这可能是一个OData过滤器,例如:

App.ParentEntity = DS.Model.extend({
    ...
    children: DS.hasMany('App.ChildEntity', {
        query: function (record) {
            return {
                "$filter": "ChildForeignKey eq '" + record.get('id') + "'"
            };
        }
    })
});

其中一个技巧是将项目添加到ManyArray使用中addToContent(item),这样父记录就不会被标记为"脏",就像它已被编辑一样.另一种是,当我最初检索父记录的JSON时,我必须手动设置true关联名称密钥的值(来自服务器的JSON根本没有密钥).即:

    var a = Ember.isArray(json) ? json : [json];
    for (var i = 0; i < a.length; i++) {
        type.eachAssociation(function (key) {
            var meta = type.metaForProperty(key);
            a[i][key] = true;
        });
    }

这听起来很疯狂,但这就是为什么:如果你看一下实现DS.Store.findMany并找到调用的地方,你会发现:findAssociation findHasMany

findMany: function(type, ids, record, relationship){
...
if (!Ember.isArray(ids)) {
  var adapter = this.adapterForType(type);
  if (adapter && adapter.findHasMany) { adapter.findHasMany(this, record, relationship, ids); }
  else { throw fmt("Adapter is either null or does not implement `findMany` method", this); }

  return this.createManyArray(type, Ember.A());
}

如果你从调用的ember-data内部函数中查看这一行,你会看到为第二个参数传递的内容:hasAssociation hasRelationshipfindMany

relationship = store.findMany(type, ids || [], this, meta);

因此,要被调用的唯一方法是让JSON中的值成为"真实",但不是数组 - 我使用.我认为这是一个错误/不完整,或者表明我走错了路 - 如果有人能告诉我哪个也会很好.findAssociation findHasManytrue

有了这些,我可以让ember-data自动向服务器发出子记录的请求,例如,http://myserver.net/api/child_entity/$filter=ChildForeignKey eq '42'并且它可以工作 - 子记录被加载,并且它们与父记录相关联(顺便提一下,反向belongsTo关系)尽管事实上我没有明确地触及它 - 我也不知道在哪里或如何发生这种情况.

但如果我不停在那里,那很快就会崩溃.

处理重新加载父记录

所以说我成功地将子记录加载到父记录中,然后导航到检索所有父记录的位置(以填充菜单).由于新加载的父记录没有ids数组且没有任何侧载,因此父记录将刷新而不再有任何子项!更糟的是,ManyArray的isLoaded属性保持true!所以我甚至无法观察任何重新装载孩子的事情.

因此,如果我同时在屏幕上显示子值,则会立即显示没有子记录值.或者如果我导航回一个,当App.store.find('App.ParentEntity', 42)被调用时,记录从商店加载而没有请求到服务器,当然它没有子记录.

这是暗示#2,我可能会以错误的方式解决这个问题.那么......按需加载子记录的正确方法是什么？

非常感谢!

Answer 1

基于最新的Ember数据(截至2013年1月25日)...这是我对延迟加载的解决方案有很多关系.我修改DS.hasMany并添加了一个方法DS.Adapter.

我换了两行DS.hasMany:

DS.hasMany = function(type, options) {
  Ember.assert("The type passed to DS.hasMany must be defined", !!type);
  return (function(type, options) {
    options = options || {};
    var meta = { type: type, isRelationship: true, options: options, kind: 'hasMany' };
    return Ember.computed(function(key, value) {
      var data = get(this, 'data').hasMany,
          store = get(this, 'store'),
          ids, relationship;

      if (typeof type === 'string') {
        type = get(this, type, false) || get(Ember.lookup, type);
      }

      meta.key = key;
      ids = data[key];
      relationship = store.findMany(type, ids, this, meta);
      set(relationship, 'owner', this);
      set(relationship, 'name', key);
      return relationship;
    }).property().meta(meta);
  })(type, options);

};

首先,我添加key到meta对象...

meta.key = key;

......第二,如前所述,我findMany通过改变来删除呼叫中的空数组......

relationship = store.findMany(type, ids || [], this, meta);

...至...

relationship = store.findMany(type, ids, this, meta);

......允许ids传入findManyas undefined.

接下来,我添加了一个didFindHasMany钩子DS.Adapter:

DS.Adapter.reopen({

  /**
   Loads the response to a request for records by findHasMany.

   Your adapter should call this method from its `findHasMany`
   method with the response from the backend.

   @param {DS.Store} store
   @param {subclass of DS.Model} type
   @param {any} payload
   @param {subclass of DS.Model} record the record of which the relationship is a member (parent record)
   @param {String} key the property name of the relationship on the parent record
   */
  didFindHasMany: function(store, type, payload, record, key) {

    var loader = DS.loaderFor(store);

    loader.populateArray = function(references) {
      store.loadHasMany(record, key, references.map(function(reference) { return reference.id; }));
    };

    get(this, 'serializer').extractMany(loader, payload, type);
  }

});

我在使用我发现的已经实现DS.Adapter的didFindQuery钩子之后对此进行了建模.然后在我的自定义适配器中,我实现了一个方法,该方法在其成功回调中使用以下代码:loadHasManyDS.StorefindHasMany

Ember.run(this, function() {
  adapter.didFindHasMany(store, type, response.data, record, key);
});

我没有对此进行过广泛的测试,但似乎工作正常.通过对最近对ember-data代码所做的修改,在我看来,他们已经慢慢向一个方向发展,在这个方向上将来会支持类似于这种方法的东西.或者至少这是我的希望.