Eine eingehende Analyse der Funktion util.promisify() in Node

Das integrierte Util-Paket von Node.js verfügt über eine promisify()-Funktion, die Callback-basierte Funktionen in Promise-basierte Funktionen konvertieren kann. Dieser Artikel stellt Ihnen die Funktion util.promisify() in Node.js vor. Ich hoffe, dass er Ihnen hilfreich sein wird.

ermöglicht Ihnen die Verwendung von Versprechensverkettung und async/await mit Rückrufbasis API.

Zum Beispiel verwendet das fs-Paket von Node.js Rückrufe. Normalerweise erfordert das Lesen von Dateien die Verwendung von Rückrufen:

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

Sie können util.promisify() verwenden, um die Funktion fs.readFile() zu konvertieren in eine Funktion, die ein Versprechen zurückgibt. [Empfohlene verwandte Tutorials: nodejs-Video-Tutorialutil.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, Programmierunterricht】

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

Einfache Implementierung

util.promisify() intern? Es gibt eine Polyfill auf npm, Sie können Lesen Sie hier die vollständige Implementierung . Sie können auch Die Node.js-Implementierung finden Sie hier

, aber für Bildungszwecke ist die Polyfüllung einfacher zu lesen. #🎜🎜##🎜🎜#Die Kernidee von util.promisify() ist Fügt eine Rückruffunktion basierend auf den von Ihnen übergebenen Parametern hinzu #🎜 🎜 #. Diese Rückruffunktion löst das von der versprochenen Funktion zurückgegebene Promise auf oder lehnt es ab. #🎜🎜##🎜🎜#Es ist etwas ausführlich, das Folgende ist eine vereinfachte Implementierungsversion der Methode util.promisify(). #🎜🎜#rrreee#🎜🎜#Wie ist das zu verstehen? Zuerst fügt util.promisify() einen zusätzlichen Parameter zu den von Ihnen übergebenen Parametern hinzu und ruft dann die ursprüngliche Funktion mit diesen neuen Parametern auf. Dann muss die zugrunde liegende Funktion diese Anzahl von Parameteraufrufen unterstützen. Beispiel: Wenn Sie die versprochene Funktion myFn() mit 2 Parametern vom Typ [String, Object] aufrufen, Bitte stellen Sie sicher, dass die Originalfunktion die Aufrufsignatur [String, Object, Function] unterstützt. #🎜🎜##🎜🎜#Zweitens util.promisify() für Funktionskontext #🎜🎜# hat Auswirkungen. #🎜🎜#

Kontext verloren

#🎜🎜#Kontext verlieren (Kontext verlieren) #🎜🎜# Zeigt an, dass der interne dies-Wert beim Aufruf verwendet wird Die Funktion ist nicht korrekt. Der Verlust des Kontexts ist ein häufiges Problem bei transformierten Funktionen: #🎜🎜#rrreee#🎜🎜#this stellt das Objekt #🎜🎜# dar, zu dem es gehört, wenn die Funktion aufgerufen wird. Daher können Sie den Kontext bewahren, indem Sie die versprochene Funktion auf eine Eigenschaft desselben Objekts festlegen: #🎜🎜#

Das obige ist der detaillierte Inhalt vonEine eingehende Analyse der Funktion util.promisify() in Node. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!