[vite源碼解析]插件篇

vite的插件基于rollup属提,在本地服務(wù)生成是會(huì)同事創(chuàng)建插件容器目代,按順序針對(duì)插件中的hook做批量調(diào)用塔橡,當(dāng)前支持的hook有(區(qū)分構(gòu)建和開(kāi)發(fā)):

  • 通用hook
    |hook名稱(chēng)|觸發(fā)時(shí)機(jī)|
    |---|---|
    |options|服務(wù)器啟動(dòng)時(shí)被調(diào)用|
    |buildStart|服務(wù)器啟動(dòng)時(shí)被調(diào)用|
    |resolveId|每個(gè)傳入模塊請(qǐng)求時(shí)被調(diào)用|
    |load|每個(gè)傳入模塊請(qǐng)求時(shí)被調(diào)用|
    |transform|每個(gè)傳入模塊請(qǐng)求時(shí)被調(diào)用|
    |buildEnd|服務(wù)器關(guān)閉時(shí)被調(diào)用|
    |closeBundle|服務(wù)器關(guān)閉時(shí)被調(diào)用|

  • vite獨(dú)有hook

下一個(gè)問(wèn)題佳镜,vite是如何實(shí)現(xiàn)插件的設(shè)計(jì)的裆馒?答案我們從createPluginContainer里面找

// packages/vite/src/node/server/pluginContainer.ts

export async function createPluginContainer(
  { plugins, logger, root, build: { rollupOptions } }: ResolvedConfig,
  watcher?: FSWatcher
): Promise<PluginContainer>

createPluginContainer傳入2個(gè)參數(shù):

  • resolveConfig配置:包含了plugins姊氓,logger, root喷好, build(包含rollupOptions)翔横,這里實(shí)際對(duì)應(yīng)的就是創(chuàng)建server的config,只不過(guò)用resolveConfig函數(shù)解析了下梗搅。
  • watcher:文件監(jiān)控器禾唁,在創(chuàng)建server的時(shí)候調(diào)用的是chokidar實(shí)例來(lái)實(shí)現(xiàn)

返回的就是PluginContainer。
函數(shù)體其中也包含很多內(nèi)容

function warnIncompatibleMethod(method: string, plugin: string){}
// 針對(duì)每個(gè)異步pipeline都創(chuàng)建一個(gè)上下文來(lái)跟蹤多pipeline下追蹤到當(dāng)前激活的插件
class Context implements PluginContext {}

function formatError(){}

class TransformContext extends Context 

const container: PluginContainer 

return container

在這里我們看到上面的主要container就是pluginContainer无切,我們具體來(lái)看看里面包含哪些內(nèi)容:

const container: PluginContainer = {
  options: await (async ()=>{})(),
  async buildStart(){}
async resolveId(rawId, importer = join(root, 'index.html'), skips, ssr){}
async load(id, ssr){}
async transform(code, id, inMap, ssr){}
watchChange(id, event = 'update'){}
async close(){}
}

可以看到插件容器主要就是包含選項(xiàng)的初始化荡短,rollup 各個(gè)特定hook的調(diào)用(buildStart,resolveId,load,transform),變化監(jiān)控同步函數(shù)watchChange,以及最后的close方法哆键。下面我們來(lái)逐個(gè)拆解:

  • options異步函數(shù)解析:
  1. 將每個(gè)插件里的options方法執(zhí)行了一遍
    for (const plugin of plugins) {
        if (!plugin.options) continue
        options =
          (await plugin.options.call(minimalContext, options)) || options
      }
  1. 如果有配置acornInjectPlugins:那就合并進(jìn)acore的parser中:
if (options.acornInjectPlugins) {
        parser = acorn.Parser.extend(
          ...[
            acornClassFields,
            acornStaticClassFeatures,
            acornNumericSeparator
          ].concat(options.acornInjectPlugins)
        )
      }
  1. 返回包含acorn及options的對(duì)象
return {
        acorn,
        acornInjectPlugins: [],
        ...options
      }

  • buildStart: 使用promise.all把所有插件里面但凡有該配置的都執(zhí)行下
await Promise.all(
        plugins.map((plugin) => {
          if (plugin.buildStart) {
            return plugin.buildStart.call(
              new Context(plugin) as any,
              container.options as NormalizedInputOptions
            )
          }
        })
      )

  • resolveId:resolveId階段屬于rollup的通用hook掘托,流程也類(lèi)似,針對(duì)每個(gè)plugin執(zhí)行對(duì)應(yīng)鉤子:
for (const plugin of plugins) {
 // 沒(méi)有就跳過(guò)
        if (!plugin.resolveId) continue
// 如果在跳過(guò)的列表里面洼哎,也跳過(guò)
        if (skips?.has(plugin)) continue
// 將該插件設(shè)置為當(dāng)前激活插件
        ctx._activePlugin = plugin
// 開(kāi)始調(diào)用方法
        const result = await plugin.resolveId.call(
          ctx as any,
          rawId,
          importer,
          {},
          ssr
        )
// 如果沒(méi)結(jié)果就跳過(guò)到下一個(gè)
        if (!result) continue
// 如果結(jié)果為string烫映,那結(jié)果就是對(duì)應(yīng)的id
        if (typeof result === 'string') {
           id = result
        } else {
// 如果不是那就是object對(duì)象沼本,找到對(duì)應(yīng)id屬性
          id = result.id
          Object.assign(partial, result)
        }

        // resolveId() is hookFirst - first non-null result is returned.
        break
      }
