asp.net-web-api - ember-data:按需加载hasMany关联

Question

(已针对ember-data API Rev 11更新...)

TL; DR

使用DS.Adapter.findAssociation(...) DS.Adapter.findHasMany(...)按需加载hasMany关联的正确方法是什么？尤其是，一旦加载了子记录，如何处理从服务器重新加载父记录会清空hasMany数组的事实？我不想(也许不能)在父级数组中包含子级记录的ID。还是有另一种我想念的方式？

附带说明一下，我对于应该在键链接的hasMany / belongsTo定义中传递哪些选项感到困惑(如果我没有侧面加载的数据或ID数组，我应该使用映射吗？)，所以如果您认为我认为问题可能出在我的关联定义中，很可能您是对的。

长版

我正在编写自己的DS.RESTAdapter子类，以将ember-data绑定(bind)到ASP.NET WebAPI后端(使用实体框架)。到目前为止，一切都很好，但是我很难过一段时间才能使协会正常工作。

与this poster相似，我注意到ember-data的首页上曾经说过，如果您的模型中具有hasMany关联，并且您对该属性进行get，则存储将发出对子记录的请求。从页面引用:

If you were to request the profile, like this:

author.get('profile');

…the REST adapter would send a request to the URL /profiles?author_id=1.

含义是，如果您不侧载并且不包含ID数组，则会发生这种情况。我意识到这些文档有些过时了，但是无论是在API版本7还是最新版本9中，我都无法做到这一点。但是在版本9中，我确实找到了 findAssociation方法，在版本11中， findHasMany方法，我猜这可能是用来实现此目的的方法，现在我正在尝试使用。

为什么不包含ID或侧载数组？

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

用ASP.NET WebAPI如何做这两种事情都不是很明显，至少不是用我正在使用的基于装饰的简单方法。而且，我真的很喜欢后端的简单性和轻薄性，有了EF和WebAPI，几乎每个实体都变得非常简单，我就完成了!我什至获得了“免费”的OData过滤支持。

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

我有一些子实体，其中主键是复合键。我还没有看到在ember-data中甚至可以支持/可能的示例，至少不是为了处理关联(例如，如何处理ID数组？)。我在客户端模型中创建了一个计算属性，该属性将组合键强制为单个字符串，因此我可以使用find(...)从存储中检索单个记录，但是我也不知道如何使用关联也可以。

尝试使用 findAssociation findHasMany
我发现在API版本9(以及某些较早版本，但不是全部？)中，我也许可以实现 DS.Adapter.findAssociation DS.Adapter.findHasMany方法来检索 hasMany关联的子记录。这主要起作用，但是需要一些体操。这是我广义的 findAssociation 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 hasRelationship中调用 findMany的那一行来看，您将看到第二个参数传递了什么:

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

因此，要调用 findAssociation findHasMany的唯一方法是使JSON中的值是“真实的”东西，而不是“数组”-我使用 true。我认为这可能是错误/未完成，或者是表明我走错了轨道-如果有人可以告诉我，那也很好。

有了这些，我可以得到ember-data来自动向服务器发出请求以获取子记录，例如到 http://myserver.net/api/child_entity/$filter=ChildForeignKey eq '42'并起作用-子记录被加载，并且它们与父记录相关联(顺便说一句，尽管我没有明确地触摸它，但 belongsTo的反向关系也得到了适当填充-我不知道在何处或如何发生)。

但是，如果我不停在那里，那很快就会崩溃。

处理重载父记录

可以这么说，我已成功将子记录加载到父记录中，但随后导航到检索了所有父记录的位置(以填充菜单)。由于新加载的父记录没有id数组，并且没有任何侧载，因此刷新了父记录，而没有任何子级!更糟糕的是， ManyArray的 isLoaded属性仍然是 true!所以我什至没有观察到任何东西可以重载孩子。

因此，如果同时在屏幕上显示子值，则该 View 立即变为没有子记录值。或者，如果我导航回到一个位置，则在调用 App.store.find('App.ParentEntity', 42)时，将从存储中加载记录，而无需请求服务器，当然也没有子记录。

这是提示2，我可能会以错误的方式进行操作。那么...按需加载子记录的正确方法是什么？

非常感谢!

Answer 1

基于最新的Ember数据(截至2013年1月25日)...这是我对hasMany延迟加载的解决方案。我修改了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作为 findMany传递到 undefined中。

接下来，我向 didFindHasMany添加了 DS.Adapter钩子(Hook):

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钩子(Hook)之后使用我发现已经在 loadHasMany上实现的 DS.Store对此建模。然后，在我的自定义适配器中，我实现了 findHasMany方法，该方法在其成功回调中使用以下代码:

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

我尚未对此进行广泛的测试，但它似乎可以正常工作。从最近对ember-data的代码进行的修改来看，在我看来，它们一直在朝着将来将在某种程度上支持类似于此方法的方向发展。或者至少是我的希望。