Ember Data Model Fragments 使用教程

Ember Data Model Fragments 使用教程

ember-data-model-fragments Ember Data addon to support nested JSON documents 项目地址: https://gitcode.com/gh_mirrors/em/ember-data-model-fragments

1. 项目介绍

Ember Data Model Fragments 是一个 Ember Data 的插件，旨在支持嵌套的 JSON 文档。它允许开发者将子模型视为 belongsTo 和 hasMany 关系，但这些子模型的持久化完全由父对象管理。该项目广泛使用 Ember Data 的私有 API，因此对新版本的 Ember Data 的兼容性较为敏感。

2. 项目快速启动

安装

首先，通过 Ember CLI 安装 ember-data-model-fragments 插件：

$ ember install ember-data-model-fragments

创建 Fragment

接下来，创建一个 Fragment 类。例如，创建一个名为 foo 的 Fragment，包含两个属性 someAttr 和 anotherAttr：

$ ember generate fragment foo someAttr:string anotherAttr:boolean

这将生成一个模块 app/models/foo.js，其中包含一个 Fragment 类：

// app/models/foo.js
import Fragment from 'ember-data-model-fragments/fragment';
import { attr } from '@ember-data/model';

export default class FooFragment extends Fragment {
  @attr('string') someAttr;
  @attr('boolean') anotherAttr;
}

使用 Fragment

在模型中使用 Fragment：

// app/models/person.js
import Model from '@ember-data/model';
import { fragment, fragmentArray, array } from 'ember-data-model-fragments/attributes';

export default class PersonModel extends Model {
  @fragment('name') name;
  @fragmentArray('address') addresses;
  @array('string') titles;
}

3. 应用案例和最佳实践

案例1：处理嵌套数据

假设有一个 Person 模型，包含 Name 和 Address 的嵌套数据：

// app/models/name.js
import Fragment from 'ember-data-model-fragments/fragment';
import { attr } from '@ember-data/model';

export default class NameFragment extends Fragment {
  @attr('string') first;
  @attr('string') last;
}

// app/models/address.js
import Fragment from 'ember-data-model-fragments/fragment';
import { attr } from '@ember-data/model';

export default class AddressFragment extends Fragment {
  @attr('string') street;
  @attr('string') city;
  @attr('string') region;
  @attr('string') country;
}

最佳实践

1. 使用默认值：为 Fragment 属性设置默认值，避免空值问题。
2. 处理嵌套数据：确保嵌套数据的结构清晰，便于管理和维护。

4. 典型生态项目

Ember Data

Ember Data 是 Ember.js 的官方数据管理库，ember-data-model-fragments 作为其插件，扩展了 Ember Data 的功能，支持更复杂的嵌套数据结构。

Ember CLI

Ember CLI 是 Ember.js 的命令行工具，用于生成和管理 Ember 项目。通过 Ember CLI，可以方便地安装和管理 ember-data-model-fragments 插件。

Ember Inspector

Ember Inspector 是一个浏览器扩展，用于调试和检查 Ember 应用程序。它可以帮助开发者查看和调试嵌套的 Fragment 数据。

通过以上模块的介绍，您可以快速上手并深入了解 ember-data-model-fragments 的使用和最佳实践。

ember-data-model-fragments Ember Data addon to support nested JSON documents 项目地址: https://gitcode.com/gh_mirrors/em/ember-data-model-fragments