// 如果id有了噩峦,就返回partial锭沟,沒(méi)有返回null
if (id) {
        partial.id = isExternalUrl(id) ? id : normalizePath(id)
        return partial as PartialResolvedId
      } else {
        return null
      }

  • load階段:遍歷plugin執(zhí)行hook, 有結(jié)果就返回,沒(méi)有返回null
for (const plugin of plugins) {
        if (!plugin.load) continue
        ctx._activePlugin = plugin
        const result = await plugin.load.call(ctx as any, id, ssr)
        if (result != null) {
          return result
        }
      }
      return null

  • transform階段:遍歷plugin執(zhí)行hook, 有結(jié)果就返回识补,沒(méi)有返回null
for (const plugin of plugins) {
        if (!plugin.transform) continue
        ctx._activePlugin = plugin
        ctx._activeId = id
        ctx._activeCode = code
        let result
        try {
          result = await plugin.transform.call(ctx as any, code, id, ssr)
        } catch (e) {
          ctx.error(e)
        }
        if (!result) continue
     
        if (typeof result === 'object') {
          code = result.code || ''
          if (result.map) ctx.sourcemapChain.push(result.map)
        } else {
          code = result
        }
      }
// 返回code及對(duì)應(yīng)的sourcemap
      return {
        code,
        map: ctx._getCombinedSourcemap()
      }

  • watchChange:遍歷plugin執(zhí)行hook
for (const plugin of plugins) {
  if (!plugin.watchChange) continue
      ctx._activePlugin = plugin
      plugin.watchChange.call(ctx as any, id, { event })
 }

  • close: 按照先后順序執(zhí)行buildEnd 族淮,closeBundle hook, 配置close狀態(tài)位
if (closed) return
      const ctx = new Context()
      await Promise.all(
        plugins.map((p) => p.buildEnd && p.buildEnd.call(ctx as any))
      )
      await Promise.all(
        plugins.map((p) => p.closeBundle && p.closeBundle.call(ctx as any))
      )
      closed = true
 }

總結(jié)

插件容器針對(duì)插件提供了統(tǒng)一的管理和調(diào)用方案凭涂,在每個(gè)階段調(diào)用并傳遞對(duì)應(yīng)上下文祝辣。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市切油,隨后出現(xiàn)的幾起案子蝙斜,更是在濱河造成了極大的恐慌,老刑警劉巖澎胡,帶你破解...
    沈念sama閱讀 219,188評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件葫盼,死亡現(xiàn)場(chǎng)離奇詭異祟昭,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)败匹,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人艺配,你說(shuō)我怎么就攤上這事炭晒。” “怎么了受楼?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,562評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵垦搬,是天一觀(guān)的道長(zhǎng)。 經(jīng)常有香客問(wèn)我艳汽,道長(zhǎng)猴贰,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,893評(píng)論 1 295
  • 正文 為了忘掉前任骚灸,我火速辦了婚禮糟趾,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘甚牲。我一直安慰自己义郑,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布丈钙。 她就那樣靜靜地躺著非驮,像睡著了一般。 火紅的嫁衣襯著肌膚如雪雏赦。 梳的紋絲不亂的頭發(fā)上劫笙,一...
    開(kāi)封第一講書(shū)人閱讀 51,708評(píng)論 1 305
  • 那天芙扎,我揣著相機(jī)與錄音,去河邊找鬼填大。 笑死戒洼,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的允华。 我是一名探鬼主播圈浇,決...
    沈念sama閱讀 40,430評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼靴寂!你這毒婦竟也來(lái)了磷蜀?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,342評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤百炬,失蹤者是張志新(化名)和其女友劉穎褐隆,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體剖踊,經(jīng)...
    沈念sama閱讀 45,801評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡庶弃,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了蜜宪。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片虫埂。...
    茶點(diǎn)故事閱讀 40,115評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖圃验,靈堂內(nèi)的尸體忽然破棺而出掉伏,到底是詐尸還是另有隱情,我是刑警寧澤澳窑,帶...
    沈念sama閱讀 35,804評(píng)論 5 346
  • 正文 年R本政府宣布斧散,位于F島的核電站,受9級(jí)特大地震影響摊聋,放射性物質(zhì)發(fā)生泄漏鸡捐。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評(píng)論 3 331
  • 文/蒙蒙 一麻裁、第九天 我趴在偏房一處隱蔽的房頂上張望箍镜。 院中可真熱鬧,春花似錦煎源、人聲如沸色迂。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,008評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)歇僧。三九已至,卻和暖如春锋拖,著一層夾襖步出監(jiān)牢的瞬間诈悍,已是汗流浹背祸轮。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,135評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留侥钳,地道東北人适袜。 一個(gè)月前我還...
    沈念sama閱讀 48,365評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像慕趴,于是被迫代替她去往敵國(guó)和親痪蝇。 傳聞我的和親對(duì)象是個(gè)殘疾皇子鄙陡,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評(píng)論 2 355

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