「源码解读」TJ 大神的 only 库

简介: 前端西瓜哥

大家好,我是前端西瓜哥。我最近尝试开启一个源码解读系列,不定期解读一些简单或复杂的源码。

今天要解读 npm 第三方库的源码:only,仓库地址为:https://github.com/tj/node-only

这个库是 tj 大神写的工具方法。tj 大神是一名程序员大佬,主要在 nodejs 领域做出了不少开源贡献,是 Express、Koa、node-canvas 等一系列知名开源项目的创建者和贡献者。

only 方法能干啥?

only 的功能很简单:返回一个对象的白名单属性。说具体点,就是提取指定对象的一些属性放到新对象里,并返回这个新对象。

const only = require('only');
var obj = {
  name: 'tobi',
  last: 'holowaychuk',
  email: 'tobi@learnboost.com',
  _id: '12345'
};
only(obj, 'name last email');
/* 
  {
    name: 'tobi',
    last: 'holowaychuk',
    email: 'tobi@learnboost.com'
  }
 */

only 方法要求传入一个对象,以及一个白名单列表,这个列表可以是属性名数组,也可以是通过空格间隔属性名表示的字符串。

第二个参数支持字符串格式,是因为使用更方便,能少写很多引号。使用上的优雅,是我们设计 API 时的一个重要考量点。

only 库的实现

module.exports = function(obj, keys){
  obj = obj || {};
  if ('string' == typeof keys) keys = keys.split(/ +/);
  return keys.reduce(function(ret, key){
    if (null == obj[key]) return ret;
    ret[key] = obj[key];
    return ret;
  }, {});
};

代码解读

首先是对第一个参数 obj 做简单容错。如果 obj 是一个值为 undefined 或 null 之类的假值,我们就将其设置为一个空对象,防止抛出错误。

然后就是将可能是字符串形式的白名单转换为数组的格式。

使用的方法为:keys.split(/ +/),这里用到了 split 的正则表达式参数写法,/ +/ 这个正则表达式代表一个数量大于等于 1 的多个空格符。这其实是很常见的分割字符串拿到数组的写法。

最后用老鸟非常喜欢用的 Array.prototype.reduce() 的写法,来对 keys 数组进行迭代。

对于每个 key,只要原数组中不为 null 或 undefined,就将其浅拷贝到新对象中。

reduce() 方法的返回值就是我们要的新对象,直接将其返回。

我们再说说为什么一些资深前端喜欢用 reduce() 方法。其实是因为 reduce 这个方法相比 forEachmap 这些方法要更灵活,它能返回任何类型的值而写法不失简洁。forEach 没有返回值,而 map 只能返回数组类型且大小相同的数组,虽然符合单一职责原则,但也因此失去了灵活性。

我曾经写过一篇关于 reduce 的文章,你感兴趣的话可以看看:为什么说数组实例的reduce方法灵活?

only 方法解读完毕。

相关文章
|
6月前
|
Dart
带你读《深入浅出Dart》十二、Dart库的使用和创建(1)
带你读《深入浅出Dart》十二、Dart库的使用和创建(1)
|
2天前
|
机器学习/深度学习 存储 C语言
NumPy源码解析:实现原理探究
【4月更文挑战第17天】本文深入解析NumPy源码,探讨其高效性能背后的实现原理。核心是多维数组`ndarray`,基于同质数据、连续内存分配和形状步幅概念。NumPy利用C语言实现数组管理,通过广播机制允许不同形状数组运算,并借助底层线性代数库实现向量化操作。理解这些机制有助于优化科学计算并应用于其他项目。
|
5月前
|
数据采集 搜索推荐 中间件
【 ⑬】Scrapy库概述(简介、安装与基本使用)
【 ⑬】Scrapy库概述(简介、安装与基本使用)
72 0
|
6月前
|
存储 Dart
带你读《深入浅出Dart》十二、Dart库的使用和创建(2)
带你读《深入浅出Dart》十二、Dart库的使用和创建(2)
|
11月前
|
XML Java 程序员
【框架源码】SpringBoot核心源码解读之自动配置源码分析
【框架源码】SpringBoot核心源码解读之自动配置源码分析
【框架源码】SpringBoot核心源码解读之自动配置源码分析
|
存储 分布式计算 监控
【源码解读】|SparkEnv源码解读
【源码解读】|SparkEnv源码解读
104 0
|
缓存 分布式计算 监控
【源码解读】| LiveListenerBus源码解读(上)
【源码解读】| LiveListenerBus源码解读
133 0
【源码解读】| LiveListenerBus源码解读(上)
|
存储 SQL 分布式计算
【源码解读】| LiveListenerBus源码解读(下)
【源码解读】| LiveListenerBus源码解读
129 0
【源码解读】| LiveListenerBus源码解读(下)
|
JavaScript 开发者
框架和库的区别|学习笔记
快速学习框架和库的区别
62 0
|
SQL 算法 中间件
sqlalchemy源码阅读-下篇
SQLAlchemy是Python SQL工具箱和ORM框架,它为应用程序开发人员提供了全面而灵活的SQL功能。它提供了一整套企业级持久化方案,旨在高效,高性能地访问数据库,并符合Pythonic之禅。项目代码量比较大,接近200个文件,7万行代码, 我们一起来挑战一下。
386 1
sqlalchemy源码阅读-下篇

相关实验场景

更多