如何用Provide和Inject做Vue3插件

WBOY

发布时间：2023-05-11 12:37:13

1103人浏览过

来源于亿速云

转载

为什么 Vue3 插件的工作方式与以往不同

在 Vue2 中，大多数插件将属性注入到 this 上。例如可以通过 this.$router 访问 Vue 路由器。

但是，setup() 方法不再包含对 this 的相同引用。进行这种更改的主要原因是增加了对 Typescript 的支持。

那么在 Vue3 中该如何访问我们的插件呢?可以用 provide 和 inject 来帮助我们在 Vue 程序中注入依赖项。Provide/inject 用于依赖项注入，可以使我们能在 Vue 程序的根目录中提供插件，并且然后将其注入子组件中。

在 Composition API 中，只能在 setup() 方法期间调用这两种方法。

什么是 provide 和 inject

我们需要某种键来识别依赖关系， Javascript 的 Symbol 可以复合这种要求。

然后 provide 方法会将我们的 Symbol 与某个值相关联，而 inject 方法会用相同的 Symbol 检索这个值。

下面是一个例子：

import { provide, inject } from 'vue'  const LoggedInSymbol = Symbol()  const ParentComponent = {   setup() {     provide(LoggedInSymbol, true)   } }  const DeepDescendent = {   setup() {     // 第二个可选参数是默认值（如果不存在）     const isLoggedIn = inject(LoggedInSymbol, false)     return {       isLoggedIn     }   } }

Vue3 通过这种模式可以实现一些很实用的技巧。

可以在程序中全局提供依赖项

如果我们想在全局作用域中提供一些东西，可以在声明我们的 VUE 实例的时候下用 app.provide。然后可以用相同的方式进行注入。

main.jsimport { createApp } from 'vue' import App from './App.vue'   const app = createApp(App)  const ThemeSymbol = Symbol() app.provide(ThemeSymbol, 'dark')   app.mount('#app')

可以用 ref 提供响应式数据

如果我们希望将响应式数据传递给子组件，这也非常方便。只需要用 ref() 传递我们方法的一个响应式的属性。

// 生产者r (父组件) const LoggedInSymbol = Symbol() const loggedIn = ref('true') provide(LoggedInSymbol, loggedIn)  // 消费者 (子组件) const theme = inject(LoggedInSymbol, ref('false'))

怎样在插件中使用 provide 和 inject

实际上设计插件与我们刚才看到的简单例子非常相似。

但是我们不想使用单个值，而是要使用组合函数。这是 Vue3 的一个巨大优势 —— 能够根据函数组织和提取代码。

稿定AI设计

AI自动去水印、背景消除、批量抠人像工具

下载

由于我们的代码无论如何都应该用有组织的组合函数编写，所以只需要创建这些 provide 和 inject 方法就能够写出一个插件。

先简单的看一下 Vue3 Composition API 文档中提供的插件例子。

Plugin.jsconst 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 }

在实际的组件中会这样使用：

// 在组件根目录提供 store // const App = {   setup() {     provideStore(store)   } }  const Child = {   setup() {     const store = useStore()     // use the store   } }

根据上述代码，在某些根组件中，我们提供了插件，并向其传递了组件函数。然后无论想在哪里使用都必须将其注入到我们的组件中。

组件永远不必真正进行 provide/inject 调用，而只需调用插件公开的 provideStore/useStore 方法即可。