在前端开发过程中,经常会遇到需要对数据进行转换的场景。比如,将一个对象的属性映射到另一个对象中,或者从一个数据结构中选取部分数据等等。为了加速开发过程,前端社区中有许多优秀的工具库,其中一个值得推荐的是 simple-object-mapper
。
一、什么是 Simple-Object-Mapper
Simple-Object-Mapper 是一款简洁、易用的 JavaScript 库,它能够帮助开发者快速地实现对象属性的映射、数据筛选等功能。该库的核心思想是通过定义映射规则(mapping rules)或筛选规则(filtering rules)来完成数据的操作。
二、如何安装和使用
安装 Simple-Object-Mapper 是非常简单的,只需要使用 npm 命令即可:
npm install simple-object-mapper
在引用库之后,我们可以使用它提供的 Mapper
或 Filter
对象,它们分别对应了映射和筛选功能。
下面我们分别介绍一下它们的使用方法:
1. 映射
Step 1. 定义映射规则
在执行映射之前,我们需要先定义映射规则。映射规则需要指定一个源对象和一个目标对象,以及它们之间的映射关系。
-- -------------------- ---- ------- ------ - ------ - ---- ----------------------- ----- ------------ - - ----- ----------- ---- ------------ ------- ------ -- ------ --- ------ - --- - ---- ------ - --------- ------------ ------------------ ----- -- --------------- - -
上面的映射规则可以解读为:
- 将源对象的
name
属性映射到目标对象的fullName
属性上 - 将源对象的
age
属性映射到目标对象的birthYear
属性上 - 将源对象的
gender
属性以'male'
映射到'm'
,以'female'
映射到'f'
- 将源对象的
score
属性映射到目标对象的testScore
属性上,并将其转换为整数类型
映射规则定义完成后,我们就可以使用 Mapper
对象执行映射。
Step 2. 执行映射
执行映射的代码非常简单,只需要调用 Mapper.map()
方法,传入源对象和映射规则即可:
-- -------------------- ---- ------- ----- ------ - --- --------------------- ----- ------------ - - ----- ----- ---- --- ------- ------- ------ ---- -- ----- ----------------- - ------------------------- -------------------------------
输出结果如下:
{ fullName: '张三', birthYear: 25, m: true, testScore: 90 }
可以看到,映射完成后得到的目标对象与我们定义的规则相对应,非常方便。
2. 筛选
Step 1. 定义筛选规则
在使用筛选功能时,我们需要定义一个筛选规则,指定我们需要选择的数据。筛选规则可以是一个函数,也可以是一个属性名(可以是多层嵌套的属性)。
例如:
import { Filter } from 'simple-object-mapper'; const filteringRule = { 'name': true, 'personalInfo.gender': true, 'personalInfo.age': age => age >= 25 };
上面的筛选规则指定了只选择 name
、personalInfo.gender
、和年龄大于等于 25 的 personalInfo.age
。
Step 2. 执行筛选
筛选操作则是通过 Filter.pick()
方法实现的,我们可以将需要筛选的数据和筛选规则传入。
-- -------------------- ---- ------- ----- ------ - --- --------- ----- ---------- - - ----- ----- ------------- - ------- ------- ---- --- --------- ----- -- ------- - -------- --- ----- --- -------- -- - -- ----- ------ - ----------------------- --------------- --------------------
输出结果如下:
{ name: '张三', personalInfo: { gender: 'male', age: 25 } }
结果与我们预期的一致。如果我们需要通过 Filter.omit()
方法剔除指定的数据,我们可以使用如下规则:
-- -------------------- ---- ------- ------ - ------ - ---- ----------------------- ----- ------------- - - ------------------------ ----- ----------------- ---- -- ----- ------ - --- --------- ----- ---------- - - ----- ----- ------------- - ------- ------- ---- --- --------- ----- -- ------- - -------- --- ----- --- -------- -- - -- ----- ------ - ----------------------- --------------- --------------------
输出结果如下:
-- -------------------- ---- ------- - ----- ----- ------------- - ------- ------- ---- -- -- ------- - -------- --- ----- -- - -
三、总结
Simple-Object-Mapper 是一款轻量、易用的对象映射和数据筛选库。它拥有清晰、简明的 API,快速便捷地实现了复杂对象间的数据转换和数据选择。值得注意的是,该库虽然功能简洁,但是它的映射规则及筛选规则提供的转换和选择方式非常灵活。我们可以使用函数及属性名来完成多种复杂的数据操作。
import { Mapper, Filter } from 'simple-object-mapper'; const mapper = new Mapper(mappingRules); const filter = new Filter(); const result = filter.pick(sourceData, filteringRule);
以上是 Simple-Object-Mapper 的常见用法,如果你还没有尝试过,不妨试试,相信它能为你的项目带来更好的效果。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065b44c6eb7e50355dbe7a