Node.js 8 中的 `util.promisify`

HackerShell 發布于2019-08-21 11:43 / 3195人閱讀

摘要：我們就可以升級以前所有的異步回調函數了。大體上來說，這套方案通過使用回調實例包裹原先的回調函數，可以將原先復雜的嵌套展開鋪平，從而降低開發和維護的難度和成本。

Node.js 8 于上個月月底正式發布，帶來了很多新特性。其中比較值得注意的，便有 util.promisify() 這個方法。

如果你已經很熟悉 Promise，請繼續往下看。如果你還不熟悉 Promise，可以先跳過去看下下章：Promise 介紹。

util.promisify()

雖然 Promise 已經普及，但是 Node.js 里仍然有大量依賴回調的異步函數，如果我們把每個函數都封裝一遍，那真是齁麻煩齁麻煩的，比齁還麻煩。

所以 Node.js 8 就提供了 util.promisify() 這個方法，方便我們把原來的異步回調方法改成支持 Promise 的方法，接下來，想繼續 .then().then().then() 搞隊列，還是 await 就看實際需要了。

我們看下范例，讓讀取目錄文件狀態的 fs.stat 支持 Promise：

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

const stat = util.promisify(fs.stat);
stat(".")
  .then((stats) => {
    // Do something with `stats`
  })
  .catch((error) => {
    // Handle the error.
  });

怎么樣，很簡單吧？按照文檔的說法，只要符合 Node.js 的回調風格，所有函數都可以這樣轉換。也就是說，只要滿足下面兩個條件，無論是不是原生方法，都可以：

最后一個參數是回調函數

回調函數的參數為 (err, result)，前面是可能的錯誤，后面是正常的結果

結合 Await/Async 使用

同樣是上面的例子，如果想要結合 Await/Async，可以這樣使用：

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

const stat = util.promisify(fs.stat);
async function readStats(dir) {
  try {
    let stats = await stat(dir);
    // Do something with `stats`
  } catch (err) { // Handle the error.
    console.log(err);
  }
}
readStats(".");

自定義 Promise 化處理函數

那如果現有的使用回調的函數不符合這個風格，還能用 util.promisify() 么？答案也是肯定的。我們只要給函數增加一個屬性 util.promisify.custom，指定一個函數作為 Promise 化處理函數，即可。請看下面的代碼：

const util = require("util");

// 這就是要處理的使用回調的函數
function doSomething(foo, callback) { 
  // ...
}

// 給它增加一個方法，用來在 Promise 化時調用
doSomething[util.promisify.custom] = function(foo) { 
  // 自定義生成 Promise 的邏輯
  return getPromiseSomehow(); 
};

const promisified = util.promisify(doSomething);
console.log(promisified === doSomething[util.promisify.custom]);
// prints "true"

如此一來，任何時候我們對目標函數 doSomething 進行 Promise 化處理，都會得到之前定義的函數。運行它，就會按照我們設計的特定邏輯返回 Promise 實例。

我們就可以升級以前所有的異步回調函數了。

Promise 介紹

因為種種歷史原因，JS 當中有大量異步函數。這些異步函數，大多要依賴回調進行處理（這里我覺得把事件偵聽算作回調也是合理的），但是回調嵌套層次一多，就會形成所謂的“回調陷阱”，讓開發者苦不堪言。

為了解決這個問題，開發社區經過摸索，總結出來一套名為 Promise/A+ 的解決方案。大體上來說，這套方案通過使用 “Promise 回調實例”包裹原先的回調函數，可以將原先復雜的嵌套展開、鋪平，從而降低開發和維護的難度和成本。

new Promise( (resolve, reject) => { // 構建一個 Promise 實例
  someAsyncFunction( (err, result) => { // 調用原來的異步函數
    if (err) { // 發生錯誤，進入錯誤處理模式
      return reject(err);
    }
    resolve(result); // 一切正常，進入隊列的下一環節
  });
})
  .then( result => { // 下一環節
    return doSomething(result);
  })
  .then( result2 => { // 又下一環節
    return doSomething2(result2);
  })
  ... // 各種中間環節
  .catch( err => { // 錯誤處理
    console.log(err);
  });

