Vue 自定義指令源碼解析(基于V2.6.8)

最近經(jīng)常使用指令來實(shí)現(xiàn)一些功能泡态,覺得甚是好用族展。然而卻遇到一個問題:v-if和我自定義指令在同一個標(biāo)簽里使用的時候,我自定義的指令傳的值通過bind.value沒獲取到值。后來換成v-show是我期待的結(jié)果吓坚,但是當(dāng)我把v-if換成v-else(v-if 和 v-else指令順序顛倒),也能獲取到binding.value的值灯荧。這就讓我對指令很感興趣礁击,想知道vue內(nèi)部又是怎么去實(shí)現(xiàn)指令的。

入口文件

指令在官方文檔中屬于全局API漏麦,所以從src\core\global-api\index.js中查找指令客税。

.....
  initUse(Vue)
  initMixin(Vue)
  initExtend(Vue)
  initAssetRegisters(Vue) //初始化指令
......

于是我查看了文件src\core\global-api\assets.js,發(fā)現(xiàn)了這段代碼:

ASSET_TYPES.forEach(type => {
    Vue[type] = function (
      id: string,
      definition: Function | Object
    ): Function | Object | void {
      if (!definition) {
        return this.options[type + 's'][id]
      } else {
       //省略其它代碼
        if (type === 'directive' && typeof definition === 'function') {
          definition = { bind: definition, update: definition }
        }
        this.options[type + 's'][id] = definition
        return definition
      }
    }
  })

該函數(shù)的參數(shù)有兩個撕贞,其中id就是指令的名字更耻,definition就是我們平時自定義指令傳的對象或者函數(shù)。這段代碼的意思也就很清楚了:如果是指令捏膨,且第二個參數(shù)是函數(shù)秧均,則會新定義一個對象,并把definition賦值給bind和update屬性号涯。最后目胡,會把指令的定義賦給Vue.options.directives[指令名]。感興趣的可以自己再vue官網(wǎng)打印一下链快。

上面是全局API的實(shí)現(xiàn)方式誉己。但是其實(shí)指令是加在模板的標(biāo)簽上的,所以模板編譯部分也做了處理域蜗。

模板編譯

模板編譯的入口文件src\compiler\parser\index.js巨双,你會很容易看到有個函數(shù)parseHTML(template, {}),代碼如下:

parseHTML(template, {
     //......省略代碼
      if (inVPre) {
        processRawAttrs(element)
      } else if (!element.processed) {
        // structural directives
        processFor(element)  //解析v-for
        processIf(element)     //解析v-if
        processOnce(element)  //解析v-once
      }
     //......省略
    if (!unary) {
        currentParent = element
        stack.push(element)
      } else {
       //自定義指令走這里 
        closeElement(element)
      }
      //......省略
})

