一、先搞清楚:Provide / Inject 是什么机制
provide 和 inject 是 Vue 组件之间 祖孙通信的一种机制。
它允许上层组件提供数据 ,而下层组件直接获取,不需要层层 props 传递。
简单关系图:
scss
App.vue (provide)
└── ChildA.vue
└── ChildB.vue (inject)
App 通过 provide 提供,ChildB 直接拿到。
在 Vue 3 中:
javascript
// 父组件
import { provide } from 'vue'
setup() {
provide('theme', 'dark')
}
javascript
// 孙组件
import { inject } from 'vue'
setup() {
const theme = inject('theme')
console.log(theme) // 'dark'
}
这本质上是 Vue 在「组件初始化时」建立的一种依赖注入映射关系(依赖树) 。
二、误区:为什么"异步"时会失效?
很多人说"在异步组件里 inject 不到值",其实问题出在「加载时机」上。
❌ 错误理解:
以为 inject 是"运行时全局取值",随时都能拿到。
✅ 实际原理:
inject() 的查找是在 组件创建阶段(setup 执行时) 完成的。
也就是说:
只有当父组件已经被挂载并执行了 provide() 后,子组件在 setup 时才能拿到。
如果异步加载的子组件在 provide 之前被初始化,或者在懒加载时「上下文丢失」,那它当然拿不到值。
三、可复现测试案例(你可以直接复制运行)
我们写一个最常见的「异步子组件注入」示例。
你可以用 Vite 新建项目,然后建这三个文件:
🟢App.vue(父组件)
js
<template>
<div>
<h2>父组件</h2>
<p>当前主题:{{ theme }}</p>
<button @click="loadAsync">加载异步子组件</button>
<!-- 当点击后才加载 -->
<component :is="childComp" />
</div>
</template>
<script setup>
import { ref, provide, defineAsyncComponent } from 'vue'
// 1️⃣ 提供一个响应式值
const theme = ref('🌙 暗黑模式')
provide('theme', theme)
// 2️⃣ 模拟异步组件加载
const childComp = ref(null)
function loadAsync() {
// 模拟异步加载组件(1 秒后返回)
const AsyncChild = defineAsyncComponent(() =>
new Promise(resolve => {
setTimeout(() => resolve(import('./Child.vue')), 1000)
})
)
childComp.value = AsyncChild
}
</script>
🟡Child.vue(中间组件)
js
<template>
<div class="child">
<h3>中间组件</h3>
<GrandChild />
</div>
</template>
<script setup>
import GrandChild from './GrandChild.vue'
</script>
<style scoped>
.child {
border: 1px solid #aaa;
margin: 8px;
padding: 8px;
}
</style>
🔵GrandChild.vue(孙组件)
js
<template>
<div class="grand">
<h4>孙组件</h4>
<p>从 provide 注入的主题:{{ theme }}</p>
</div>
</template>
<script setup>
import { inject } from 'vue'
// 1️⃣ 注入父级 provide 的数据
const theme = inject('theme', '默认主题')
// 2️⃣ 打印验证
console.log('孙组件注入的 theme 值是:', theme)
</script>
<style scoped>
.grand {
border: 1px dashed #666;
margin-top: 8px;
padding: 6px;
}
</style>
✅ 运行结果验证:
1️⃣ 页面初始只显示父组件。
2️⃣ 点击「加载异步子组件」。
3️⃣ 一秒后加载完成,控制台输出:
css
孙组件注入的 theme 值是:RefImpl {value: '🌙 暗黑模式'}
页面上显示:
从 provide 注入的主题:🌙 暗黑模式
👉 说明:即使是 异步组件,也能正确拿到 provide 的值。
四、那为什么有时真的"不起作用"?
有三种常见原因:
原因 | 说明 | 解决方案 |
---|---|---|
1️⃣ 在 setup 外使用 inject() | Vue 只能在组件初始化(setup 阶段)内建立依赖 | 一定要在 setup() 中调用 |
2️⃣ 异步组件创建时父组件上下文丢失 | 如果异步加载组件时没有挂在已有的上下文中(比如 createApp 动态 mount) | 保证异步组件是作为「现有组件树」的子节点被渲染 |
3️⃣ SSR 场景中 hydration 时机问题 | 如果在服务器端渲染中,provide 未在客户端同步恢复 | SSR 需保证 provide/inject 在同一上下文实例中执行 |
五、底层原理小科普(可选理解)
Vue 内部维护了一棵「依赖注入树」,
每个组件实例在初始化时会记录自己的 provides 对象:
ini
instance.provides = Object.create(parent.provides)
所以当 inject('theme') 时,它会:
-
向上查找父组件的 provides;
-
找到对应 key;
-
返回对应的值(引用)。
这就是为什么:
- 父子必须在「同一组件树上下文」中;
- 异步不会破坏注入关系(除非脱离这棵树)。
✅ 总结重点
概念 | 说明 |
---|---|
Provide / Inject | 用于祖孙通信的依赖注入机制 |
异步组件能否注入? | ✅ 能,只要仍在同一组件树中 |
什么时候会失效? | 父未先 provide、或异步 mount 独立实例 |
验证方法 | 使用 defineAsyncComponent 懒加载组件 |
推荐做法 | 始终在 setup 内使用 provide/inject |