有效载荷 JSONAPI 中的 EmberJS 嵌入项

EmberJS embedded items in payload JSONAPI

Ember      : 1.13.3
Ember Data : 1.13.5
jQuery     : 1.11.3

我正在尝试使用 ember 数据从我的 EmberJS 客户端向我的服务器发送一个 JSON 负载。我想在保存项目时将整个对象图发送到服务器,因为我不想发送多个请求。我不介意发送多个请求,但我担心如果其中一个请求在中间失败并且服务器上的数据不正确会发生什么。

我想使用 JSONAPI (http://jsonapi.org/format/#document-compound-documents),因为它正在成为 Ember 中的默认适配器。此外,还有一些处理这种格式的 C# 库,所以我认为它会非常简单。但是,在阅读规范后,如果对象没有 ID,我似乎无法嵌入它们。 EmberJS 也不会将子对象附加到 JSON,即使我在 DS.attr 上指定了 { async: false, embedded: 'always' })

我的问题是:如果以在客户端创建对象图的方式使用应用程序,如何使用JSONAPI 格式将整个对象图发送到服务器?我是否必须在客户端生成 ID 以满足 JSONAPI 标准?然后一旦他们到达服务器就忽略他们,这样他们就可以用 ORM 生成的 ID 保存?

这是我的 labelGroup 模型:

import DS from 'ember-data';

export default DS.Model.extend({
  name: DS.attr('string'),
  labels: DS.hasMany('label-model', { async: false, embedded: 'always' })
});

这是我的项目模型:

import DS from 'ember-data';

export default DS.Model.extend(DS.EmbeddedRecordsMixin, {
  name: DS.attr('string'),
  labelGroups: DS.hasMany('labelGroup', { async: false, embedded: 'always'})

});

这是我在对项目执行 save() 后得到的 POST:

{
  "data":{
    "attributes":{"name":"Project"},
    "relationships":{
      "label-groups":{
        "data":[
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null},
         {"type":"label-groups","id":null}
       ]
     }
   },
   "type":"label-projects"
  }
}

更新:我尝试使用 https://www.npmjs.com/package/ember-cli-uuid 来生成它拥有的客户端 ID。然而,获取输出的数据不包括额外的对象,仅包括对其 ID 的引用。我希望看到此处指定的 "included" 属性:http://jsonapi.org/format/#document-compound-documents,但它不存在。

{
  "data":{
    "id":"7b4544ee-91cd-493d-8b10-52040e68c283",
    "attributes":{"name":"Project"},
  "relationships":{
    "label-groups":{
      "data":[
       {"type":"label-groups","id":"08115273-e82a-4d46-93ea-232ce071fb78"},
       {"type":"label-groups","id":"9ca94fe9-8077-411e-98d2-1694c6fecce4"},
       {"type":"label-groups","id":"d629f1e8-7962-404d-8034-38229ab21f77"},
       {"type":"label-groups","id":"c6bda655-5489-4760-847b-bf02239bb2c5"},
       {"type":"label-groups","id":"f6fef249-2d1d-43f0-ba64-24b7ff8b5637"},
       {"type":"label-groups","id":"a7db25bf-52c8-477b-83e4-64e7c76b072e"},
       {"type":"label-groups","id":"f3b5fbb3-261a-4b3d-b481-b9352f8ce2d6"}
      ]
    }
  },
  "type":"label-projects"
  }
}

Ember-data 目前不支持您想要的内容。因此 ember-data 不会将您的关系数据保存在保存负载中。

但是您可以使用自定义适配器和序列化程序自己完成此操作。 我强烈建议您查看 API,然后查看源代码。

如果您在您的模型上调用 .save(),则会在您的适配器上调用 createRecord 方法。 这里调用序列化器上的 serializeIntoHash 来序列化模型。

serializeIntoHash 调用 serialize,其中 serializeBelongsToserializeHasMany 被调用。

现在您可以覆盖 serializeHasMany 并修改行前的 hasMany

json[payloadKey] = hasMany;

这里有 ember-data 发送的类型和 ID。您可以只 .forEach hasMany 上的数据,然后获取数据的存储并构建您的 included 数组。

我希望这可以帮助您理解序列化程序和适配器,以便您可以轻松地对其进行修改以执行您想要的任何操作。实际上这是关于 ember-data 的最好的部分。适配器和序列化器的结构,允许轻松修改。