使用Provide和Inject設(shè)計Vue3插件

使用provide和inject的Vue依賴項注入非常適合構(gòu)建Vue3插件或避免prop多層傳遞父叙。

盡管不經(jīng)常使用它躏率,但是您可以僅使用兩個內(nèi)置方法來實現(xiàn)依賴項注入:provide和inject软棺。

查看Composition API文檔县貌,在Vue 3.0中琳状,使用Provide和Inject進行依賴項注入將更為常見撕攒。這主要是因為由于Composition API對this引用的更改蒸苇,插件將不得不切換為使用此模式磷蛹。

在本文中,我們將研究在Vue3中使用Provide和Inject以及如何將其用于構(gòu)建VueJS插件溪烤。

為什么Vue3插件的工作方式有所不同味咳?

在Vue2中庇勃,大多數(shù)插件會將屬性注入this。例如槽驶,通過訪問Vue路由器this.$router责嚷。

但是,該setup()方法不再包含對的相同引用this掂铐。進行此更改的主要原因是增加了對Typescript的支持罕拂。

Sooo,“我們現(xiàn)在要如何訪問我們的插件全陨?”

幸運的是爆班,我們可以使用provideinject幫助在我們的Vue應(yīng)用程序中注入依賴項。

Provide / inject用于依賴項注入–使我們能夠在Vue應(yīng)用程序的根目錄中提供一個插件辱姨,然后將其注入子組件中柿菩。

在Composition API中,只能在setup()方法期間調(diào)用這兩種方法雨涛。

什么是provide / inject枢舶?

好的-我們知道我們必須使用provide和inject,但是那怎么工作呢替久?

基本上凉泄,我們只需要某種鍵來識別我們的依賴關(guān)系–出于我們的目的,我們將使用Javascript Symbol蚯根。

然后后众,我們的provide方法會將我們的Symbol與某個值相關(guān)聯(lián),而我們的inject方法將使用相同的Symbol檢索該值稼锅。

看一個例子更有意義吼具。

import { provide, inject } from 'vue'

const LoggedInSymbol = Symbol()

const ParentComponent = {
  setup() {
    provide(LoggedInSymbol, true)
  }
}

const DeepDescendent = {
  setup() {
    // second optional param is a default value if it doesn't exist
    const isLoggedIn = inject(LoggedInSymbol, false)
    return {
      isLoggedIn
    }
  }
}

通過這種模式,實際上Vue3可以完成一些很酷的技巧矩距。

我們可以在我們的應(yīng)用程序中全局提供依賴項

如果我們想在全球范圍內(nèi)提供某些東西拗盒,則可以app.provide在聲明Vue應(yīng)用程序?qū)嵗娜魏蔚胤绞褂谩H缓笞墩覀兛梢韵褚郧耙粯幼⑷搿?/p>

main.js

import { createApp } from 'vue'
import App from './App.vue'

const app = createApp(App)

const ThemeSymbol = Symbol()
app.provide(ThemeSymbol, 'dark')

app.mount('#app')

我們可以使用ref提供反應(yīng)數(shù)據(jù)

如果我們希望將反應(yīng)性數(shù)據(jù)傳遞給子組件陡蝇,這也非常方便。我們要做的就是使用傳遞給我們的提供方法一個反應(yīng)性ref()哮肚。

// in provider (parent)
const LoggedInSymbol = Symbol()
const loggedIn = ref('true')
provide(LoggedInSymbol, loggedIn)

// in consumer (descendant)
const theme = inject(LoggedInSymbol, ref('false'))

我們?nèi)绾问褂胮rovide / inject登夫?

設(shè)計插件實際上與我們剛才看到的簡單的provide / inject示例非常相似。

但是允趟,我們不想使用單個值恼策,而是要使用合成函數(shù)。這是Vue3的巨大優(yōu)勢之一-能夠根據(jù)功能組織和提取代碼。

