[Node.js] async_hooks模塊

1. 異步資源

node 8.2中的async_hooks模塊浓恶,提供了一組API用來跟蹤應(yīng)用中的異步資源(asynchronous resources)院崇。

與異步資源相關(guān)的回調(diào)函數(shù)(callback)嘁信,
可能會(huì)被調(diào)用多次尤蛮,例如net.createServerconnection事件呐馆,
也可能會(huì)被調(diào)用一次狞尔,例如fs.open丛版。

異步資源也可能在調(diào)用回調(diào)函數(shù)之前就已經(jīng)被關(guān)閉了。

2. async_hooks用法

const asyncHook = require('async_hooks');

const hook = asyncHooks.createHook({
    init(asyncId, type, triggerAsyncId, resource) {
    },
    before(asyncId) {
    },
    after(asyncId) {
    },
    destroy(asyncId) {
    }
});

hook.enable();

以上代碼創(chuàng)建一個(gè)hook偏序,它可以用來跟蹤應(yīng)用中所有的異步資源页畦,
當(dāng)資源在被初始化,回調(diào)之前研儒,回調(diào)之后豫缨,銷毀后,將自動(dòng)觸發(fā)init端朵,before好芭,afterdestroy冲呢。

我們可以使用hook.enable();啟用跟蹤舍败,還可以使用hook.disable();來關(guān)閉。
其中asyncId敬拓,triggerAsyncId的介紹見下文邻薯。

3. 當(dāng)心console.log會(huì)造成無限循環(huán)

