@ngrx/entity 简介

原文链接:https://medium.com/ngrx/introducing-ngrx-entity-598176456e15

关于使用NgRx构建应用程序最常见的抱怨之一是开发人员必须编写的样板代码数量。 试图解决样板问题时的挑战在于,为了从体系结构中获得全部优势,必需的明确性至关重要。 我们认为,通过开发有针对性的库,我们可以帮助减少一些这种样板,同时保留NgRx提供的所有好处。

今天,我们很高兴宣布发布@ngrx/entity,它是NgRx团队中第一个旨在减少样板的类库。 其目标是帮助开发人员编写维护实体集合的Reducer功能。

她是如何工作的

@ngrx/entity允许您为不同类型的实体创建实体适配器(entity adapter)。 使用实体适配器,您可以快速编写 reducer 操作并自动生成选择器(selector)。 例如我们的 example application,假设我们想编写一个管理书籍集合的应用程序。 Book 接口(interface)如下所示:

interface Book {
    id: string;
    title: string;
}

编写管理这个集合的reducer的第一步是创建一个实体适配器(entity adapter):

import { createEntityAdapter } from '@ngrx/entity';

const bookAdapter = createEntityAdapter<Book>();

接下来,我们需要为我们的书籍状态声明接口:

import { EntityState } from '@ngrx/entity';

export interface BookState extends EntityState<Book> {}

EntityState的声明如下所示:

interface EntityState<V> {
    ids: string[];
    entities: { [id: string]: V };
}

我们维护一个ID列表和 Entity 字典的主要原因有两点:

  1. 我们希望快速查找特定的实体。 如果您只想从 Store 中选择一本书,使用 Entity 词典比搜索数组要快得多
  2. 我们也想维护列表的顺序。 如果你想保持列表排序,这是特别重要的!

EntityState<V>的声明符合所有目标。 它也是可扩展的,所以我们可以在书籍集合中包含其他相关信息,例如当前选择的书籍。

接下来,定义一些操作:

improt { Action } from '@ngrx/store';

export enum BookActionTypes {
    ADD_ONE = '[Books] Add One',
    UPDATE_ONE = '[Books] Update One',
    DELETE_ONE = '[Books] Delete One',
    GET_ALL = '[Books] Get All',
}

export class AddOne implements Action {
    readonly type = BookActionType.ADD_ONE;

    constructor(public book: BookModel) {}
}

export class UpdateOne implements Action {
    readonly type = BookActionType.UPDATE_ONE;
    constructor(
        public id: string,
        public changes: Partial<BookModel>
    ) {}
}

export class DeleteOne implements Action {
    readonly type = BookActionType.DELETE_ONE;
    constructor(
        public id: string
    ) {}
}

export class GetAll implements Action {
    readonly type = BookActionType.GET_ALL;
    constructor(
        public books: BookModel[]
    ) {}
}

export type BookActions = AddOne
    | UpdateOne
    | DeleteOne
    | GetAll
    ;

现在我们准备使用bookAdapter来创建我们的书籍 reducer:

const initialState: BookState = bookAdapter.getInitialState();

export function bookReducer(
    state: BookState = initialState,
    action: BookActions,
) {
    switch (action.type) {
        case BookActionTypes.ADD_ONE:
            return bookAdapter.addOne(action.type, state);
        case BookActionTypes.UPDATE_ONE:
            return bookAdapter.updateOne({
                id: action.id,
                changes: action.changes,
            }, state);
        case BookActionTypes.DELETE_ONE:
            return bookAdapter.deleteOne(action.id, state);
        case BookActionTypes.GET_ALL:
            return bookAdapter.addAll(action.books, state);
        default:
            return state;
    }
}

新的状态可以使用新创建的 reducer 在 Store 中注册。 我们需要做的最后一件事就是生成用于处理这个状态的选择器(selector):

export const {
    selectIds,
    selectEntities,
    selectAll,
    selectToAll
} = bookAdapter.getSelectors();

那么样板代码做了哪些?

  1. 不再需要显式声明状态接口(state interface)的所有属性
  2. 添加,删除或更新状态实体(state entity)的实现都由适配器处理。
  3. 该适配器会为您生成一组常用的选择器。

关于 Entity 的更多文档查看 NgRx Gihub仓库 以及 example application示例项目中的实际应用。

NgRx 4.1 发布

除了发布 @ngrx/entity 之外,我们还发布了 Store,Effects 和 Router Store 的v4.1.0,其中包含许多新功能和错误修复。 有关包含内容的更多信息,请查看更新日志

帮助支持 NgRx

随着 NgRx4,我们宣布创建我们的 OpenCollective,您可以帮助支持NgRx的开发。 我们非常感谢来自支持者、赞助商和社区的支持。 作为这些贡献的结果,Entity 是第一个创建的库。 Entity 是为NgRx平台创建更多库的第一步。 考虑通过OpenCollective支持这些开发工作。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,039评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,223评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,916评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,009评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,030评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,011评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,934评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,754评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,202评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,433评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,590评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,321评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,917评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,568评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,738评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,583评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,482评论 2 352

推荐阅读更多精彩内容