由于我們的代碼無論如何都應(yīng)該用有組織的組合函數(shù)編寫涣楷,因此我們只需要創(chuàng)建這些provide / inject方法以及BAM-我們就有了一個插件分唾。

讓我們快速看一下Vue3 Composition API文檔提供的假設(shè)插件。

Plugin.js

const StoreSymbol = Symbol()

export function provideStore(store) {
  provide(StoreSymbol, store)
}

export function useStore() {
  const store = inject(StoreSymbol)
  if (!store) {
    // throw error, no store provided
  }
  return store
}

然后狮斗,我們的實際組件將像這樣使用它绽乔。

// provide store at component root
//
const App = {
  setup() {
    provideStore(store)
  }
}

const Child = {
  setup() {
    const store = useStore()
    // use the store
  }
}

如您所見,在某些根組件中碳褒,我們提供了插件折砸,并向其傳遞了composition函數(shù)。然后沙峻,無論我們想在哪里使用它睦授,都必須將其注入到我們的組件中。

組件永遠不必真正進行provide / inject調(diào)用摔寨,而只需調(diào)用插件公開的provideStore / useStore方法睹逃。

所以我仍然可以使用舊的插件嗎?

簡短的答案祷肯? 是的。

長答案疗隶? 取決于你的意思佑笋。

由于Composition API純粹是可加性的,因此您可以繼續(xù)使用Options API斑鼻,并具有與this以前相同的引用蒋纬,并且所有舊插件都將工作相同。

但是赶促,繼續(xù)前進派撕,絕對值得過渡到Vue3并利用其所有功能蚁孔。

本質(zhì)上,只要您想堅持使用Vue2 Options API碾阁,您的插件就可以正常工作。但是些楣,無論如何脂凶,大多數(shù)維護良好的插件/庫都應(yīng)該添加對Vue3的支持。

結(jié)論

正確使用Provide / Inject絕對是 Vue開發(fā)中更高級的主題愁茁。

盡管大多數(shù)典型的應(yīng)用程序不會使用這些概念蚕钦,但是如果您對開發(fā)插件很認真,則Vue3 Composition API中的更改意味著您必須 使用provide / inject鹅很。

如果您想了解更多信息嘶居,請務(wù)必查看Composition API文檔

參考

Designing Vue3 Plugins Using Provide and Inject

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末促煮,一起剝皮案震驚了整個濱河市邮屁,隨后出現(xiàn)的幾起案子整袁,更是在濱河造成了極大的恐慌,老刑警劉巖樱报,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件葬项,死亡現(xiàn)場離奇詭異,居然都是意外死亡迹蛤,警方通過查閱死者的電腦和手機民珍,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來盗飒,“玉大人嚷量,你說我怎么就攤上這事∧嫒ぃ” “怎么了蝶溶?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長宣渗。 經(jīng)常有香客問我抖所,道長,這世上最難降的妖魔是什么痕囱? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任田轧,我火速辦了婚禮,結(jié)果婚禮上鞍恢,老公的妹妹穿的比我還像新娘傻粘。我一直安慰自己,他們只是感情好帮掉,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布弦悉。 她就那樣靜靜地躺著,像睡著了一般蟆炊。 火紅的嫁衣襯著肌膚如雪稽莉。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天涩搓,我揣著相機與錄音肩祥,去河邊找鬼。 笑死缩膝,一個胖子當著我的面吹牛混狠,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播疾层,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼将饺,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起予弧,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤刮吧,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后掖蛤,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體杀捻,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年蚓庭,在試婚紗的時候發(fā)現(xiàn)自己被綠了致讥。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡器赞,死狀恐怖垢袱,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情港柜,我是刑警寧澤请契,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站夏醉,受9級特大地震影響爽锥,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜畔柔,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一救恨、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧释树,春花似錦、人聲如沸擎淤。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽嘴拢。三九已至桩盲,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間席吴,已是汗流浹背赌结。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留孝冒,地道東北人柬姚。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓,卻偏偏與公主長得像庄涡,于是被迫代替她去往敵國和親量承。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355

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