Node中的的util.promisify()方法的介绍和基本实现

2023年 7月 17日 42.5k 0

异步编程解决方案

我们知道,在JS中实现异步编程主要是通过以下几种方案:

  • 回调函数:也是在ES6之前用的最多的方式,缺点是容易造成callback hell,可读性很差
  • 观察者模式:在NodeJS中的很多模块都继承了EventEmitter模块, NodeJS 所有的异步 I/O 操作在完成时都会发送一个事件到事件队列。所有这些产生事件的对象都是 events.EventEmitter 的实例。
  • Generator:ES6 新引入了 Generator 函数,可以通过 yield 关键字,把函数的执行流挂起,为改变执行流程提供了可能,从而为异步编程提供解决方案。
  • Promise方案:号称是异步编程的终极解决方案
  • async / await async是ES7引入的语法 ,也是属于Promise方案中的一种
  • 今天就聊一下在node中的一个util.promisify()这个API的基本使用和基本实现。

    promisify

    promisify这个方法是一个高阶函数,接受一个函数作为入参,可以将原本靠回调函数实现的异步编程转化为promis的方案。这也是node提供出来,可以将之前非promise的方法通过这个api转化成promise来处理

    基本使用

    以一个简单的读写文件的fs.readFilereadFileSync为例说明。我们知道fs.readFile是通过回调函数的方式来获取读到的文件内容。而fs.readFileSync是通过同步的方式读取到文件内容。我们就可以使用promisify这个函数,将fs.readFile转变成promise的方式

    // const.js 被读取的文件
    const str = 123
    
    // index.js
    const fs = require('fs')
    const path = require('path')
    const { promisify } = require('util')
    
    // 同步的方式读取const.js
    const data = fs.readFileSync(path.resolve(__dirname,  './const.js'))
    console.log('readFileSync:', data.toString());
    
    // 通过回调函数的方式获取const.js内容
    fs.readFile(path.resolve(__dirname, './const.js'), (error, data) => {
      if (error) console.log('error', error);
      console.log('readFile', data.toString());
    })
    
    // 将fs.readFile转为promise的方式获取文件内容
    const readFile = promisify(fs.readFile)
    readFile(path.resolve(__dirname, './const.js'))
      .then(data => {
        console.log('promisify: ', data.toString())
      })
    

    达到的效果也符合预期:
    在这里插入图片描述

    自己实现一个promisify

    我们在这里也自己实现一个promisify函数,达到上面的效果。即将一个接受回调函数通过回调完成异步编程的方式改为promise的方式

    我们分析分析,思路其实很简单, 原本的函数接受一系列的参数,最后一个参数是一个回调函数,一般在node中错误先行,最后一个参数即任务完成时的回调函数也接受两个参数一个是error一个是处理后得到最后结果的data。如果有error的话就reject没有就resolve返回promise结果即可,详细分析步骤如下:

  • 我们实现的xpromisify是一个高阶函数,即接受一个函数作为参数
  • 接受的这个函数也有可能接受参数,所以我们对这个函数进行升阶处理,才能让这个函数接受其他参数
  • 我们最后返回的一定是一个Promise实例
  • 我们可以将步骤2中这个函数接受的参数数组得到(比如上述例子中fs.readFile()函数接受的path.resolve(__dirname, './const.js')),再构造一个函数作为回调函数,作为完整的参数,使用apply的方式让在步骤一中接受的函数执行
  • 构造的回调函数中判断步函数完成是否有错误,如果有错误我们reject掉,如果没有错误的话就把这个dataresolve即可
  • 完整的代码实现如下所示:

    // x-promisify.js
    
    // xPromisify 是一个高阶函数,会将接受的fn函数转为promise
    const xPromisify = (fn) => {
      // 接受的fn函数也会接受其他参数,所以升阶处理,return 一个函数这样就可以接受其他参数了
      return wrapFn = (...args) => {
        // 最终返回的肯定是一个promise实例
        return new Promise((resolve, reject) => {
            // 接受参数中加一个回调函数reject/resolve 最后结果
            args.push((error, data) => {
              if (error) reject(error)
              resolve(data)
            })
          // 此时args参数中就包含的fn执行所需要的所有参数了
          fn.apply(null, args)
        })
      }
    }
    
    module.exports = {
      xPromisify
    }
    

    我们可以通过上述例子的fs.readFile这个函数来检查一下:

    const { xPromisify } = require('./x-promisify')
    
    const xReadFile = xPromisify(fs.readFile);
    xReadFile(path.resolve(__dirname, './const.js'))
      .then(data => {
        console.log('data', data.toString())
      })
    

    执行效果如下所示:
    在这里插入图片描述

    总结

    其实我们做的事情只是将回调函数的逻辑做了修改,原本是直接在回调中处理业务逻辑,这里我们修改为在回调函数中把异步事件处理的结果通过reject / resove给返回出去
    我们也可以看一下在NodeJS中对这一部分的实现:
    在这里插入图片描述

    参考资料

    util_promisify
    Node中实现promisify
    npm 上实现promiseify的polyfill

    相关文章

    JavaScript2024新功能:Object.groupBy、正则表达式v标志
    PHP trim 函数对多字节字符的使用和限制
    新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
    使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
    为React 19做准备:WordPress 6.6用户指南
    如何删除WordPress中的所有评论

    发布评论