Une analyse approfondie de la fonction util.promisify() dans Node

Le package util intégré de Node.js possède une fonction promisify() qui peut convertir les fonctions basées sur le rappel en fonctions basées sur la promesse. Cet article vous présentera la fonction util.promisify() dans Node.js. J'espère qu'il vous sera utile.

vous permet d'utiliser Promise chaînage et async/await avec des API basées sur le rappel.

Par exemple, le package fs de Node.js utilise des rappels. Habituellement, la lecture de fichiers nécessite l'utilisation de rappels :

const fs = require('fs');
fs.readFile('./package.json', function callback(err, buf) {
    const obj = JSON.parse(buf.toString('utf8'));
    obj.name; // 'masteringjs.io'
});

Vous pouvez utiliser util.promisify() pour convertir la fonction fs.readFile() en une fonction qui renvoie un Promesse. [Tutoriels associés recommandés : tutoriel vidéo nodejsutil.promisify() 将 fs.readFile() 函数转换为返回 Promise 的函数。【相关教程推荐：nodejs视频教程、编程教学】

const fs = require('fs');
const util = require('util');

// 将 `fs.readFile()` 转换为一个函数，该函数接受相同的参数但返回一个 Promise
const readFile = util.promisify(fs.readFile);

// 现在可以对 `readFile()` 使用 `await` 了！
const buf = await readFile('./package.json');

const obj = JSON.parse(buf.toString('utf8'));
obj.name; // 'masteringjs.io'

简单实现

util.promisify() 在内部是如何工作的？npm 上有一个 polyfill，你可以 在这里阅读完整的实现。你也可以 在这里找到 Node.js 的实现，不过出于教育目的，polyfill 更容易阅读。

util.promisify() 的核心思想是 在你传递的参数基础上添加了一个回调函数。这个回调函数解析（resolve）或拒绝（rejected） promisified 函数返回的 Promise。

有点啰嗦了，以下是 util.promisify() 方法一个简化的实现版本。

const fs = require('fs');

// `util.promisify()` 的简化实现。不涵盖所有情况，不要在生产环境中使用！
function promisify(fn) {
    return function () {
        const args = Array.prototype.slice.call(arguments);
        return new Promise((resolve, reject) => {
            fn.apply(this, [].concat(args).concat([(err, res) => {
                if (err) {
                    return reject(err);
                }
                resolve(res);
            }]));
        });
    }
}

// 将 `fs.readFile()` 转换为一个函数，该函数接受相同的参数但返回一个 Promise
const readFile = util.promisify(fs.readFile);

// 现在可以对 `readFile()` 使用 `await` 了！
const buf = await readFile('./package.json');

const obj = JSON.parse(buf.toString('utf8'));
obj.name; // 'masteringjs.io'

怎么理解？首先，util.promisify() 会向你传递的参数添加 1 个额外参数，然后使用这些新参数调用原始函数。那么底层函数就要支持这些数量的参数调用，举例：如果你正在使用类型为 [String，Object] 的 2 个参数调用 promisified 函数 myFn()，请确保原始函数支持调用签名 [String, Object, Function]。

其次，util.promisify() 对于 函数上下文 有影响。

丢失上下文

丢失上下文（Losing Context） 表示调用函数时内部 this 值不正确 。丢失上下文是转换后的函数的常见问题：

class MyClass {
  myCallbackFn(cb) {
    cb(null, this);
  }
}

const obj = new MyClass();
const promisified = require('util').promisify(obj.myCallbackFn);

const context = await promisified();
context; // 打印 `undefined` 而非 `MyClass` 实例!

this, Enseignement de la programmation]

class MyClass {
  myCallbackFn(cb) {
    cb(null, this);
  }
}

const obj = new MyClass();
// 保留上下文，因为 `promisified` 是 `obj` 的一个属性
obj.promisified = require('util').promisify(obj.myCallbackFn);

const context = await obj.promisified();
context === obj; // true

Implémentation simple

util. Comment prometify() fonctionne-t-il en interne ? Il y a un polyfill sur npm, vous pouvez Lisez l'implémentation complète ici . Vous pouvez également Trouvez l'implémentation de Node.js ici

, mais à des fins éducatives, le polyfill est plus facile à lire. 🎜🎜util.promisify() L'idée de base est Ajoute une fonction de rappel 🎜 basée sur les paramètres que vous transmettez. Cette fonction de rappel résout ou rejette la promesse renvoyée par la fonction promise. 🎜🎜C'est un peu verbeux, ce qui suit est une version d'implémentation simplifiée de la méthode util.promisify(). 🎜rrreee🎜Comment tu comprends ? Tout d'abord, util.promisify() ajoute 1 paramètre supplémentaire aux paramètres que vous transmettez, puis appelle la fonction d'origine avec ces nouveaux paramètres. Ensuite, la fonction sous-jacente doit prendre en charge ce nombre d'appels de paramètres. Par exemple : si vous appelez la fonction promise myFn() avec 2 paramètres de type [String, Object], Veuillez vous assurer que la fonction d'origine prend en charge la signature d'appel [String, Object, Function]. 🎜🎜Deuxièmement, util.promisify() pour Le contexte de la fonction 🎜 a un impact. 🎜

Contexte perdu

🎜Losing Context (Losing Context) 🎜 Indique que la valeur interne this est incorrecte lors de l'appel de la fonction. La perte de contexte est un problème courant avec les fonctions transformées : 🎜rrreee🎜this représente l'objet 🎜 sur lequel la fonction a été appelée. Par conséquent, vous pouvez préserver le contexte en définissant la fonction promise sur une propriété du même objet : 🎜rrreee🎜Pour plus de connaissances sur les nœuds, veuillez visiter : 🎜tutoriel Nodejs🎜 ! 🎜

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!