乐趣区

关于javascript:使用-normalizr-进行复杂数据转换

笔者已经开发过一个数据分享类的小程序,分享逻辑上相似于百度网盘。以后数据能够由被分享者加工而后持续分享(能够控制数据的过期工夫、是否能够加工数据以及持续分享)。

分享的数据是一个深度嵌套的 json 对象。在用户读取分享数据时存入小程序云数据库中(分享的数据和业务数据有差别,没应用业务服务器进行保护)。如果拿到数据就间接存储的话,很快云数据库就会变得很大,其次咱们也没方法剖析各项和检索各项子数据给予分享者。

这时候须要进行数据转换以便拆分和保护。咱们能够应用 redux 作者 Dan Abramov 编写的 normalizr 来解决数据。

normalizr 创建的初衷是解决深层,简单的嵌套的对象。

如何应用

略微批改一下官网的例子,假设获取到如下书籍的数据:

{
  id: "1",
  title: "JavaScript 从入门到放弃",
  // 作者
  author: {
    id: "1",
    name: "chc"
  },
  // 评论
  comments: [
    {
      id: "1",
      content: "作者写的太好了",
      commenter: {
        id: "1",
        name: "chc"
      }
    },
     {
      id: "2",
      content: "楼上造假数据哈",
      commenter: {
        id: "2",
        name: "dcd"
      }
    },
  ]
}

这时候咱们能够写出 3 个主体: 书籍信息、评论以及用户。咱们先从根底的数据来结构模式:

import {normalize, schema} from 'normalizr';

// 结构第一个实体 用户信息
const user = new schema.Entity('users');

// 结构第二个实体 评论
const comment = new schema.Entity('comments', {
  // 评价者是用户
  commenter: user
});

// 结构第三个实体 书籍
const book = new schema.Entity('books', {
  // 作者
  author: user,
  // 评论
  comments: [comment]
});

// 传入数据以及以后最大的 schema 信息
const normalizedData = normalize(originalData, book);

先来看一下最终数据。

{
  "entities": {
    "users": {
      "1": {
        "id": "1",
        "name": "chc"
      },
      "2": {
        "id": "2",
        "name": "dcd"
      }
    },
    "comments": {
      "1": {
        "id": "1",
        "content": "作者写的太好了",
        "commenter": "1"
      },
      "2": {
        "id": "2",
        "content": "楼上造假数据哈",
        "commenter": "2"
      }
    },
    "books": {
      "1": {
        "id": "1",
        "title": "JavaScript 从入门到放弃",
        "author": "1",
        "comments": [
          "1",
          "2"
        ]
      }
    }
  },
  "result": "1"
}

去除其余信息,咱们能够看到获取了 3 个不同的实体对象, users,comments,books。对象的键为以后 id,值为以后平铺的数据结构。这时候咱们就能够应用对象或者数组(Object.values) 来新增和更新数据。

解析逻辑

看到这里,大家可能是很懵的。先不论代码实现,这里先剖析一下库是如何解析咱们编写的 schema 的,以便大家能够在理论场景中应用,再看一遍数据和 schema 定义:

数据结构

{
  id: "1",
  title: "JavaScript 从入门到放弃",
  // 作者
  author: {
    id: "1",
    name: "chc"
  },
  // 评论
  comments: [
    {
      id: "1",
      content: "作者写的太好了",
      commenter: {
        id: "1",
        name: "chc"
      }
    },
     {
      id: "2",
      content: "楼上造假数据哈",
      commenter: {
        id: "2",
        name: "dcd"
      }
    },
  ]
}
  • 书籍信息是第一层对象,数据中有 id, title, author, comments,对应 schema 如下

    const book = new schema.Entity('books', {
      // 作者
      author: user,
      // 一本书对应多个评论,所以这里应用数组
      comments: [comment]
    });

    其中 id,title 是 book 自身的属性,无需关注,把须要解析的数据结构写进去。books 字符串与解析无关,对应 entities 对象的 key。

  • 再看 user

    const user = new schema.Entity('users');

    user 没有须要解析的信息,间接定义实体即可。

  • 最初是评论信息

    const comment = new schema.Entity('comments', {
      // 评价者是用户
      commenter: user
    });
    
    {
      id: "1",
      content: "作者写的太好了",
      commenter: {
        id: "1",
        name: "chc"
      }
    }

    把 comments 从本来的数据结构中拿进去,理论也就很清晰了。