一步一步向下找霉祸,會找到函數(shù)processElement()筑累,進(jìn)而發(fā)現(xiàn)除了上述代碼中直接解析的指令,剩下的指令和屬性統(tǒng)一都交給了processAttrs()函數(shù)處理丝蹭,比如v-bind慢宗、v-on以及普通屬性等。截取部分該函數(shù)的代碼:

      //省略部分代碼
      else { // normal directives
        name = name.replace(dirRE, '')
        // parse arg
        const argMatch = name.match(argRE)
        let arg = argMatch && argMatch[1]
        isDynamic = false
        if (arg) {
          name = name.slice(0, -(arg.length + 1))
          if (dynamicArgRE.test(arg)) {
            arg = arg.slice(1, -1)
            isDynamic = true
          }
        }
        addDirective(el, name, rawName, value, arg, isDynamic, modifiers, list[i])

在該函數(shù)中處理了要傳給addDirective的參數(shù)對應(yīng)的值奔穿,最終在addDirective函數(shù)中把自定義指令添加到el上镜沽。然后我們在文件src\compiler\codegen\index.js中會找到constructor里的代碼:

constructor (options: CompilerOptions) {
    this.options = options
    this.warn = options.warn || baseWarn
    this.transforms = pluckModuleFunction(options.modules, 'transformCode')
    this.dataGenFns = pluckModuleFunction(options.modules, 'genData')
    this.directives = extend(extend({}, baseDirectives), options.directives)
    //省略代碼
  }

可以繼續(xù)在該文件中找到genDirectives函數(shù),可以看到添加到directives屬性中的對象的生成過程如下:

function genDirectives (el: ASTElement, state: CodegenState): string | void {
  const dirs = el.directives
    //省略代碼
    if (needRuntime) {
      hasRuntime = true
      res += `{name:"${dir.name}",rawName:"${dir.rawName}"${
        dir.value ? `,value:(${dir.value}),expression:${JSON.stringify(dir.value)}` : ''
      }${
        dir.arg ? `,arg:${dir.isDynamicArg ? dir.arg : `"${dir.arg}"`}` : ''
      }${
        dir.modifiers ? `,modifiers:${JSON.stringify(dir.modifiers)}` : ''
      }},`
    }
  }

對于添加到directives上的數(shù)據(jù)贱田,則是在patch中通過添加到cbs中的鉤子函數(shù)處理的淘邻。具體過程見src/core/vdom/modules/directives.js文件中。

export default {
  create: updateDirectives,
  update: updateDirectives,
  destroy: function unbindDirectives (vnode: VNodeWithData) {
    updateDirectives(vnode, emptyNode)
  }
}

可以看到湘换,這三個鉤子函數(shù)宾舅,最終調(diào)用的都是updateDirectives方法统阿。

function updateDirectives (oldVnode: VNodeWithData, vnode: VNodeWithData) {
  if (oldVnode.data.directives || vnode.data.directives) {
    _update(oldVnode, vnode)
  }
}

如果updateDirectives()函數(shù)接受到的兩個參數(shù)data中有directives屬性,則調(diào)用_update方法來進(jìn)行處理筹我。_update方法的主要操作扶平,其實(shí)就是調(diào)用指令的各種鉤子函數(shù)。

function _update (oldVnode, vnode) {
  // 第一次實(shí)例化組件時蔬蕊,oldVnode是emptyNode
  const isCreate = oldVnode === emptyNode
  // 銷毀組件時结澄,vnode是emptyNode
  const isDestroy = vnode === emptyNode
  //normalizeDirectives函數(shù)是從組件的vm.$options.directives中獲取指令的定義
  const oldDirs = normalizeDirectives(oldVnode.data.directives, oldVnode.context)
  const newDirs = normalizeDirectives(vnode.data.directives, vnode.context)

  const dirsWithInsert = []
  const dirsWithPostpatch = []

  let key, oldDir, dir
  for (key in newDirs) {
    //循環(huán)新vnode上綁定的指令
    oldDir = oldDirs[key]
    dir = newDirs[key]
    if (!oldDir) {
      // new directive, bind   => 如果第一次綁定,則直接調(diào)用bind鉤子函數(shù)
      callHook(dir, 'bind', vnode, oldVnode)
      if (dir.def && dir.def.inserted) {
        //若同時還添加了inserted鉤子岸夯,則會先把它添加到dirsWithInsert數(shù)組中麻献。
        dirsWithInsert.push(dir)
      }
    } else {
      // existing directive, update   =>  如果不是第一次綁定,則調(diào)用update鉤子函數(shù)
      dir.oldValue = oldDir.value
      dir.oldArg = oldDir.arg
      callHook(dir, 'update', vnode, oldVnode)
      if (dir.def && dir.def.componentUpdated) {
         //若同時定義了componentUpdated鉤子猜扮,則會先把它添加到dirsWithPostpatch數(shù)組中勉吻。
        dirsWithPostpatch.push(dir)
      }
    }
  }

  if (dirsWithInsert.length) {
    const callInsert = () => {
      for (let i = 0; i < dirsWithInsert.length; i++) {
        callHook(dirsWithInsert[i], 'inserted', vnode, oldVnode)
      }
    }
    if (isCreate) {
       //如果是vnode是第一次創(chuàng)建,
      //則會把dirsWithInsert數(shù)組中的回調(diào)追加到vnode.data.hook.insert中執(zhí)行
      mergeVNodeHook(vnode, 'insert', callInsert)
    } else {
      callInsert()
    }
  }

  if (dirsWithPostpatch.length) {
    mergeVNodeHook(vnode, 'postpatch', () => {
      for (let i = 0; i < dirsWithPostpatch.length; i++) {
        callHook(dirsWithPostpatch[i], 'componentUpdated', vnode, oldVnode)
      }
    })
  }

  if (!isCreate) {
    for (key in oldDirs) {
      if (!newDirs[key]) {
        // no longer present, unbind  
        // 如果不是第一次創(chuàng)建旅赢,就調(diào)用舊vnode中新vnode不存在的指令的unbind鉤子函數(shù)
        callHook(oldDirs[key], 'unbind', oldVnode, oldVnode, isDestroy)
      }
    }
  }
}

指令使用

Vue.directive('my-directive', {
  bind: function () {},
  inserted: function () {},
  update: function () {},
  componentUpdated: function () {},
  unbind: function () {}
})

上面的_update 函數(shù)對應(yīng)著這幾個鉤子函數(shù)齿桃,其中:
bind:只調(diào)用一次,指令第一次綁定到元素時調(diào)用煮盼。在這里可以進(jìn)行一次性的初始化設(shè)置短纵。
inserted:被綁定元素插入父節(jié)點(diǎn)時調(diào)用 (僅保證父節(jié)點(diǎn)存在,但不一定已被插入文檔中)僵控。
update:所在組件的 VNode 更新時調(diào)用香到,但是可能發(fā)生在其子 VNode 更新之前。指令的值可能發(fā)生了改變报破,也可能沒有养渴。但是你可以通過比較更新前后的值來忽略不必要的模板更新
componentUpdated:指令所在組件的 VNode 及其子 VNode 全部更新后調(diào)用。
unbind:只調(diào)用一次泛烙,指令與元素解綁時調(diào)用。

指令鉤子函數(shù)會被傳入以下參數(shù):

  • el:指令所綁定的元素翘紊,可以用來直接操作 DOM 蔽氨。
  • binding:一個對象,包含以下屬性:
  • vnode:Vue 編譯生成的虛擬節(jié)點(diǎn)帆疟。移步 VNode API 來了解更多詳情鹉究。
  • oldVnode:上一個虛擬節(jié)點(diǎn),僅在 updatecomponentUpdated 鉤子中可用踪宠。

看完源代碼自赔,在回過頭來看官網(wǎng)注釋,會發(fā)現(xiàn)自己對官網(wǎng)的說明印象更加深刻柳琢,也更加深自己的理解绍妨。

答案

關(guān)于開頭提到的問題的答案:其實(shí)還是和v-if有關(guān)润脸,v-if在編譯過程中會被轉(zhuǎn)化成三元表達(dá)式,條件不滿足的時候他去,是不會渲染此節(jié)點(diǎn)的毙驯,自然值也沒拿到了。

謝謝閱讀灾测,有問題可以互相交流哦

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末爆价,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子媳搪,更是在濱河造成了極大的恐慌铭段,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,817評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件秦爆,死亡現(xiàn)場離奇詭異序愚,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)鲜结,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,329評論 3 385
  • 文/潘曉璐 我一進(jìn)店門展运,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人精刷,你說我怎么就攤上這事拗胜。” “怎么了怒允?”我有些...
    開封第一講書人閱讀 157,354評論 0 348
  • 文/不壞的土叔 我叫張陵埂软,是天一觀的道長。 經(jīng)常有香客問我纫事,道長勘畔,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,498評論 1 284
  • 正文 為了忘掉前任丽惶,我火速辦了婚禮炫七,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘钾唬。我一直安慰自己万哪,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,600評論 6 386
  • 文/花漫 我一把揭開白布抡秆。 她就那樣靜靜地躺著奕巍,像睡著了一般。 火紅的嫁衣襯著肌膚如雪儒士。 梳的紋絲不亂的頭發(fā)上的止,一...
    開封第一講書人閱讀 49,829評論 1 290
  • 那天,我揣著相機(jī)與錄音着撩,去河邊找鬼诅福。 笑死匾委,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的权谁。 我是一名探鬼主播剩檀,決...
    沈念sama閱讀 38,979評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼旺芽!你這毒婦竟也來了沪猴?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,722評論 0 266
  • 序言:老撾萬榮一對情侶失蹤采章,失蹤者是張志新(化名)和其女友劉穎运嗜,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體悯舟,經(jīng)...
    沈念sama閱讀 44,189評論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡担租,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,519評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了抵怎。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片奋救。...
    茶點(diǎn)故事閱讀 38,654評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖反惕,靈堂內(nèi)的尸體忽然破棺而出尝艘,到底是詐尸還是另有隱情,我是刑警寧澤姿染,帶...
    沈念sama閱讀 34,329評論 4 330
  • 正文 年R本政府宣布背亥,位于F島的核電站,受9級特大地震影響悬赏,放射性物質(zhì)發(fā)生泄漏狡汉。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,940評論 3 313
  • 文/蒙蒙 一闽颇、第九天 我趴在偏房一處隱蔽的房頂上張望盾戴。 院中可真熱鬧,春花似錦兵多、人聲如沸尖啡。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,762評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至沿癞,卻和暖如春援雇,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背椎扬。 一陣腳步聲響...
    開封第一講書人閱讀 31,993評論 1 266
  • 我被黑心中介騙來泰國打工惫搏, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留具温,地道東北人。 一個月前我還...
    沈念sama閱讀 46,382評論 2 360
  • 正文 我出身青樓筐赔,卻偏偏與公主長得像铣猩,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子茴丰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,543評論 2 349

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

  • vue概述 在官方文檔中达皿,有一句話對Vue的定位說的很明確:Vue.js 的核心是一個允許采用簡潔的模板語法來聲明...
    li4065閱讀 7,193評論 0 25
  • 這篇筆記主要包含 Vue 2 不同于 Vue 1 或者特有的內(nèi)容,還有我對于 Vue 1.0 印象不深的內(nèi)容贿肩。關(guān)于...
    云之外閱讀 5,046評論 0 29
  • 在第五章中我們已經(jīng)介紹了需要Vue內(nèi)置的指令峦椰,比如v-if、v-show等汰规,這些豐富的內(nèi)置指令能滿足我們的...
    六個周閱讀 1,686評論 2 9
  • ## 框架和庫的區(qū)別?> 框架(framework):一套完整的軟件設(shè)計(jì)架構(gòu)和**解決方案**汤功。> > 庫(lib...
    Rui_bdad閱讀 2,895評論 1 4
  • 一:什么是閉包?閉包的用處溜哮? (1)閉包就是能夠讀取其他函數(shù)內(nèi)部變量的函數(shù)滔金。在本質(zhì)上,閉包就 是將函數(shù)內(nèi)部和函數(shù)外...
    xuguibin閱讀 9,543評論 1 52