ES2015（ES6）里包含了 Promise 標準，如今已經在大部分運行時里實裝，我們可以放心大膽的使用它。而且，由于 Promise 不需要新的語法元素，所以即使在不支持原生 Promise 的環境里也可以使用類庫，比如 Q 或者 Bluebird，甚至 jQuery。

在小程序里也有效喲！

ES2017 增加了 Await/Async 語法，但請注意，Await 后面必須跟 Promise 實例才能實現異步。所以，大家還是把 Promise 的概念學好吧！

function resolveAfter2Seconds(x) {
  return new Promise(resolve => {
    setTimeout(() => {
      resolve(x);
    }, 2000);
  });
}

async function f1() {
  var x = await resolveAfter2Seconds(10);
  console.log(x); // 10
}
f1();

例子來源于 MDN。

如果你想進一步學習使用 Promise，強烈推薦我的這次分享：Promise 的 N 種用法。可以幫助你一站式的學會使用 Promise。

PS2：剛才看到 Node.js 已經發布 8.1 了，真快呀……新版本的 Changelog 在這里，已修復為主。

擴展閱讀：

util.promisify() in Node.js v8

官方文檔

官方文檔自定義 Promise 化處理函數

同步發于我的博客

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://m.specialneedsforspecialkids.com/yun/87022.html

[譯] Node.js 8: util.promisify()

摘要：例如，的回調函數包含下面幾個參數轉換成之后，它的參數將會變成這樣一個對象通過內部符號處理非標準回調函數。 Nodejs 8 有一個新的工具函數 util.promisify()。他將一個接收回調函數參數的函數轉換成一個返回Promise的函數。 1、util.promisify()小例子如果你給以下命令傳入文件路徑，則會輸出文件內容 // echo.js const {promis...

Shimmer 2019-08-21 11:44 評論0 收藏0
util.promisify 的那些事兒

摘要：自定義的化有那么一些場景，是不能夠直接使用來進行轉換的，有大概這么兩種情況沒有遵循約定的回調函數返回多個參數的回調函數首先是第一個，如果沒有遵循我們的約定，很可能導致的誤判，得不到正確的反饋。 util.promisify是在node.js 8.x版本中新增的一個工具，用于將老式的Error first callback轉換為Promise對象，讓老項目改造變得更為輕松。在官方推...

shuibo 2019-08-23 12:24 評論0 收藏0
【Node】搭建一個靜態資源服務器

摘要：一個包括文件緩存傳輸壓縮模版引擎類型匹配等功能的靜態資源服務器，使用的內置模塊實現，可以通過鏈接訪問資源。二使用讀取資源文件我們的目的是搭建一個靜態資源服務器，當訪問一個到資源文件或目錄時，我們希望可以得到它。一個包括文件緩存、傳輸壓縮、ejs 模版引擎、MIME 類型匹配等功能的 Node 靜態資源服務器，使用 Node 的內置模塊實現，可以通過鏈接訪問資源。一、創建 HTTP Se...

Mr_houzi 2019-05-21 19:52 評論0 收藏0
現代JS中的流程控制：詳解Callbacks 、Promises 、Async/Await

摘要：控制臺將顯示回調地獄通常，回調只能由一個異步函數調用。更多資源使更友好規范使用異步函數簡化異步編碼旅程異步編程是一項在中無法避免的挑戰。 JavaScript經常聲稱是_異步_。那是什么意思？它如何影響發展？近年來這種方法有何變化？請思考以下代碼： result1 = doSomething1(); result2 = doSomething2(result1); 大多數語言都處理每...

shadowbook 2019-08-29 16:29 評論0 收藏0
現代JS中的流程控制：詳解Callbacks 、Promises 、Async/Await

摘要：控制臺將顯示回調地獄通常，回調只能由一個異步函數調用。更多資源使更友好規范使用異步函數簡化異步編碼旅程異步編程是一項在中無法避免的挑戰。 JavaScript經常聲稱是_異步_。那是什么意思？它如何影響發展？近年來這種方法有何變化？請思考以下代碼： result1 = doSomething1(); result2 = doSomething2(result1); 大多數語言都處理每...

oujie 2019-08-23 11:28 評論0 收藏0