高阶用法

解决数组

normalizr 能够解析单个对象,那么如果以后业务传递数组呢?相似于 comment 间接这样应用即可:

[
  {
    id: '1',
    title: "JavaScript 从入门到放弃"
    // ...
  },
  {
    id: '2',
    // ...
  }
]

const normalizedData = normalize(originalData, [book]);

反向解析

咱们只须要拿到方才的 normalizedData 中的 result 以及 entities 就能够获取之前的信息了。

import {denormalize, schema} from 'normalizr';

//...

denormalize(normalizedData.result, book, normalizedData.entities);

Entity 配置

开发中能够依据配置信息从新解析实体数据。

const book = new schema.Entity('books', {
  // 作者
  author: user,
  // 一本书对应多个评论,所以这里应用数组
  comments: [comment]
},{
  // 默认主键为 id,否则应用 idAttribute 中的数据,如 cid,key 等
  idAttribute: 'id',
  // 预处理策略, 参数别离为 实体的输出值,父对象
  processStrategy: (value, parent, key) => value,
  // 遇到两个 id 雷同数据的合并策略,默认如下所示,咱们还能够持续批改
  mergeStrategy: (prev, prev) => ({
    ...prev,
    ...next,
    // 是否合并过,如果遇到雷同的,就会增加该属性
    isMerge: true
  }),
});

// 看一下比较复杂的例子,以 user 为例子
const user = new schema.Entity('users', {}, {processStrategy: (value, parent, key) => {
    // 减少父对象的属性
    // 例如 commenter: "1" => commenterId: "1" 或者 author: "2" => "authorId": "2"
    // 然而目前还无奈通过 delete 删除 commenter 或者 author 属性
    parent[`${key}Id`] = value.id

    // 如果是从评论中获取的用户信息就减少 commentIds 属性
    if (key === 'commenter') { 
      return {
        ...value, 
        commentIds: [parent.id] 
      } 
    }
    // 不要遗记返回 value, 否则不会生成 user 数据
    return {
      ...value,
      bookIds: [parent.id]
    };
  }
  mergeStrategy: (prev, prev) => ({
    ...prev,
    ...next,
    // 该用户所有的评论归并到一起去
    commentIds: [...prev.commentIds, ...next.commentIds],
    // 该用户所有的书本归并到一起去
    bookIds: [...prev.bookIds, ...next.bookIds],
    isMerge: true
  }),
})

// 最终获取的用户信息为
{
  "1": {
    "id": "1",
    "name": "chc"
    // 用户 chc 写了评论和书籍,然而没有进行过合并
    "commentIds": ["1"],
    "bookIds": ["1"],
  },
  "2": {
    "id": "2",
    "name": "dcd",
    // 用户 dcd 写了 2 个评论,同时进行了合并解决
    "commentIds": [
      "2",
      "3"
    ],
    "isMerge": true
  }
}

当然了,该库也能够进行更加简单的数据格式化,大家能够通过 api 文档 来进一步学习和应用。

其余

当然了,normalizr 应用场景毕竟无限,开源负责人也早已换人。目前主库曾经无人保护了(issue 也也曾经敞开)。当然了,normalizr 代码自身也是足够稳固。

笔者也在思考一些新的场景应用并尝试为 normalizr 增加一些新的性能 (如 id 转换) 和优化(ts 重构),如果您在应用 normalizr 的过程中遇到什么问题,也能够分割我,存储库目前在 normalizr-helper 中。

激励一下

如果你感觉这篇文章不错,心愿能够给与我一些激励,在我的 github 博客下帮忙 star 一下。

博客地址

退出移动版