我們通常使用的console.log,向控制臺(tái)打印消息乘凸,
然而厕诡,它卻是一個(gè)異步操作(asynchronous operation),
所以翰意,async_hooks也可以用來跟蹤它木人。
(參考:Printing in AsyncHooks callbacks

因此信柿,如果在上述init冀偶,beforeafter渔嚷,destroy事件處理函數(shù)中出現(xiàn)了console.log进鸠,就會(huì)導(dǎo)致無限循環(huán)。

我們可以使用fs.writeSync(1, msg)來代替console.log形病,
其中writeSync函數(shù)的第一個(gè)參數(shù)為文件描述符(file descriptor)客年,
1表示標(biāo)準(zhǔn)輸出(standard output)霞幅。

4. 完整的例子

const fs = require('fs');
const asyncHooks = require('async_hooks');

const hook = asyncHooks.createHook({
    init(asyncId, type, triggerAsyncId, resource) {
        fs.writeSync(1, `init: asyncId-${asyncId},type-${type},triggerAsyncId-${triggerAsyncId}\n`);
    },
    before(asyncId) {
        fs.writeSync(1, `before: asyncId-${asyncId}\n`);
    },
    after(asyncId) {
        fs.writeSync(1, `after: asyncId-${asyncId}\n`);
    },
    destroy(asyncId) {
        fs.writeSync(1, `destroy: asyncId-${asyncId}\n`);
    }
});

hook.enable();
console.log('hello');

// hook.disable();    // 注意,這里不要disable量瓜,否則只能觸發(fā)init事件

執(zhí)行后司恳,輸出:

init: asyncId-2, type-TTYWRAP, triggerAsyncId-1
init: asyncId-3, type-SIGNALWRAP, triggerAsyncId-1
init: asyncId-4, type-TTYWRAP, triggerAsyncId-1
hello
init: asyncId-5, type-TickObject, triggerAsyncId-1
before: asyncId-5
after: asyncId-5
destroy: asyncId-5

5. 自定義AsyncResource

async_hooks模塊除了可以跟蹤node中內(nèi)置的異步資源,還可以跟蹤自定義的資源绍傲,
要做到這一點(diǎn)扔傅,我們需要繼承AsyncResource類,然后手動(dòng)觸發(fā)事件烫饼。

其中猎塞,AsyncResource類,是async_hooks模塊導(dǎo)出對(duì)象的一個(gè)屬性asyncHooks.AsyncResource杠纵。

const fs = require('fs');
const asyncHooks = require('async_hooks');

class MyResource extends asyncHooks.AsyncResource {
    constructor() {
        super('my-resource');
    }

    asyncMethod(callback) {
        this.emitBefore();
        callback();
        this.emitAfter();
    }

    close() {
        this.emitDestroy();
    }
}

const hook = asyncHooks.createHook({
    init(asyncId, type, triggerAsyncId, resource) {
        fs.writeSync(1, `init: asyncId-${asyncId}, type-${type}, triggerAsyncId-${triggerAsyncId}\n`);
    },
    before(asyncId) {
        fs.writeSync(1, `before: asyncId-${asyncId}\n`);
    },
    after(asyncId) {
        fs.writeSync(1, `after: asyncId-${asyncId}\n`);
    },
    destroy(asyncId) {
        fs.writeSync(1, `destroy: asyncId-${asyncId}\n`);
    }
});

hook.enable();

let resource = new MyResource;
resource.asyncMethod(() => { });
resource.close();

// hook.disable();    // 注意荠耽,這里不要disable,否則將不會(huì)觸發(fā)destroy事件

注:
emitDestroy不是同步調(diào)用的比藻,
所以emitDestroy之后铝量,馬上將hook.disable();destroy事件就不觸發(fā)了银亲。

6. async scope和async id

為了對(duì)異步資源實(shí)現(xiàn)跟蹤款违,
node對(duì)每一個(gè)函數(shù)(不論異步還是同步)提供了一個(gè) async scope,
我們可以通過調(diào)用asyncHooks.executionAsyncId();來獲取當(dāng)前函數(shù)的asyncId群凶,
通過調(diào)用asyncHooks.triggerAsyncId();來獲取當(dāng)前函數(shù)調(diào)用者的asyncId插爹。

const asyncHooks = require('async_hooks');

console.log(`top level: ${asyncHooks.executionAsyncId()}`);

const f = () => {
    console.log(`f: ${asyncHooks.executionAsyncId()}`);
};

f();

const g = () => {
    console.log(`setTimeout: ${asyncHooks.executionAsyncId()}`);
}

setTimeout(g, 0);
setTimeout(g, 0);

最終輸出結(jié)果:

top level: 1
f: 1
setTimeout: 6
setTimeout: 8

注:
(1)top-level的asyncId總是1
(2)調(diào)用同步函數(shù)请梢,不會(huì)改變其調(diào)用者的asyncId赠尾,例如,函數(shù)f內(nèi)的asyncId和其調(diào)用者(即top-level)的asyncId相同毅弧。
(3)同一個(gè)函數(shù)气嫁,被不同時(shí)刻進(jìn)行異步調(diào)用,會(huì)分配不同的asyncId够坐,例如寸宵,函數(shù)g中的asyncId


參考

Node.js v8.2.0 Documentation: Async Hooks
Node.js v8.x 新特性 Async Hook 簡(jiǎn)介
What does fs.writeSync(1, “a string”) mean in Node.js?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末元咙,一起剝皮案震驚了整個(gè)濱河市梯影,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌庶香,老刑警劉巖甲棍,帶你破解...
    沈念sama閱讀 216,651評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異赶掖,居然都是意外死亡感猛,警方通過查閱死者的電腦和手機(jī)七扰,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,468評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來陪白,“玉大人颈走,你說我怎么就攤上這事≡凼浚” “怎么了疫鹊?”我有些...
    開封第一講書人閱讀 162,931評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長司致。 經(jīng)常有香客問我拆吆,道長里伯,這世上最難降的妖魔是什么鹊汛? 我笑而不...
    開封第一講書人閱讀 58,218評(píng)論 1 292
  • 正文 為了忘掉前任疲憋,我火速辦了婚禮忌堂,結(jié)果婚禮上启妹,老公的妹妹穿的比我還像新娘膳汪。我一直安慰自己容燕,他們只是感情好桥狡,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,234評(píng)論 6 388
  • 文/花漫 我一把揭開白布拄轻。 她就那樣靜靜地躺著颅围,像睡著了一般。 火紅的嫁衣襯著肌膚如雪恨搓。 梳的紋絲不亂的頭發(fā)上院促,一...
    開封第一講書人閱讀 51,198評(píng)論 1 299
  • 那天,我揣著相機(jī)與錄音斧抱,去河邊找鬼常拓。 笑死,一個(gè)胖子當(dāng)著我的面吹牛辉浦,可吹牛的內(nèi)容都是我干的弄抬。 我是一名探鬼主播,決...
    沈念sama閱讀 40,084評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼宪郊,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼掂恕!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起弛槐,我...
    開封第一講書人閱讀 38,926評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤懊亡,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后丐黄,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體斋配,經(jīng)...
    沈念sama閱讀 45,341評(píng)論 1 311
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡孔飒,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,563評(píng)論 2 333
  • 正文 我和宋清朗相戀三年灌闺,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了艰争。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,731評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡桂对,死狀恐怖甩卓,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情蕉斜,我是刑警寧澤逾柿,帶...
    沈念sama閱讀 35,430評(píng)論 5 343
  • 正文 年R本政府宣布,位于F島的核電站宅此,受9級(jí)特大地震影響机错,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜父腕,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,036評(píng)論 3 326
  • 文/蒙蒙 一弱匪、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧璧亮,春花似錦萧诫、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,676評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至群扶,卻和暖如春及刻,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背竞阐。 一陣腳步聲響...
    開封第一講書人閱讀 32,829評(píng)論 1 269
  • 我被黑心中介騙來泰國打工提茁, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人馁菜。 一個(gè)月前我還...
    沈念sama閱讀 47,743評(píng)論 2 368
  • 正文 我出身青樓茴扁,卻偏偏與公主長得像,于是被迫代替她去往敵國和親汪疮。 傳聞我的和親對(duì)象是個(gè)殘疾皇子峭火,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,629評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • topics: 1.The Node.js philosophy 2.The reactor pattern 3....
    宮若石閱讀 1,078評(píng)論 0 1
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)智嚷,斷路器卖丸,智...
    卡卡羅2017閱讀 134,652評(píng)論 18 139
  • 異步編程對(duì)JavaScript語言太重要。Javascript語言的執(zhí)行環(huán)境是“單線程”的盏道,如果沒有異步編程稍浆,根本...
    呼呼哥閱讀 7,311評(píng)論 5 22
  • # 模塊機(jī)制 node采用模塊化結(jié)構(gòu),按照CommonJS規(guī)范定義和使用模塊,模塊與文件是一一對(duì)應(yīng)關(guān)系衅枫,即加載一個(gè)...
    RichRand閱讀 2,502評(píng)論 0 3
  • “連狗都不如”嫁艇,是對(duì)藏獒處境的最好概括。流浪藏獒對(duì)青海造成的破壞是全方位的弦撩。 流浪藏獒不僅會(huì)捕食珍稀野生動(dòng)物步咪,還有...
    羅掌柜real閱讀 354評(píng)論 0 0